LSSTApplications  19.0.0-10-g920eed2,19.0.0-11-g48a0200+2,19.0.0-18-gfc4e62b+11,19.0.0-2-g3b2f90d+2,19.0.0-2-gd671419+5,19.0.0-20-g5a5a17ab+9,19.0.0-21-g2644856+11,19.0.0-22-gc5dc5b1+6,19.0.0-23-gdc29a50+3,19.0.0-24-g923e380+11,19.0.0-25-g6c8df7140,19.0.0-28-g9b887e2,19.0.0-3-g2b32d65+5,19.0.0-3-g8227491+10,19.0.0-3-g9c54d0d+10,19.0.0-3-gca68e65+6,19.0.0-3-gcfc5f51+5,19.0.0-3-ge110943+9,19.0.0-3-ge74d124,19.0.0-3-gfe04aa6+11,19.0.0-4-g06f5963+5,19.0.0-4-g3d16501+11,19.0.0-4-g4a9c019+5,19.0.0-4-g5a8b323,19.0.0-4-g66397f0+1,19.0.0-4-g8278b9b+1,19.0.0-4-g8557e14,19.0.0-4-g8964aba+11,19.0.0-4-ge404a01+10,19.0.0-5-g40f3a5a,19.0.0-5-g4db63b3,19.0.0-5-gfb03ce7+11,19.0.0-6-gbaebbfb+10,19.0.0-60-gafafd468+11,19.0.0-67-g3ab1e6e,19.0.0-7-g039c0b5+9,19.0.0-7-gbea9075+4,19.0.0-7-gc567de5+11,19.0.0-8-g3a3ce09+6,19.0.0-9-g463f923+10,w.2020.21
LSSTDataManagementBasePackage
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< MultiShapeletFunction > lsst::afw::table::InputFunctorKey< MultiShapeletFunction >

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< boost::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...
 
boost::shared_ptr< ShapeletFunctionKeyoperator[] (int n)
 Return a FunctorKey to the nth component. More...
 
boost::shared_ptr< ShapeletFunctionKey const > operator[] (int n) const
 Return a FunctorKey to the nth component. More...
 
virtual void set (BaseRecord &record, MultiShapeletFunction 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< boost::shared_ptr< ShapeletFunctionKey >> const &  components)
inlineexplicit

Construct from individual Keys/FunctorKeys.

Definition at line 193 of file FunctorKeys.h.

193  :
194  _components(components)
195  {}

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

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

◆ 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]

boost::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]

boost::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]

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

The documentation for this class was generated from the following file:
schema
table::Schema schema
Definition: Amplifier.cc:115
other
ItemVariant const * other
Definition: Schema.cc:56
components
table::Key< table::Array< int > > components
Definition: LinearCombinationKernel.cc:301