LSSTApplications
20.0.0
LSSTDataManagementBasePackage
|
A FunctorKey for ShapeResult. More...
#include <ShapeUtilities.h>
Public Types | |
using | Value = ShapeResult |
The data type for get and set. More... | |
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< ShapeElement > | getIxx () const |
Return a Key for the xx moment. More... | |
afw::table::Key< ShapeElement > | getIyy () const |
Return a Key for the yy moment. More... | |
afw::table::Key< ShapeElement > | getIxy () const |
Return a Key for the xy moment. More... | |
virtual void | set (BaseRecord &record, ShapeResult 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... | |
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.
|
inherited |
The data type for get and set.
Definition at line 77 of file FunctorKey.h.
|
inline |
Default constructor; instance will not be usuable unless subsequently assigned to.
Definition at line 131 of file ShapeUtilities.h.
|
inline |
Construct from a pair of Keys.
Definition at line 134 of file ShapeUtilities.h.
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:
Definition at line 119 of file ShapeUtilities.cc.
|
static |
Add the appropriate fields to a Schema, and return a ShapeResultKey that manages them.
[in,out] | schema | Schema to add fields to. |
[in] | name | Name prefix for all fields; "_xx", "_yy", etc. will be appended to this to form the full field names. |
[in] | doc | String used as the documentation for the xx, yy, xy fields. |
[in] | uncertainty | Enum 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.
|
virtual |
Get a ShapeResult from the given record.
Implements lsst::afw::table::OutputFunctorKey< ShapeResult >.
Definition at line 127 of file ShapeUtilities.cc.
|
inline |
|
inline |
|
inline |
|
inline |
Return a FunctorKey to just the shape value.
Definition at line 167 of file ShapeUtilities.h.
|
inline |
Return a FunctorKey to just the uncertainty matrix.
Definition at line 170 of file ShapeUtilities.h.
|
inline |
Return True if the shape key is valid.
Definition at line 164 of file ShapeUtilities.h.
|
inline |
Definition at line 160 of file ShapeUtilities.h.
|
inline |
Compare the FunctorKey for equality with another, using the underlying Keys.
Definition at line 157 of file ShapeUtilities.h.
|
virtual |
|
pure virtualinherited |