lsst::meas::extensions::simpleShape::SimpleShapeResultKey Class Reference

#include <simpleShape.h>

Inheritance diagram for lsst::meas::extensions::simpleShape::SimpleShapeResultKey:

Public Types
using	Value = SimpleShapeResult
	The data type for get and set. More...

Public Member Functions
	SimpleShapeResultKey ()
	SimpleShapeResultKey (lsst::afw::table::SubSchema const &s)
	Construct from a subschema, assuming _xx, _yy, etc. More...
virtual SimpleShapeResult	get (afw::table::BaseRecord const &record) const
virtual void	set (afw::table::BaseRecord &record, SimpleShapeResult const &value) const
bool	operator== (SimpleShapeResultKey const &other) const
	Compare the FunctorKey for equality with another, using the underlying Keys. More...
bool	operator!= (SimpleShapeResultKey const &other) const
bool	isValid () const
	Return True if the key is valid. More...
lsst::meas::base::FlagHandler const &	getFlagHandler () const
virtual void	set (BaseRecord &record, T const &value) const =0

Static Public Member Functions
static SimpleShapeResultKey	addFields (afw::table::Schema &schema, std::string const &name)

Detailed Description

Definition at line 52 of file simpleShape.h.

Member Typedef Documentation

Value

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

inherited

The data type for get and set.

Definition at line 77 of file FunctorKey.h.

Constructor & Destructor Documentation

SimpleShapeResultKey() [1/2]

lsst::meas::extensions::simpleShape::SimpleShapeResultKey::SimpleShapeResultKey ( )

inline

Definition at line 60 of file simpleShape.h.

{}

SimpleShapeResultKey() [2/2]

lsst::meas::extensions::simpleShape::SimpleShapeResultKey::SimpleShapeResultKey

(

lsst::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 SimpleShapeResultKey via:

SimpleShapeResultKey k(schema["a"]);

Definition at line 336 of file simpleShape.cc.

                                                                          :
    _shapeResult(s),
    _centroidResult(s),
    _uncertantyResult(s, std::vector<std::string> ({"Ixx", "Iyy", "Ixy", "Ix", "Iy"})),
    _flagHandler(s, SimpleShape::getFlagDefinitions())
{}

Member Function Documentation

addFields()

SimpleShapeResultKey lsst::meas::extensions::simpleShape::SimpleShapeResultKey::addFields ( afw::table::Schema &  schema, std::string const &  name  )

static

Definition at line 319 of file simpleShape.cc.

  {
            SimpleShapeResultKey r;
            r._shapeResult = lsst::afw::table::QuadrupoleKey::addFields(schema,
                                                            name, "elliptical Gaussian moments");
            r._centroidResult = lsst::afw::table::Point2DKey::addFields(schema,
                                                            name, "elliptical Gaussian moments", "pixel");
            r._uncertantyResult = lsst::afw::table::CovarianceMatrixKey<double, 5>::addFields(schema,name,
                                                            std::vector<std::string> ({"Ixx", "Iyy", "Ixy",
                                                                                      "Ix", "Iy"}), "pixel");
            r._flagHandler = lsst::meas::base::FlagHandler::addFields(schema,
                                                            name, SimpleShape::getFlagDefinitions());
            return r;
}

get()

SimpleShapeResult lsst::meas::extensions::simpleShape::SimpleShapeResultKey::get ( afw::table::BaseRecord const &  record ) const

virtual

Implements lsst::afw::table::OutputFunctorKey< T >.

Definition at line 343 of file simpleShape.cc.

                                                                                       {
    SimpleShapeResult result;
    result.ellipse = record.get(_shapeResult);
    result.center = record.get(_centroidResult);
    result.covariance = record.get(_uncertantyResult);
    for (std::size_t n = 0; n < SimpleShape::N_FLAGS; ++n) {
        result.flags[n] = _flagHandler.getValue(record, n);
    }
    return result;
}

getFlagHandler()

lsst::meas::base::FlagHandler const& lsst::meas::extensions::simpleShape::SimpleShapeResultKey::getFlagHandler ( ) const

inline

Definition at line 85 of file simpleShape.h.

{ return _flagHandler; }

isValid()

bool lsst::meas::extensions::simpleShape::SimpleShapeResultKey::isValid

(

)

const

Return True if the key is valid.

Definition at line 370 of file simpleShape.cc.

                                         {
    return _shapeResult.isValid() &&
        _centroidResult.isValid() &&
        _uncertantyResult.isValid();
    //don't bother with flags - if we've gotten this far, it's basically impossible the flags don't match
}

operator!=()

bool lsst::meas::extensions::simpleShape::SimpleShapeResultKey::operator!= ( SimpleShapeResultKey const &  other ) const

inline

Definition at line 79 of file simpleShape.h.

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

operator==()

bool lsst::meas::extensions::simpleShape::SimpleShapeResultKey::operator==

(

SimpleShapeResultKey const &

other

)

const

Compare the FunctorKey for equality with another, using the underlying Keys.

Definition at line 363 of file simpleShape.cc.

                                                                              {
    return _shapeResult == other._shapeResult &&
        _centroidResult == other._centroidResult &&
        _uncertantyResult == other._uncertantyResult;
    //don't bother with flags - if we've gotten this far, it's basically impossible the flags don't match
}

set() [1/2]

void lsst::meas::extensions::simpleShape::SimpleShapeResultKey::set ( afw::table::BaseRecord &  record, SimpleShapeResult const &  value  ) const

virtual

Definition at line 354 of file simpleShape.cc.

                                                                                                 {
    record.set(_shapeResult, value.ellipse);
    record.set(_centroidResult, value.center);
    record.set(_uncertantyResult, value.covariance);
    for (std::size_t n = 0; n < SimpleShape::N_FLAGS; ++n) {
        _flagHandler.setValue(record, n, value.flags[n]);
    }
}

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_extensions_simpleShape/22.0.0+729191ecac/include/lsst/meas/extensions/simpleShape.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_extensions_simpleShape/22.0.0+729191ecac/src/simpleShape.cc