lsst.afw  21.0.0-31-g2bc2b1e0a+8935f19055
Public Types | Public Member Functions | Static Public Member Functions | List of all members
lsst::afw::table::EllipseKey Class Referenceabstract

A FunctorKey used to get or set a geom::ellipses::Ellipse from an (xx,yy,xy,x,y) tuple of Keys. More...

#include <aggregates.h>

Inheritance diagram for lsst::afw::table::EllipseKey:
lsst::afw::table::FunctorKey< lsst::afw::geom::ellipses::Ellipse > lsst::afw::table::OutputFunctorKey< T > lsst::afw::table::InputFunctorKey< T >

Public Types

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

Public Member Functions

 EllipseKey () noexcept
 Default constructor; instance will not be usable unless subsequently assigned to. More...
 
 EllipseKey (QuadrupoleKey const &qKey, PointKey< double > const &pKey) noexcept
 Construct from individual Keys. More...
 
 EllipseKey (SubSchema const &s)
 Construct from a subschema, assuming (xx, yy, xy, x, y) subfields. More...
 
 EllipseKey (EllipseKey const &) noexcept=default
 
 EllipseKey (EllipseKey &&) noexcept=default
 
EllipseKeyoperator= (EllipseKey const &) noexcept=default
 
EllipseKeyoperator= (EllipseKey &&) noexcept=default
 
 ~EllipseKey () noexcept override=default
 
geom::ellipses::Ellipse get (BaseRecord const &record) const override
 Get an Ellipse from the given record. More...
 
void set (BaseRecord &record, geom::ellipses::Ellipse const &value) const override
 Set an Ellipse in the given record. More...
 
bool operator== (EllipseKey const &other) const noexcept
 Compare the FunctorKey for equality with another, using the underlying Ixx, Iyy, Ixy Keys. More...
 
bool operator!= (EllipseKey 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...
 
QuadrupoleKey getCore () const noexcept
 Return constituent FunctorKeys. More...
 
PointKey< double > getCenter () const noexcept
 
virtual void set (BaseRecord &record, T const &value) const =0
 

Static Public Member Functions

static EllipseKey addFields (Schema &schema, std::string const &name, std::string const &doc, std::string const &unit)
 Add a set of _xx, _yy, _xy, _x, _y fields to a Schema, and return an EllipseKey that points to them. More...
 

Detailed Description

A FunctorKey used to get or set a geom::ellipses::Ellipse from an (xx,yy,xy,x,y) tuple of Keys.

Definition at line 360 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

◆ EllipseKey() [1/5]

lsst::afw::table::EllipseKey::EllipseKey ( )
inlinenoexcept

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

Definition at line 376 of file aggregates.h.

◆ EllipseKey() [2/5]

lsst::afw::table::EllipseKey::EllipseKey ( QuadrupoleKey const &  qKey,
PointKey< double > const &  pKey 
)
inlinenoexcept

Construct from individual Keys.

Definition at line 379 of file aggregates.h.

◆ EllipseKey() [3/5]

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

Construct from a subschema, assuming (xx, yy, xy, x, y) subfields.

If a schema has "a_xx", "a_yy", "a_xy", "a_x", and "a_y" fields, this constructor allows you to construct an EllipseKey via:

EllipseKey k(schema["a"]);

Definition at line 389 of file aggregates.h.

◆ EllipseKey() [4/5]

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

◆ EllipseKey() [5/5]

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

◆ ~EllipseKey()

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

Member Function Documentation

◆ addFields()

EllipseKey lsst::afw::table::EllipseKey::addFields ( Schema schema,
std::string const &  name,
std::string const &  doc,
std::string const &  unit 
)
static

Add a set of _xx, _yy, _xy, _x, _y fields to a Schema, and return an EllipseKey that points to them.

Parameters
[in,out]schemaSchema to add fields to.
[in]nameName prefix for all fields; "_xx", "_yy", "_xy", "_x" ,"_y", will be appended to this to form the full field names.
[in]docString used as the documentation for the fields.
[in]unitString used as the unit for x and y fields; "<unit>^2" will be used for xx, yy, and xy fields.

Definition at line 122 of file aggregates.cc.

◆ get()

geom::ellipses::Ellipse lsst::afw::table::EllipseKey::get ( BaseRecord const &  record) const
overridevirtual

Get an Ellipse from the given record.

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

Definition at line 129 of file aggregates.cc.

◆ getCenter()

PointKey<double> lsst::afw::table::EllipseKey::getCenter ( ) const
inlinenoexcept

Definition at line 423 of file aggregates.h.

◆ getCore()

QuadrupoleKey lsst::afw::table::EllipseKey::getCore ( ) const
inlinenoexcept

Return constituent FunctorKeys.

Definition at line 422 of file aggregates.h.

◆ hash_value()

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

Return a hash of this object.

Definition at line 412 of file aggregates.h.

◆ isValid()

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

Return True if all the constituent Keys are valid.

Definition at line 418 of file aggregates.h.

◆ operator!=()

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

Definition at line 408 of file aggregates.h.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ operator==()

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

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

Definition at line 405 of file aggregates.h.

◆ set() [1/2]

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

Set an Ellipse in the given record.

Definition at line 133 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: