lsst.meas.base  22.0.1-21-g61eb88f+04d62cfec6
Public Types | Public Member Functions | Static Public Member Functions | List of all members
lsst::meas::base::CentroidResultKey Class Referenceabstract

A FunctorKey for CentroidResult. More...

#include <CentroidUtilities.h>

Inheritance diagram for lsst::meas::base::CentroidResultKey:
lsst::afw::table::FunctorKey< CentroidResult > lsst::afw::table::OutputFunctorKey< class > lsst::afw::table::InputFunctorKey< class >

Public Types

typedef T Value
 

Public Member Functions

 CentroidResultKey ()
 Default constructor; instance will not be usuable unless subsequently assigned to. More...
 
 CentroidResultKey (afw::table::PointKey< CentroidElement > const &centroid, afw::table::CovarianceMatrixKey< ErrElement, 2 > const &centroidErr)
 Construct from a pair of Keys. More...
 
 CentroidResultKey (afw::table::SubSchema const &s)
 Construct from a subschema, assuming _x, _y, etc. More...
 
virtual CentroidResult get (afw::table::BaseRecord const &record) const
 Get a CentroidResult from the given record. More...
 
virtual void set (afw::table::BaseRecord &record, CentroidResult const &value) const
 Set a CentroidResult in the given record. More...
 
bool operator== (CentroidResultKey const &other) const
 Compare the FunctorKey for equality with another, using the underlying Keys. More...
 
bool operator!= (CentroidResultKey const &other) const
 
bool isValid () const
 Return True if the centroid key is valid. More...
 
afw::table::PointKey< CentroidElementgetCentroid () const
 Return a FunctorKey to just the centroid value. More...
 
afw::table::CovarianceMatrixKey< ErrElement, 2 > getCentroidErr () const
 Return a FunctorKey to just the uncertainty matrix. More...
 
afw::table::Key< CentroidElementgetX () const
 Return a Key for the x coordinate. More...
 
afw::table::Key< CentroidElementgetY () const
 Return a Key for the y coordinate. More...
 
virtual void set (BaseRecord &record, T const &value) const =0
 

Static Public Member Functions

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

Detailed Description

A FunctorKey for CentroidResult.

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

Definition at line 88 of file CentroidUtilities.h.

Constructor & Destructor Documentation

◆ CentroidResultKey() [1/3]

lsst::meas::base::CentroidResultKey::CentroidResultKey ( )
inline

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

Definition at line 105 of file CentroidUtilities.h.

◆ CentroidResultKey() [2/3]

lsst::meas::base::CentroidResultKey::CentroidResultKey ( afw::table::PointKey< CentroidElement > const &  centroid,
afw::table::CovarianceMatrixKey< ErrElement, 2 > const &  centroidErr 
)
inline

Construct from a pair of Keys.

Definition at line 108 of file CentroidUtilities.h.

◆ CentroidResultKey() [3/3]

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

Construct from a subschema, assuming _x, _y, etc.

subfields

If a schema has "a_x", "a_y", etc. fields, this constructor allows you to construct a CentroidResultKey via:

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

Definition at line 97 of file CentroidUtilities.cc.

Member Function Documentation

◆ addFields()

CentroidResultKey lsst::meas::base::CentroidResultKey::addFields ( afw::table::Schema schema,
std::string const &  name,
std::string const &  doc,
UncertaintyEnum  uncertainty 
)
static

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

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

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

Definition at line 66 of file CentroidUtilities.cc.

◆ get()

CentroidResult lsst::meas::base::CentroidResultKey::get ( afw::table::BaseRecord const &  record) const
virtual

Get a CentroidResult from the given record.

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

Definition at line 105 of file CentroidUtilities.cc.

◆ getCentroid()

afw::table::PointKey<CentroidElement> lsst::meas::base::CentroidResultKey::getCentroid ( ) const
inline

Return a FunctorKey to just the centroid value.

Definition at line 141 of file CentroidUtilities.h.

◆ getCentroidErr()

afw::table::CovarianceMatrixKey<ErrElement, 2> lsst::meas::base::CentroidResultKey::getCentroidErr ( ) const
inline

Return a FunctorKey to just the uncertainty matrix.

Definition at line 144 of file CentroidUtilities.h.

◆ getX()

afw::table::Key<CentroidElement> lsst::meas::base::CentroidResultKey::getX ( ) const
inline

Return a Key for the x coordinate.

Definition at line 147 of file CentroidUtilities.h.

◆ getY()

afw::table::Key<CentroidElement> lsst::meas::base::CentroidResultKey::getY ( ) const
inline

Return a Key for the y coordinate.

Definition at line 150 of file CentroidUtilities.h.

◆ isValid()

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

Return True if the centroid key is valid.

Definition at line 138 of file CentroidUtilities.h.

◆ operator!=()

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

Definition at line 134 of file CentroidUtilities.h.

◆ operator==()

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

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

Definition at line 131 of file CentroidUtilities.h.

◆ set()

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

Set a CentroidResult in the given record.

Definition at line 114 of file CentroidUtilities.cc.


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