LSSTApplications
20.0.0
LSSTDataManagementBasePackage
|
A FunctorKey for CentroidResult. More...
#include <CentroidUtilities.h>
Public Types | |
using | Value = CentroidResult |
The data type for get and set. More... | |
Public Member Functions | |
CentroidResultKey () | |
Default constructor; instance will not be usuable unless subsequently assigned to. More... | |
CentroidResultKey (afw::table::PointKey< CentroidElement > const ¢roid, afw::table::CovarianceMatrixKey< ErrElement, 2 > const ¢roidErr) | |
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< CentroidElement > | getCentroid () 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< CentroidElement > | getX () const |
Return a Key for the x coordinate. More... | |
afw::table::Key< CentroidElement > | getY () const |
Return a Key for the y coordinate. More... | |
virtual void | set (BaseRecord &record, CentroidResult 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... | |
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.
|
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 105 of file CentroidUtilities.h.
|
inline |
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:
Definition at line 97 of file CentroidUtilities.cc.
|
static |
Add the appropriate fields to a Schema, and return a CentroidResultKey that manages them.
[in,out] | schema | Schema to add fields to. |
[in] | name | Name prefix for all fields; "_x", "_y", etc. will be appended to this to form the full field names. |
[in] | doc | String used as the documentation for the x and y fields. |
[in] | uncertainty | Enum 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.
|
virtual |
Get a CentroidResult from the given record.
Implements lsst::afw::table::OutputFunctorKey< CentroidResult >.
Definition at line 105 of file CentroidUtilities.cc.
|
inline |
Return a FunctorKey to just the centroid value.
Definition at line 141 of file CentroidUtilities.h.
|
inline |
Return a FunctorKey to just the uncertainty matrix.
Definition at line 144 of file CentroidUtilities.h.
|
inline |
|
inline |
|
inline |
Return True if the centroid key is valid.
Definition at line 138 of file CentroidUtilities.h.
|
inline |
Definition at line 134 of file CentroidUtilities.h.
|
inline |
Compare the FunctorKey for equality with another, using the underlying Keys.
Definition at line 131 of file CentroidUtilities.h.
|
virtual |
|
pure virtualinherited |