LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Types | Public Member Functions | Static Public Member Functions | List of all members
lsst::shapelet::MultiShapeletFunctionKey Class Referenceabstract

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

#include <FunctorKeys.h>

Inheritance diagram for lsst::shapelet::MultiShapeletFunctionKey:
lsst::afw::table::FunctorKey< MultiShapeletFunction > lsst::afw::table::OutputFunctorKey< T > lsst::afw::table::InputFunctorKey< T >

Public Types

using Value = MultiShapeletFunction
 The data type for get and set. More...
 

Public Member Functions

 MultiShapeletFunctionKey ()
 Default constructor; instance will not be usuable unless subsequently assigned to. More...
 
 MultiShapeletFunctionKey (std::vector< std::shared_ptr< ShapeletFunctionKey >> const &components)
 Construct from individual Keys/FunctorKeys. More...
 
 MultiShapeletFunctionKey (afw::table::SubSchema const &s, BasisTypeEnum basisType=HERMITE)
 Construct from a subschema, assuming the necesary subfields. More...
 
virtual MultiShapeletFunction get (afw::table::BaseRecord const &record) const
 Get a MultiShapeletFunction from the given record. More...
 
virtual void set (afw::table::BaseRecord &record, MultiShapeletFunction const &value) const
 Set a MultiShapeletFunction in the given record. More...
 
bool operator== (MultiShapeletFunctionKey const &other) const
 Compare the FunctorKey for equality with another, using the underlying Ixx, Iyy, Ixy Keys. More...
 
bool operator!= (MultiShapeletFunctionKey const &other) const
 
bool isValid () const
 Return True if all the constituent Keys are valid. More...
 
std::shared_ptr< ShapeletFunctionKeyoperator[] (int n)
 Return a FunctorKey to the nth component. More...
 
std::shared_ptr< ShapeletFunctionKey const > operator[] (int n) const
 Return a FunctorKey to the nth component. More...
 
virtual void set (BaseRecord &record, T const &value) const =0
 

Static Public Member Functions

static MultiShapeletFunctionKey addFields (afw::table::Schema &schema, std::string const &name, std::string const &doc, std::string const &ellipseUnit, std::string const &coeffUnit, std::vector< int > const &orders, BasisTypeEnum basisType=HERMITE)
 Add the necessary fields for saving a ShapeletFunction to a Schema. More...
 

Detailed Description

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

A MultiShapeletFunctionKey holds a sequnece of ShapeletFunctionKey, with an numerical prefix in front of each component. A two-component MultiShapeletFunctionKey would thus be associated with the following keys:

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

Definition at line 161 of file FunctorKeys.h.

Member Typedef Documentation

◆ Value

The data type for get and set.

Definition at line 77 of file FunctorKey.h.

Constructor & Destructor Documentation

◆ MultiShapeletFunctionKey() [1/3]

lsst::shapelet::MultiShapeletFunctionKey::MultiShapeletFunctionKey ( )
inline

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

Definition at line 190 of file FunctorKeys.h.

190 {}

◆ MultiShapeletFunctionKey() [2/3]

lsst::shapelet::MultiShapeletFunctionKey::MultiShapeletFunctionKey ( std::vector< std::shared_ptr< ShapeletFunctionKey >> const &  components)
inlineexplicit

Construct from individual Keys/FunctorKeys.

Definition at line 193 of file FunctorKeys.h.

193  :
194  _components(components)
195  {}
table::Key< table::Array< int > > components

◆ MultiShapeletFunctionKey() [3/3]

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

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"]);
table::Schema schema
Definition: python.h:134

Member Function Documentation

◆ addFields()

static MultiShapeletFunctionKey lsst::shapelet::MultiShapeletFunctionKey::addFields ( afw::table::Schema schema,
std::string const &  name,
std::string const &  doc,
std::string const &  ellipseUnit,
std::string const &  coeffUnit,
std::vector< int > const &  orders,
BasisTypeEnum  basisType = HERMITE 
)
static

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

Parameters
[in,out]schemaSchema to add fields to.
[in]nameName prefix for all fields.
[in]docString used as the documentation for the fields.
[in]ellipseUnitString used as the unit for the ellipse ("<ellipseUnit>^2" will be used for the Quadrupole moments).
[in]coeffUnitString used as the unit for the coefficient vector
[in]ordersVector of orders of the ShapeletFunctions to be saved.
[in]basisTypeType 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 MultiShapeletFunction lsst::shapelet::MultiShapeletFunctionKey::get ( afw::table::BaseRecord const &  record) const
virtual

Get a MultiShapeletFunction from the given record.

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

◆ isValid()

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

Return True if all the constituent Keys are valid.

◆ operator!=()

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

Definition at line 217 of file FunctorKeys.h.

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

◆ operator==()

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

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

◆ operator[]() [1/2]

std::shared_ptr<ShapeletFunctionKey> lsst::shapelet::MultiShapeletFunctionKey::operator[] ( int  n)
inline

Return a FunctorKey to the nth component.

Definition at line 224 of file FunctorKeys.h.

224 { return _components[n]; }

◆ operator[]() [2/2]

std::shared_ptr<ShapeletFunctionKey const> lsst::shapelet::MultiShapeletFunctionKey::operator[] ( int  n) const
inline

Return a FunctorKey to the nth component.

Definition at line 227 of file FunctorKeys.h.

227 { return _components[n]; }

◆ set() [1/2]

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

Set a MultiShapeletFunction in the given record.

◆ 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 file: