LSSTApplications  19.0.0-10-g920eed2,19.0.0-11-g48a0200+2,19.0.0-18-gfc4e62b+11,19.0.0-2-g3b2f90d+2,19.0.0-2-gd671419+5,19.0.0-20-g5a5a17ab+9,19.0.0-21-g2644856+11,19.0.0-22-gc5dc5b1+6,19.0.0-23-gdc29a50+3,19.0.0-24-g923e380+11,19.0.0-25-g6c8df7140,19.0.0-28-g9b887e2,19.0.0-3-g2b32d65+5,19.0.0-3-g8227491+10,19.0.0-3-g9c54d0d+10,19.0.0-3-gca68e65+6,19.0.0-3-gcfc5f51+5,19.0.0-3-ge110943+9,19.0.0-3-ge74d124,19.0.0-3-gfe04aa6+11,19.0.0-4-g06f5963+5,19.0.0-4-g3d16501+11,19.0.0-4-g4a9c019+5,19.0.0-4-g5a8b323,19.0.0-4-g66397f0+1,19.0.0-4-g8278b9b+1,19.0.0-4-g8557e14,19.0.0-4-g8964aba+11,19.0.0-4-ge404a01+10,19.0.0-5-g40f3a5a,19.0.0-5-g4db63b3,19.0.0-5-gfb03ce7+11,19.0.0-6-gbaebbfb+10,19.0.0-60-gafafd468+11,19.0.0-67-g3ab1e6e,19.0.0-7-g039c0b5+9,19.0.0-7-gbea9075+4,19.0.0-7-gc567de5+11,19.0.0-8-g3a3ce09+6,19.0.0-9-g463f923+10,w.2020.21
LSSTDataManagementBasePackage
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< ShapeResult > lsst::afw::table::InputFunctorKey< ShapeResult >

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

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

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:

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 }

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

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 }

◆ 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(); }

◆ 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(); }

◆ 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(); }

◆ 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(); }

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

virtual void lsst::afw::table::InputFunctorKey< ShapeResult >::set ( BaseRecord record,
ShapeResult const &  value 
) const
pure virtualinherited

The documentation for this class was generated from the following files:
schema
table::Schema schema
Definition: Amplifier.cc:115
lsst::meas::base::FULL_COVARIANCE
@ FULL_COVARIANCE
The full covariance matrix is provided.
Definition: constants.h:46
lsst::afw::table::CoordinateType::PIXEL
@ PIXEL
lsst::meas::base::NO_UNCERTAINTY
@ NO_UNCERTAINTY
Algorithm provides no uncertainy information at all.
Definition: constants.h:44
std::vector< std::string >
sigma
afw::table::Key< double > sigma
Definition: GaussianPsf.cc:50
lsst::afw::table::QuadrupoleKey::getIyy
Key< double > getIyy() const noexcept
Definition: aggregates.h:347
lsst::afw::geom.transform.transformContinued.name
string name
Definition: transformContinued.py:32
std::vector::push_back
T push_back(T... args)
lsst::afw::table::CovarianceMatrixKey::isValid
bool isValid() const noexcept
Return True if all the constituent error Keys are valid.
Definition: aggregates.cc:294
lsst::afw::table::QuadrupoleKey::addFields
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.
Definition: aggregates.cc:100
other
ItemVariant const * other
Definition: Schema.cc:56
lsst::meas::base::ShapeResultKey::ShapeResultKey
ShapeResultKey()
Default constructor; instance will not be usuable unless subsequently assigned to.
Definition: ShapeUtilities.h:131
lsst::meas::base::ErrElement
float ErrElement
Definition: constants.h:55
lsst::afw::table::QuadrupoleKey::getIxx
Key< double > getIxx() const noexcept
Return a constituent Key.
Definition: aggregates.h:346
lsst::afw::table::QuadrupoleKey::getIxy
Key< double > getIxy() const noexcept
Definition: aggregates.h:348
lsst::afw::table::QuadrupoleKey::isValid
bool isValid() const noexcept
Return True if all the constituent Keys are valid.
Definition: aggregates.h:342