lsst::meas::base::CentroidResultKey Class Reference

A FunctorKey for CentroidResult. More...

#include <CentroidUtilities.h>

Inheritance diagram for lsst::meas::base::CentroidResultKey:

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

using lsst::afw::table::FunctorKey< CentroidResult >::Value = CentroidResult

inherited

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.

: _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.

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

CentroidResultKey k(schema["a"]);

Definition at line 97 of file CentroidUtilities.cc.

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

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

                                                                                                  {
    CentroidResultKey r;
    r._centroid = afw::table::PointKey<CentroidElement>::addFields(schema, name, doc, "pixel");
    if (uncertainty != NO_UNCERTAINTY) {
        std::vector<afw::table::Key<ErrElement> > sigma(2);
        std::vector<afw::table::Key<ErrElement> > cov;
        sigma[0] = schema.addField<ErrElement>(schema.join(name, "xErr"), "1-sigma uncertainty on x position",
                                               "pixel");
        sigma[1] = schema.addField<ErrElement>(schema.join(name, "yErr"), "1-sigma uncertainty on y position",
                                               "pixel");
        if (uncertainty == FULL_COVARIANCE) {
            cov.push_back(schema.addField<ErrElement>(schema.join(name, "x_y_Cov"),
                                                      "uncertainty covariance in x and y", "pixel^2"));
        }
        r._centroidErr = afw::table::CovarianceMatrixKey<ErrElement, 2>(sigma, cov);
    }
    return r;
}

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

Definition at line 105 of file CentroidUtilities.cc.

                                                                            {
    CentroidResult r;
    r.setCentroid(record.get(_centroid));
    if (_centroidErr.isValid()) {
        r.setCentroidErr(record.get(_centroidErr));
    }
    return r;
}

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.

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

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

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

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

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

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

                                                          {
        return _centroid == other._centroid && _centroidErr == other._centroidErr;
    }

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.

                                                                                         {
    record.set(_centroid, value.getCentroid());
    if (_centroidErr.isValid()) {
        record.set(_centroidErr, value.getCentroidErr());
    }
}

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:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_base/22.0.1-25-gb120d7b+8b5510f75f/include/lsst/meas/base/CentroidUtilities.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_base/22.0.1-25-gb120d7b+8b5510f75f/src/CentroidUtilities.cc