LSSTApplications
20.0.0
LSSTDataManagementBasePackage
|
Class that maps MultiShapeletFunction objects to fields in afw::table objects. More...
#include <FunctorKeys.h>
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< ShapeletFunctionKey > | operator[] (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... | |
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.
|
inherited |
The data type for get and set.
Definition at line 77 of file FunctorKey.h.
|
inline |
Default constructor; instance will not be usuable unless subsequently assigned to.
Definition at line 190 of file FunctorKeys.h.
|
inlineexplicit |
Construct from individual Keys/FunctorKeys.
Definition at line 193 of file FunctorKeys.h.
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:
|
static |
Add the necessary fields for saving a ShapeletFunction to a Schema.
[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] | orders | Vector of orders of the ShapeletFunctions 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.
|
virtual |
Get a MultiShapeletFunction from the given record.
Implements lsst::afw::table::OutputFunctorKey< MultiShapeletFunction >.
bool lsst::shapelet::MultiShapeletFunctionKey::isValid | ( | ) | const |
Return True if all the constituent Keys are valid.
|
inline |
Definition at line 217 of file FunctorKeys.h.
bool lsst::shapelet::MultiShapeletFunctionKey::operator== | ( | MultiShapeletFunctionKey const & | other | ) | const |
Compare the FunctorKey for equality with another, using the underlying Ixx, Iyy, Ixy Keys.
|
inline |
Return a FunctorKey to the nth component.
Definition at line 224 of file FunctorKeys.h.
|
inline |
Return a FunctorKey to the nth component.
Definition at line 227 of file FunctorKeys.h.
|
virtual |
Set a MultiShapeletFunction in the given record.
|
pure virtualinherited |