LSST Applications g0265f82a02+c6dfa2ddaf,g1162b98a3f+b2075782a9,g2079a07aa2+1b2e822518,g2bbee38e9b+c6dfa2ddaf,g337abbeb29+c6dfa2ddaf,g3ddfee87b4+a60788ef87,g50ff169b8f+2eb0e556e8,g52b1c1532d+90ebb246c7,g555ede804d+a60788ef87,g591dd9f2cf+ba8caea58f,g5ec818987f+864ee9cddb,g858d7b2824+9ee1ab4172,g876c692160+a40945ebb7,g8a8a8dda67+90ebb246c7,g8cdfe0ae6a+4fd9e222a8,g99cad8db69+5e309b7bc6,g9ddcbc5298+a1346535a5,ga1e77700b3+df8f93165b,ga8c6da7877+aa12a14d27,gae46bcf261+c6dfa2ddaf,gb0e22166c9+8634eb87fb,gb3f2274832+d0da15e3be,gba4ed39666+1ac82b564f,gbb8dafda3b+5dfd9c994b,gbeb006f7da+97157f9740,gc28159a63d+c6dfa2ddaf,gc86a011abf+9ee1ab4172,gcf0d15dbbd+a60788ef87,gdaeeff99f8+1cafcb7cd4,gdc0c513512+9ee1ab4172,ge79ae78c31+c6dfa2ddaf,geb67518f79+ba1859f325,geb961e4c1e+f9439d1e6f,gee10cc3b42+90ebb246c7,gf1cff7945b+9ee1ab4172,w.2024.12
LSST Data Management Base Package
Loading...
Searching...
No Matches
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< T > lsst::afw::table::InputFunctorKey< T >

Public Types

using Value
 The data type for get and set.
 

Public Member Functions

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

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.

Member Typedef Documentation

◆ Value

using lsst::afw::table::FunctorKey< ShapeResult >::Value
inherited

The data type for get and set.

Definition at line 77 of file FunctorKey.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.

131: _shape(), _shapeErr() {}

◆ 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.

136 : _shape(shape), _shapeErr(shapeErr) {}

◆ 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"]);
A FunctorKey for ShapeResult.

Definition at line 119 of file ShapeUtilities.cc.

119 : _shape(s) {
120 static std::vector<std::string> names = getNameVector(); // C++11 TODO: just use initializer list
121 try {
122 _shapeErr = afw::table::CovarianceMatrixKey<ErrElement, 3>(s, names);
123 } catch (pex::exceptions::NotFoundError &) {
124 }
125}

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.

76 {
78 r._shape = afw::table::QuadrupoleKey::addFields(schema, name, doc, coordType);
79 if (uncertainty != NO_UNCERTAINTY) {
82 sigma[0] = schema.addField<ErrElement>(
83 schema.join(name, "xxErr"), "Standard deviation of xx moment",
84 coordType == afw::table::CoordinateType::PIXEL ? "pixel^2" : "rad^2");
85 sigma[1] = schema.addField<ErrElement>(
86 schema.join(name, "yyErr"), "Standard deviation of yy moment",
87 coordType == afw::table::CoordinateType::PIXEL ? "pixel^2" : "rad^2");
88 sigma[2] = schema.addField<ErrElement>(
89 schema.join(name, "xyErr"), "Standard deviation of xy moment",
90 coordType == afw::table::CoordinateType::PIXEL ? "pixel^2" : "rad^2");
91 if (uncertainty == FULL_COVARIANCE) {
92 cov.push_back(schema.addField<ErrElement>(
93 schema.join(name, "xx_yy_Cov"), "uncertainty covariance in xx and yy",
94 coordType == afw::table::CoordinateType::PIXEL ? "pixel^4" : "rad^4"));
95 cov.push_back(schema.addField<ErrElement>(
96 schema.join(name, "xx_xy_Cov"), "uncertainty covariance in xx and xy",
97 coordType == afw::table::CoordinateType::PIXEL ? "pixel^4" : "rad^4"));
98 cov.push_back(schema.addField<ErrElement>(
99 schema.join(name, "yy_xy_Cov"), "uncertainty covariance in yy and xy",
100 coordType == afw::table::CoordinateType::PIXEL ? "pixel^4" : "rad^4"));
101 }
102 r._shapeErr = afw::table::CovarianceMatrixKey<ErrElement, 3>(sigma, cov);
103 }
104 return r;
105}
afw::table::Key< double > sigma
static QuadrupoleKey addFields(Schema &schema, std::string const &name, std::string const &doc, CoordinateType coordType=CoordinateType::PIXEL)
Add a set of quadrupole subfields to a schema and return a QuadrupoleKey that points to them.
ShapeResultKey()
Default constructor; instance will not be usuable unless subsequently assigned to.
@ FULL_COVARIANCE
The full covariance matrix is provided.
Definition constants.h:46
@ NO_UNCERTAINTY
Algorithm provides no uncertainy information at all.
Definition constants.h:44
T push_back(T... args)

◆ 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::OutputFunctorKey< T >.

Definition at line 127 of file ShapeUtilities.cc.

127 {
128 ShapeResult r;
129 r.setShape(record.get(_shape));
130 if (_shapeErr.isValid()) {
131 r.setShapeErr(record.get(_shapeErr));
132 }
133 return r;
134}
bool isValid() const noexcept
Return True if all the constituent error Keys are valid.

◆ 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.

173{ return _shape.getIxx(); }
Key< double > getIxx() const noexcept
Return a constituent Key.
Definition aggregates.h:433

◆ 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.

179{ return _shape.getIxy(); }
Key< double > getIxy() const noexcept
Definition aggregates.h:435

◆ 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.

176{ return _shape.getIyy(); }
Key< double > getIyy() const noexcept
Definition aggregates.h:434

◆ 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.

167{ return _shape; }

◆ 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.

170{ return _shapeErr; }

◆ 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.

164{ return _shape.isValid() && _shapeErr.isValid(); }
bool isValid() const noexcept
Return True if all the constituent Keys are valid.
Definition aggregates.h:429

◆ operator!=()

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

Definition at line 160 of file ShapeUtilities.h.

160{ return !(*this == other); }

◆ 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.

157 {
158 return _shape == other._shape && _shapeErr == other._shapeErr;
159 }

◆ set() [1/2]

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.

136 {
137 record.set(_shape, value.getShape());
138 if (_shapeErr.isValid()) {
139 record.set(_shapeErr, value.getShapeErr());
140 }
141}

◆ 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: