lsst.meas.base  22.0.1-24-g4fd6b65+3f3650e748
Public Types | Public Member Functions | Static Public Member Functions | List of all members
lsst::meas::base::ShapeResultKey Class Referenceabstract

A FunctorKey for ShapeResult. More...

#include <ShapeUtilities.h>

Inheritance diagram for lsst::meas::base::ShapeResultKey:
lsst::afw::table::FunctorKey< ShapeResult > lsst::afw::table::OutputFunctorKey< class > lsst::afw::table::InputFunctorKey< class >

Public Types

typedef T Value
 

Public Member Functions

 ShapeResultKey ()
 Default constructor; instance will not be usuable unless subsequently assigned to. More...
 
 ShapeResultKey (afw::table::QuadrupoleKey const &shape, afw::table::CovarianceMatrixKey< ErrElement, 3 > const &shapeErr)
 Construct from a pair of Keys. More...
 
 ShapeResultKey (afw::table::SubSchema const &s)
 Construct from a subschema, assuming _xx, _yy, etc. More...
 
virtual ShapeResult get (afw::table::BaseRecord const &record) const
 Get a ShapeResult from the given record. More...
 
virtual void set (afw::table::BaseRecord &record, ShapeResult const &value) const
 Set a ShapeResult in the given record. More...
 
bool operator== (ShapeResultKey const &other) const
 Compare the FunctorKey for equality with another, using the underlying Keys. More...
 
bool operator!= (ShapeResultKey const &other) const
 
bool isValid () const
 Return True if the shape key is valid. More...
 
afw::table::QuadrupoleKey getShape () const
 Return a FunctorKey to just the shape value. More...
 
afw::table::CovarianceMatrixKey< ErrElement, 3 > getShapeErr () const
 Return a FunctorKey to just the uncertainty matrix. More...
 
afw::table::Key< ShapeElementgetIxx () const
 Return a Key for the xx moment. More...
 
afw::table::Key< ShapeElementgetIyy () const
 Return a Key for the yy moment. More...
 
afw::table::Key< ShapeElementgetIxy () const
 Return a Key for the xy moment. More...
 
virtual void set (BaseRecord &record, T const &value) const =0
 

Static Public Member Functions

static ShapeResultKey addFields (afw::table::Schema &schema, std::string const &name, std::string const &doc, UncertaintyEnum uncertainty, afw::table::CoordinateType coordType=afw::table::CoordinateType::PIXEL)
 Add the appropriate fields to a Schema, and return a ShapeResultKey that manages them. More...
 

Detailed Description

A FunctorKey for ShapeResult.

This class makes it easy to copy shapes and their uncertainties to and from records, and provides a method to add the appropriate fields to a Schema.

Definition at line 113 of file ShapeUtilities.h.

Constructor & Destructor Documentation

◆ ShapeResultKey() [1/3]

lsst::meas::base::ShapeResultKey::ShapeResultKey ( )
inline

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

Definition at line 131 of file ShapeUtilities.h.

◆ ShapeResultKey() [2/3]

lsst::meas::base::ShapeResultKey::ShapeResultKey ( afw::table::QuadrupoleKey const &  shape,
afw::table::CovarianceMatrixKey< ErrElement, 3 > const &  shapeErr 
)
inline

Construct from a pair of Keys.

Definition at line 134 of file ShapeUtilities.h.

◆ ShapeResultKey() [3/3]

lsst::meas::base::ShapeResultKey::ShapeResultKey ( afw::table::SubSchema const &  s)

Construct from a subschema, assuming _xx, _yy, etc.

subfields

If a schema has "a_xx", "a_yy", etc. fields, this constructor allows you to construct a ShapeResultKey via:

ShapeResultKey k(schema["a"]);
ShapeResultKey()
Default constructor; instance will not be usuable unless subsequently assigned to.

Definition at line 119 of file ShapeUtilities.cc.

Member Function Documentation

◆ addFields()

ShapeResultKey lsst::meas::base::ShapeResultKey::addFields ( afw::table::Schema schema,
std::string const &  name,
std::string const &  doc,
UncertaintyEnum  uncertainty,
afw::table::CoordinateType  coordType = afw::table::CoordinateType::PIXEL 
)
static

Add the appropriate fields to a Schema, and return a ShapeResultKey that manages them.

Parameters
[in,out]schemaSchema to add fields to.
[in]nameName prefix for all fields; "_xx", "_yy", etc. will be appended to this to form the full field names.
[in]docString used as the documentation for the xx, yy, xy fields.
[in]uncertaintyEnum indicating which (if any) uncertainty values will be saved.

The unit for all fields will be pixels^2 (pixels^4 for covariances).

Definition at line 74 of file ShapeUtilities.cc.

◆ get()

ShapeResult lsst::meas::base::ShapeResultKey::get ( afw::table::BaseRecord const &  record) const
virtual

Get a ShapeResult from the given record.

Implements lsst::afw::table::FunctorKey< ShapeResult >.

Definition at line 127 of file ShapeUtilities.cc.

◆ getIxx()

afw::table::Key<ShapeElement> lsst::meas::base::ShapeResultKey::getIxx ( ) const
inline

Return a Key for the xx moment.

Definition at line 173 of file ShapeUtilities.h.

◆ getIxy()

afw::table::Key<ShapeElement> lsst::meas::base::ShapeResultKey::getIxy ( ) const
inline

Return a Key for the xy moment.

Definition at line 179 of file ShapeUtilities.h.

◆ getIyy()

afw::table::Key<ShapeElement> lsst::meas::base::ShapeResultKey::getIyy ( ) const
inline

Return a Key for the yy moment.

Definition at line 176 of file ShapeUtilities.h.

◆ getShape()

afw::table::QuadrupoleKey lsst::meas::base::ShapeResultKey::getShape ( ) const
inline

Return a FunctorKey to just the shape value.

Definition at line 167 of file ShapeUtilities.h.

◆ getShapeErr()

afw::table::CovarianceMatrixKey<ErrElement, 3> lsst::meas::base::ShapeResultKey::getShapeErr ( ) const
inline

Return a FunctorKey to just the uncertainty matrix.

Definition at line 170 of file ShapeUtilities.h.

◆ isValid()

bool lsst::meas::base::ShapeResultKey::isValid ( ) const
inline

Return True if the shape key is valid.

Definition at line 164 of file ShapeUtilities.h.

◆ operator!=()

bool lsst::meas::base::ShapeResultKey::operator!= ( ShapeResultKey const &  other) const
inline

Definition at line 160 of file ShapeUtilities.h.

◆ operator==()

bool lsst::meas::base::ShapeResultKey::operator== ( ShapeResultKey const &  other) const
inline

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

Definition at line 157 of file ShapeUtilities.h.

◆ set()

void lsst::meas::base::ShapeResultKey::set ( afw::table::BaseRecord record,
ShapeResult const &  value 
) const
virtual

Set a ShapeResult in the given record.

Definition at line 136 of file ShapeUtilities.cc.


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