LSST Applications g013ef56533+7c9321ec0f,g042eb84c57+c6cfa41bc3,g199a45376c+0ba108daf9,g1fd858c14a+fcad0d0313,g210f2d0738+c0f94c6586,g262e1987ae+a7e710680e,g29ae962dfc+fb55f2edb0,g2ac17093b6+61d6563b1e,g2b1d02342f+df6f932764,g2cef7863aa+aef1011c0b,g2f7ad74990+c0f94c6586,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53cf87ae69,g47891489e3+4316d04fff,g511e8cfd20+baa56acf6c,g53246c7159+8c5ae1fdc5,g54cd7ddccb+fd7ad03fde,g64539dfbff+c0f94c6586,g67b6fd64d1+4316d04fff,g67fd3c3899+c0f94c6586,g6985122a63+4316d04fff,g74acd417e5+ca833bee28,g786e29fd12+668abc6043,g81db2e9a8d+b2ec8e584f,g87389fa792+8856018cbb,g89139ef638+4316d04fff,g8d7436a09f+0a24083b20,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+11eb8fd5b8,gbf99507273+8c5ae1fdc5,gcdda8b9158+e4c84c9d5c,gce8aa8abaa+8c5ae1fdc5,gd7ef33dd92+4316d04fff,gdab6d2f7ff+ca833bee28,ge410e46f29+4316d04fff,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.40
LSST Data Management Base Package
Loading...
Searching...
No Matches
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
 The data type for get and set.
 

Public Member Functions

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

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:

  • "<prefix>_0_xx"
  • "<prefix>_0_yy"
  • "<prefix>_0_xy"
  • "<prefix>_0_x"
  • "<prefix>_0_y"
  • "<prefix>_1_xx"
  • "<prefix>_1_yy"
  • "<prefix>_1_xy"
  • "<prefix>_1_x"
  • "<prefix>_1_y"

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 {}

◆ 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"]);
Class that maps ShapeletFunction objects to fields in afw::table objects.
Definition FunctorKeys.h:45

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]

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/3]

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

◆ set() [2/3]

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

◆ set() [3/3]

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

Set a MultiShapeletFunction in the given record.


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