lsst::shapelet::ShapeletFunctionKey Class Reference

Class that maps ShapeletFunction objects to fields in afw::table objects. More...

#include <FunctorKeys.h>

Inheritance diagram for lsst::shapelet::ShapeletFunctionKey:

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

Public Member Functions
	ShapeletFunctionKey ()
	Default constructor; instance will not be usuable unless subsequently assigned to.
	ShapeletFunctionKey (afw::table::EllipseKey const &ellipse, afw::table::ArrayKey< double > const &coefficients, BasisTypeEnum basisType=HERMITE)
	Construct from individual Keys/FunctorKeys.
	ShapeletFunctionKey (afw::table::SubSchema const &s, BasisTypeEnum basisType=HERMITE)
	Construct from a subschema, assuming the necesary subfields.
virtual ShapeletFunction	get (afw::table::BaseRecord const &record) const
	Get a ShapeletFunction from the given record.
virtual void	set (afw::table::BaseRecord &record, ShapeletFunction const &value) const
	Set a ShapeletFunction in the given record.
bool	operator== (ShapeletFunctionKey const &other) const
	Compare the FunctorKey for equality with another, using the underlying Ixx, Iyy, Ixy Keys.
bool	operator!= (ShapeletFunctionKey const &other) const
bool	isValid () const
	Return True if all the constituent Keys are valid.
afw::table::EllipseKey const &	getEllipse () const
	Return a FunctorKey that extracts just the Ellipse.
afw::table::ArrayKey< double > const &	getCoefficients () const
	Return a FunctorKey that extracts just the coefficients.
int	getOrder () const
	Return the shapelet order.
BasisTypeEnum	getBasisType () const
	Return the type of the shapelet basis.
virtual void	set (BaseRecord &record, ShapeletFunction const &value) const=0
virtual void	set (BaseRecord &record, ShapeletFunction const &value) const=0

Static Public Member Functions
static ShapeletFunctionKey	addFields (afw::table::Schema &schema, std::string const &name, std::string const &doc, std::string const &ellipseUnit, std::string const &coeffUnit, int order, BasisTypeEnum basisType=HERMITE)
	Add the necessary fields for saving a ShapeletFunction to a Schema.

Detailed Description

Class that maps ShapeletFunction objects to fields in afw::table objects.

A ShapeletFunctionKey manages a set of fields with a common prefix and the following suffixes:

• "x", "y", "xx", "yy", "xy": ellipse
• "0", "1", "2", ...: coefficients.

As with all FunctorKeys, a ShapeletFunctorKey can be used to directly get or set objects on an afw::table::BaseRecord, just as with a true Key.

Definition at line 45 of file FunctorKeys.h.

Member Typedef Documentation

Value

using lsst::afw::table::FunctorKey< ShapeletFunction >::Value

inherited

The data type for get and set.

Definition at line 77 of file FunctorKey.h.

Constructor & Destructor Documentation

ShapeletFunctionKey() [1/3]

lsst::shapelet::ShapeletFunctionKey::ShapeletFunctionKey ( )

inline

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

Definition at line 74 of file FunctorKeys.h.

: _ellipseKey(), _coefficientsKey(), _order(-1), _basisType(HERMITE) {}

ShapeletFunctionKey() [2/3]

lsst::shapelet::ShapeletFunctionKey::ShapeletFunctionKey ( afw::table::EllipseKey const & ellipse, afw::table::ArrayKey< double > const & coefficients, BasisTypeEnum basisType = HERMITE )

inline

Construct from individual Keys/FunctorKeys.

Definition at line 77 of file FunctorKeys.h.

      :
        _ellipseKey(ellipse),
        _coefficientsKey(coefficients),
        _order(computeOrder(coefficients.getSize())),
        _basisType(basisType)
    {}

ShapeletFunctionKey() [3/3]

lsst::shapelet::ShapeletFunctionKey::ShapeletFunctionKey ( afw::table::SubSchema const & s, BasisTypeEnum basisType = HERMITE )

inline

Construct from a subschema, assuming the necesary subfields.

If a schema has e.g. "a_xx", "a_0", etc. fields, this constructor allows you to construct a ShapeletFunctionKey via:

ShapeletFunctionKey k(schema["a"]);

Definition at line 97 of file FunctorKeys.h.

                                                                                      :
        _ellipseKey(s), _coefficientsKey(s),
        _order(computeOrder(_coefficientsKey.getSize())),
        _basisType(basisType)
    {}

Member Function Documentation

addFields()

static ShapeletFunctionKey lsst::shapelet::ShapeletFunctionKey::addFields ( afw::table::Schema & schema, std::string const & name, std::string const & doc, std::string const & ellipseUnit, std::string const & coeffUnit, int order, BasisTypeEnum basisType = HERMITE )

static

Add the necessary fields for saving a ShapeletFunction to a Schema.

Parameters

[in,out]	schema	Schema to add fields to.
[in]	name	Name prefix for all fields.
[in]	doc	String used as the documentation for the fields.
[in]	ellipseUnit	String used as the unit for the ellipse ("<ellipseUnit>^2" will be used for the Quadrupole moments).
[in]	coeffUnit	String used as the unit for the coefficient vector
[in]	order	Order of the ShapeletFunction to be saved.
[in]	basisType	Type of shapelet basis (HERMITE or LAGUERRE) to be saved.

This method provides only basic exception safety - the schema may be (partially) modified even if an exception is thrown.

get()

virtual ShapeletFunction lsst::shapelet::ShapeletFunctionKey::get ( afw::table::BaseRecord const & record ) const

virtual

Get a ShapeletFunction from the given record.

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

getBasisType()

BasisTypeEnum lsst::shapelet::ShapeletFunctionKey::getBasisType ( ) const

inline

Return the type of the shapelet basis.

Definition at line 131 of file FunctorKeys.h.

{ return _basisType; }

getCoefficients()

afw::table::ArrayKey< double > const & lsst::shapelet::ShapeletFunctionKey::getCoefficients ( ) const

inline

Return a FunctorKey that extracts just the coefficients.

Definition at line 125 of file FunctorKeys.h.

{ return _coefficientsKey; }

getEllipse()

afw::table::EllipseKey const & lsst::shapelet::ShapeletFunctionKey::getEllipse ( ) const

inline

Return a FunctorKey that extracts just the Ellipse.

Definition at line 122 of file FunctorKeys.h.

{ return _ellipseKey; }

getOrder()

int lsst::shapelet::ShapeletFunctionKey::getOrder ( ) const

inline

Return the shapelet order.

Definition at line 128 of file FunctorKeys.h.

{ return _order; }

isValid()

bool lsst::shapelet::ShapeletFunctionKey::isValid ( ) const

inline

Return True if all the constituent Keys are valid.

Definition at line 119 of file FunctorKeys.h.

{ return _ellipseKey.isValid() && _coefficientsKey.isValid(); }

operator!=()

bool lsst::shapelet::ShapeletFunctionKey::operator!= ( ShapeletFunctionKey const & other ) const

inline

Definition at line 115 of file FunctorKeys.h.

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

operator==()

bool lsst::shapelet::ShapeletFunctionKey::operator== ( ShapeletFunctionKey const & other ) const

inline

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

Definition at line 111 of file FunctorKeys.h.

                                                             {
        return _order == other._order && _ellipseKey == other._ellipseKey
            && _coefficientsKey == other._coefficientsKey;
    }

set() [1/3]

virtual void lsst::afw::table::InputFunctorKey< ShapeletFunction >::set ( BaseRecord & record, ShapeletFunction const & value ) const

pure virtualinherited

set() [2/3]

virtual void lsst::afw::table::InputFunctorKey< ShapeletFunction >::set ( BaseRecord & record, ShapeletFunction const & value ) const

pure virtualinherited

set() [3/3]

virtual void lsst::shapelet::ShapeletFunctionKey::set ( afw::table::BaseRecord & record, ShapeletFunction const & value ) const

virtual

Set a ShapeletFunction in the given record.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/shapelet/g47891489e3+6dc8069a4c/include/lsst/shapelet/FunctorKeys.h