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::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< CentroidResult > lsst::afw::table::InputFunctorKey< CentroidResult >

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

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.

Member Typedef Documentation

◆ Value

The data type for get and set.

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

105 : _centroid(), _centroidErr() {}

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

110  : _centroid(centroid), _centroidErr(centroidErr) {}

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

Definition at line 97 of file CentroidUtilities.cc.

97  : _centroid(s) {
98  static std::vector<std::string> names = getNameVector(); // C++11 TODO: just use initializer list
99  try {
100  _centroidErr = afw::table::CovarianceMatrixKey<ErrElement, 2>(s, names);
101  } catch (pex::exceptions::NotFoundError &) {
102  }
103 }

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.

67  {
69  r._centroid = afw::table::PointKey<CentroidElement>::addFields(schema, name, doc, "pixel");
70  if (uncertainty != NO_UNCERTAINTY) {
73  sigma[0] = schema.addField<ErrElement>(schema.join(name, "xErr"), "1-sigma uncertainty on x position",
74  "pixel");
75  sigma[1] = schema.addField<ErrElement>(schema.join(name, "yErr"), "1-sigma uncertainty on y position",
76  "pixel");
77  if (uncertainty == FULL_COVARIANCE) {
78  cov.push_back(schema.addField<ErrElement>(schema.join(name, "x_y_Cov"),
79  "uncertainty covariance in x and y", "pixel^2"));
80  }
81  r._centroidErr = afw::table::CovarianceMatrixKey<ErrElement, 2>(sigma, cov);
82  }
83  return r;
84 }

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

Definition at line 105 of file CentroidUtilities.cc.

105  {
106  CentroidResult r;
107  r.setCentroid(record.get(_centroid));
108  if (_centroidErr.isValid()) {
109  r.setCentroidErr(record.get(_centroidErr));
110  }
111  return r;
112 }

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

141 { return _centroid; }

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

144 { return _centroidErr; }

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

147 { return _centroid.getX(); }

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

150 { return _centroid.getY(); }

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

138 { return _centroid.isValid() && _centroidErr.isValid(); }

◆ operator!=()

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

Definition at line 134 of file CentroidUtilities.h.

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

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

131  {
132  return _centroid == other._centroid && _centroidErr == other._centroidErr;
133  }

◆ set() [1/2]

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.

114  {
115  record.set(_centroid, value.getCentroid());
116  if (_centroidErr.isValid()) {
117  record.set(_centroidErr, value.getCentroidErr());
118  }
119 }

◆ set() [2/2]

virtual void lsst::afw::table::InputFunctorKey< CentroidResult >::set ( BaseRecord record,
CentroidResult 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::PointKey::getX
Key< T > getX() const noexcept
Return the underlying x Key.
Definition: aggregates.h:107
lsst::meas::base::NO_UNCERTAINTY
@ NO_UNCERTAINTY
Algorithm provides no uncertainy information at all.
Definition: constants.h:44
lsst::afw::table::PointKey::addFields
static PointKey addFields(Schema &schema, std::string const &name, std::string const &doc, std::string const &unit)
Add a pair of _x, _y fields to a Schema, and return a PointKey that points to them.
Definition: aggregates.cc:36
std::vector< std::string >
sigma
afw::table::Key< double > sigma
Definition: GaussianPsf.cc:50
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::PointKey::isValid
bool isValid() const noexcept
Return True if both the x and y Keys are valid.
Definition: aggregates.h:104
lsst::sphgeom::detail::centroid
UnitVector3d centroid(VertexIterator const begin, VertexIterator const end)
Definition: ConvexPolygonImpl.h:48
other
ItemVariant const * other
Definition: Schema.cc:56
lsst::meas::base::ErrElement
float ErrElement
Definition: constants.h:55
lsst::meas::base::CentroidResultKey::CentroidResultKey
CentroidResultKey()
Default constructor; instance will not be usuable unless subsequently assigned to.
Definition: CentroidUtilities.h:105
lsst::afw::table::PointKey::getY
Key< T > getY() const noexcept
Return the underlying y Key.
Definition: aggregates.h:110