lsst.afw  21.0.0-25-g1d57be3cd+f385fa6f38
Public Types | Public Member Functions | Static Public Member Functions | List of all members
lsst::afw::table::QuadrupoleKey Class Referenceabstract

A FunctorKey used to get or set a geom::ellipses::Quadrupole from a tuple of constituent Keys. More...

#include <aggregates.h>

Inheritance diagram for lsst::afw::table::QuadrupoleKey:
lsst::afw::table::FunctorKey< lsst::afw::geom::ellipses::Quadrupole > lsst::afw::table::OutputFunctorKey< T > lsst::afw::table::InputFunctorKey< T >

Public Types

using Value = lsst::afw::geom::ellipses::Quadrupole
 The data type for get and set. More...
 

Public Member Functions

 QuadrupoleKey () noexcept
 Default constructor; instance will not be usable unless subsequently assigned to. More...
 
 QuadrupoleKey (Key< double > const &ixx, Key< double > const &iyy, Key< double > const &ixy) noexcept
 Construct from individual Keys. More...
 
 QuadrupoleKey (SubSchema const &s)
 Construct from a subschema with appropriate subfields. More...
 
 QuadrupoleKey (QuadrupoleKey const &) noexcept=default
 
 QuadrupoleKey (QuadrupoleKey &&) noexcept=default
 
QuadrupoleKeyoperator= (QuadrupoleKey const &) noexcept=default
 
QuadrupoleKeyoperator= (QuadrupoleKey &&) noexcept=default
 
 ~QuadrupoleKey () noexcept override=default
 
geom::ellipses::Quadrupole get (BaseRecord const &record) const override
 Get a Quadrupole from the given record. More...
 
void set (BaseRecord &record, geom::ellipses::Quadrupole const &value) const override
 Set a Quadrupole in the given record. More...
 
bool operator== (QuadrupoleKey const &other) const noexcept
 Compare the FunctorKey for equality with another, using the underlying Ixx, Iyy, Ixy Keys. More...
 
bool operator!= (QuadrupoleKey const &other) const noexcept
 
std::size_t hash_value () const noexcept
 Return a hash of this object. More...
 
bool isValid () const noexcept
 Return True if all the constituent Keys are valid. More...
 
Key< double > getIxx () const noexcept
 Return a constituent Key. More...
 
Key< double > getIyy () const noexcept
 
Key< double > getIxy () const noexcept
 
virtual void set (BaseRecord &record, T const &value) const =0
 

Static Public Member Functions

static QuadrupoleKey addFields (Schema &schema, std::string const &name, std::string const &doc, CoordinateType coordType=CoordinateType::PIXEL)
 Add a set of quadrupole subfields to a schema and return a QuadrupoleKey that points to them. More...
 

Detailed Description

A FunctorKey used to get or set a geom::ellipses::Quadrupole from a tuple of constituent Keys.

Definition at line 282 of file aggregates.h.

Member Typedef Documentation

◆ Value

The data type for get and set.

Definition at line 77 of file FunctorKey.h.

Constructor & Destructor Documentation

◆ QuadrupoleKey() [1/5]

lsst::afw::table::QuadrupoleKey::QuadrupoleKey ( )
inlinenoexcept

Default constructor; instance will not be usable unless subsequently assigned to.

Definition at line 299 of file aggregates.h.

◆ QuadrupoleKey() [2/5]

lsst::afw::table::QuadrupoleKey::QuadrupoleKey ( Key< double > const &  ixx,
Key< double > const &  iyy,
Key< double > const &  ixy 
)
inlinenoexcept

Construct from individual Keys.

Definition at line 302 of file aggregates.h.

◆ QuadrupoleKey() [3/5]

lsst::afw::table::QuadrupoleKey::QuadrupoleKey ( SubSchema const &  s)
inline

Construct from a subschema with appropriate subfields.

If the schema has "a_xx", "a_yy" and "a_xy" fields this constructor enables you to construct a QuadrupoleKey via:

QuadrupoleKey k(schema["a"], coordType);

Definition at line 313 of file aggregates.h.

◆ QuadrupoleKey() [4/5]

lsst::afw::table::QuadrupoleKey::QuadrupoleKey ( QuadrupoleKey const &  )
defaultnoexcept

◆ QuadrupoleKey() [5/5]

lsst::afw::table::QuadrupoleKey::QuadrupoleKey ( QuadrupoleKey &&  )
defaultnoexcept

◆ ~QuadrupoleKey()

lsst::afw::table::QuadrupoleKey::~QuadrupoleKey ( )
overridedefaultnoexcept

Member Function Documentation

◆ addFields()

QuadrupoleKey lsst::afw::table::QuadrupoleKey::addFields ( Schema schema,
std::string const &  name,
std::string const &  doc,
CoordinateType  coordType = CoordinateType::PIXEL 
)
static

Add a set of quadrupole subfields to a schema and return a QuadrupoleKey that points to them.

Parameters
[in,out]schemaSchema to add fields to.
[in]nameName prefix for all fields; ("_xx", "_yy", "_xy") will be appended to this to form the full field names. In celestial coordinates, we use "x" as a synonym for "RA" and "y" for "dec".
[in]docString used as the documentation for the fields.
[in]coordTypeType of coordinates in use (PIXEL or CELESTIAL).

Definition at line 100 of file aggregates.cc.

◆ get()

geom::ellipses::Quadrupole lsst::afw::table::QuadrupoleKey::get ( BaseRecord const &  record) const
overridevirtual

Get a Quadrupole from the given record.

Implements lsst::afw::table::OutputFunctorKey< T >.

Definition at line 110 of file aggregates.cc.

◆ getIxx()

Key<double> lsst::afw::table::QuadrupoleKey::getIxx ( ) const
inlinenoexcept

Return a constituent Key.

Definition at line 346 of file aggregates.h.

◆ getIxy()

Key<double> lsst::afw::table::QuadrupoleKey::getIxy ( ) const
inlinenoexcept

Definition at line 348 of file aggregates.h.

◆ getIyy()

Key<double> lsst::afw::table::QuadrupoleKey::getIyy ( ) const
inlinenoexcept

Definition at line 347 of file aggregates.h.

◆ hash_value()

std::size_t lsst::afw::table::QuadrupoleKey::hash_value ( ) const
inlinenoexcept

Return a hash of this object.

Definition at line 336 of file aggregates.h.

◆ isValid()

bool lsst::afw::table::QuadrupoleKey::isValid ( ) const
inlinenoexcept

Return True if all the constituent Keys are valid.

Definition at line 342 of file aggregates.h.

◆ operator!=()

bool lsst::afw::table::QuadrupoleKey::operator!= ( QuadrupoleKey const &  other) const
inlinenoexcept

Definition at line 332 of file aggregates.h.

◆ operator=() [1/2]

QuadrupoleKey& lsst::afw::table::QuadrupoleKey::operator= ( QuadrupoleKey &&  )
defaultnoexcept

◆ operator=() [2/2]

QuadrupoleKey& lsst::afw::table::QuadrupoleKey::operator= ( QuadrupoleKey const &  )
defaultnoexcept

◆ operator==()

bool lsst::afw::table::QuadrupoleKey::operator== ( QuadrupoleKey const &  other) const
inlinenoexcept

Compare the FunctorKey for equality with another, using the underlying Ixx, Iyy, Ixy Keys.

Definition at line 329 of file aggregates.h.

◆ set() [1/2]

void lsst::afw::table::QuadrupoleKey::set ( BaseRecord record,
geom::ellipses::Quadrupole const &  value 
) const
override

Set a Quadrupole in the given record.

Definition at line 114 of file aggregates.cc.

◆ set() [2/2]

template<typename T >
virtual void lsst::afw::table::InputFunctorKey< T >::set ( BaseRecord record,
T const &  value 
) const
pure virtualinherited

The documentation for this class was generated from the following files: