lsst::meas::base::ShapeResultKey Class Reference

A FunctorKey for ShapeResult. More...

#include <ShapeUtilities.h>

Inheritance diagram for lsst::meas::base::ShapeResultKey:

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< ShapeElement >	getIxx () const
	Return a Key for the xx moment. More...
afw::table::Key< ShapeElement >	getIyy () const
	Return a Key for the yy moment. More...
afw::table::Key< ShapeElement >	getIxy () const
	Return a Key for the xy moment. More...
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. 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

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

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.

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

            : _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"]);

Definition at line 119 of file ShapeUtilities.cc.

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

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]	schema	Schema to add fields to.
[in]	name	Name prefix for all fields; "_xx", "_yy", etc. will be appended to this to form the full field names.
[in]	doc	String used as the documentation for the xx, yy, xy fields.
[in]	uncertainty	Enum 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.

                                                                           {
    ShapeResultKey r;
    r._shape = afw::table::QuadrupoleKey::addFields(schema, name, doc, coordType);
    if (uncertainty != NO_UNCERTAINTY) {
        std::vector<afw::table::Key<ErrElement> > sigma(3);
        std::vector<afw::table::Key<ErrElement> > cov;
        sigma[0] = schema.addField<ErrElement>(
                schema.join(name, "xxErr"), "Standard deviation of xx moment",
                coordType == afw::table::CoordinateType::PIXEL ? "pixel^2" : "rad^2");
        sigma[1] = schema.addField<ErrElement>(
                schema.join(name, "yyErr"), "Standard deviation of yy moment",
                coordType == afw::table::CoordinateType::PIXEL ? "pixel^2" : "rad^2");
        sigma[2] = schema.addField<ErrElement>(
                schema.join(name, "xyErr"), "Standard deviation of xy moment",
                coordType == afw::table::CoordinateType::PIXEL ? "pixel^2" : "rad^2");
        if (uncertainty == FULL_COVARIANCE) {
            cov.push_back(schema.addField<ErrElement>(
                    schema.join(name, "xx_yy_Cov"), "uncertainty covariance in xx and yy",
                    coordType == afw::table::CoordinateType::PIXEL ? "pixel^4" : "rad^4"));
            cov.push_back(schema.addField<ErrElement>(
                    schema.join(name, "xx_xy_Cov"), "uncertainty covariance in xx and xy",
                    coordType == afw::table::CoordinateType::PIXEL ? "pixel^4" : "rad^4"));
            cov.push_back(schema.addField<ErrElement>(
                    schema.join(name, "yy_xy_Cov"), "uncertainty covariance in yy and xy",
                    coordType == afw::table::CoordinateType::PIXEL ? "pixel^4" : "rad^4"));
        }
        r._shapeErr = afw::table::CovarianceMatrixKey<ErrElement, 3>(sigma, cov);
    }
    return r;
}

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.

                                                                      {
    ShapeResult r;
    r.setShape(record.get(_shape));
    if (_shapeErr.isValid()) {
        r.setShapeErr(record.get(_shapeErr));
    }
    return r;
}

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.

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

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

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

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

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

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

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

                                                       {
        return _shape == other._shape && _shapeErr == other._shapeErr;
    }

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.

                                                                                   {
    record.set(_shape, value.getShape());
    if (_shapeErr.isValid()) {
        record.set(_shapeErr, value.getShapeErr());
    }
}

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-19-g93a5c75+d23f2fb6d8/include/lsst/meas/base/ShapeUtilities.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_base/22.0.1-19-g93a5c75+d23f2fb6d8/src/ShapeUtilities.cc