Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04a91732dc+a777afbe81,g07dc498a13+7e3c5f68a2,g12483e3c20+0145ec33cd,g1409bbee79+7e3c5f68a2,g1a7e361dbc+7e3c5f68a2,g1fd858c14a+9f35e23ec3,g35bb328faa+fcb1d3bbc8,g3ad4f90e5c+0145ec33cd,g3bd4b5ce2c+cbf1bea503,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g5477a8d5ce+db04660fe6,g60b5630c4e+0145ec33cd,g623d845a50+0145ec33cd,g6f0c2978f1+3526b51a37,g75b6c65c88+d54b601591,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+4639f750a5,g89139ef638+7e3c5f68a2,g9125e01d80+fcb1d3bbc8,g919ac25b3e+6220c5324a,g95236ca021+f7a31438ed,g989de1cb63+7e3c5f68a2,g9f33ca652e+2d6fa11d35,gaaedd4e678+7e3c5f68a2,gabe3b4be73+1e0a283bba,gb1101e3267+4a428ef779,gb4a253aaf5+0122250889,gb58c049af0+f03b321e39,gc99c83e5f0+76d20ab76d,gcf25f946ba+4639f750a5,gd6cbbdb0b4+c8606af20c,gde0f65d7ad+3d8a3b7e46,ge278dab8ac+932305ba37,gf795337580+03b96afe58,gfba249425e+fcb1d3bbc8,w.2025.08
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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: