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

A FunctorKey for CentroidResult. More...

#include <CentroidUtilities.h>

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

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. subfields. 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	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...
bool	operator== (CentroidResultKey const &other) const
	Compare the FunctorKey for equality with another, using the underlying Keys. More...
bool	operator!= (CentroidResultKey const &other) const
	Compare the FunctorKey for equality with another, using the underlying Keys. More...
Public Member Functions inherited from lsst::afw::table::OutputFunctorKey< CentroidResult >
virtual	~OutputFunctorKey ()
Public Member Functions inherited from lsst::afw::table::InputFunctorKey< CentroidResult >
virtual void	set (BaseRecord &record, CentroidResultconst &value) const =0
virtual	~InputFunctorKey ()

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

Private Attributes
afw::table::PointKey < CentroidElement >	_centroid
afw::table::CovarianceMatrixKey < ErrElement, 2 >	_centroidErr

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 65 of file CentroidUtilities.h.

Constructor & Destructor Documentation

lsst::meas::base::CentroidResultKey::CentroidResultKey ( )

inline

Default constructor; instance will not be usuable unless subsequently assigned to.

Definition at line 87 of file CentroidUtilities.h.

: _centroid(), _centroidErr() {}

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 90 of file CentroidUtilities.h.

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

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 102 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

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 57 of file CentroidUtilities.cc.

  {
    CentroidResultKey r;
    r._centroid = afw::table::PointKey<CentroidElement>::addFields(
        schema,
        name,
        doc,
        "pixels"
    );
    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, "xSigma"), "1-sigma uncertainty on x position", "pixels"
        );
        sigma[1] = schema.addField<ErrElement>(
            schema.join(name, "ySigma"), "1-sigma uncertainty on y position", "pixels"
        );
        if (uncertainty == FULL_COVARIANCE) {
            cov.push_back(
                schema.addField<ErrElement>(
                    schema.join(name, "x_y_Cov"), "uncertainty covariance in x and y", "pixels^2"
                )
            );
        }
        r._centroidErr = afw::table::CovarianceMatrixKey<ErrElement,2>(sigma, cov);
    }
    return r;
}

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 111 of file CentroidUtilities.cc.

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

afw::table::PointKey<CentroidElement> lsst::meas::base::CentroidResultKey::getCentroid ( ) const

inline

Return a FunctorKey to just the centroid value.

Definition at line 126 of file CentroidUtilities.h.

{ return _centroid; }

afw::table::CovarianceMatrixKey<ErrElement,2> lsst::meas::base::CentroidResultKey::getCentroidErr ( ) const

inline

Return a FunctorKey to just the uncertainty matrix.

Definition at line 129 of file CentroidUtilities.h.

{ return _centroidErr; }

afw::table::Key<CentroidElement> lsst::meas::base::CentroidResultKey::getX ( ) const

inline

Return a Key for the x coordinate.

Definition at line 132 of file CentroidUtilities.h.

{ return _centroid.getX(); }

afw::table::Key<CentroidElement> lsst::meas::base::CentroidResultKey::getY ( ) const

inline

Return a Key for the y coordinate.

Definition at line 135 of file CentroidUtilities.h.

{ return _centroid.getY(); }

bool lsst::meas::base::CentroidResultKey::isValid ( ) const

inline

Return True if the centroid key is valid.

Definition at line 123 of file CentroidUtilities.h.

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

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 119 of file CentroidUtilities.h.

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

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 116 of file CentroidUtilities.h.

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

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 120 of file CentroidUtilities.cc.

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

Member Data Documentation

afw::table::PointKey<CentroidElement> lsst::meas::base::CentroidResultKey::_centroid

private

Definition at line 138 of file CentroidUtilities.h.

afw::table::CovarianceMatrixKey<ErrElement,2> lsst::meas::base::CentroidResultKey::_centroidErr

private

Definition at line 139 of file CentroidUtilities.h.

---

The documentation for this class was generated from the following files:

• /lsst/home/lsstsw/stack/Linux64/meas_base/master-g15627eb03c/include/lsst/meas/base/CentroidUtilities.h
• /lsst/home/lsstsw/stack/Linux64/meas_base/master-g15627eb03c/src/CentroidUtilities.cc