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::ShapeletFunctionKey Class Referenceabstract

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

#include <FunctorKeys.h>

Inheritance diagram for lsst::shapelet::ShapeletFunctionKey:
lsst::afw::table::FunctorKey< ShapeletFunction > lsst::afw::table::OutputFunctorKey< ShapeletFunction > lsst::afw::table::InputFunctorKey< ShapeletFunction >

Public Types

using Value
 The data type for get and set.
 

Public Member Functions

 ShapeletFunctionKey ()
 Default constructor; instance will not be usuable unless subsequently assigned to.
 
 ShapeletFunctionKey (afw::table::EllipseKey const &ellipse, afw::table::ArrayKey< double > const &coefficients, BasisTypeEnum basisType=HERMITE)
 Construct from individual Keys/FunctorKeys.
 
 ShapeletFunctionKey (afw::table::SubSchema const &s, BasisTypeEnum basisType=HERMITE)
 Construct from a subschema, assuming the necesary subfields.
 
virtual ShapeletFunction get (afw::table::BaseRecord const &record) const
 Get a ShapeletFunction from the given record.
 
virtual void set (afw::table::BaseRecord &record, ShapeletFunction const &value) const
 Set a ShapeletFunction in the given record.
 
bool operator== (ShapeletFunctionKey const &other) const
 Compare the FunctorKey for equality with another, using the underlying Ixx, Iyy, Ixy Keys.
 
bool operator!= (ShapeletFunctionKey const &other) const
 
bool isValid () const
 Return True if all the constituent Keys are valid.
 
afw::table::EllipseKey const & getEllipse () const
 Return a FunctorKey that extracts just the Ellipse.
 
afw::table::ArrayKey< double > const & getCoefficients () const
 Return a FunctorKey that extracts just the coefficients.
 
int getOrder () const
 Return the shapelet order.
 
BasisTypeEnum getBasisType () const
 Return the type of the shapelet basis.
 
virtual void set (BaseRecord &record, ShapeletFunction const &value) const=0
 
virtual void set (BaseRecord &record, ShapeletFunction const &value) const=0
 

Static Public Member Functions

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

Detailed Description

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

A ShapeletFunctionKey manages a set of fields with a common prefix and the following suffixes:

  • "x", "y", "xx", "yy", "xy": ellipse
  • "0", "1", "2", ...: coefficients.

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

Definition at line 45 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

◆ ShapeletFunctionKey() [1/3]

lsst::shapelet::ShapeletFunctionKey::ShapeletFunctionKey ( )
inline

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

Definition at line 74 of file FunctorKeys.h.

74: _ellipseKey(), _coefficientsKey(), _order(-1), _basisType(HERMITE) {}
@ HERMITE
Cartesian shapelets or Gauss-Hermite functions, as defined in Refregier, 2003.
Definition constants.h:53

◆ ShapeletFunctionKey() [2/3]

lsst::shapelet::ShapeletFunctionKey::ShapeletFunctionKey ( afw::table::EllipseKey const & ellipse,
afw::table::ArrayKey< double > const & coefficients,
BasisTypeEnum basisType = HERMITE )
inline

Construct from individual Keys/FunctorKeys.

Definition at line 77 of file FunctorKeys.h.

81 :
82 _ellipseKey(ellipse),
83 _coefficientsKey(coefficients),
84 _order(computeOrder(coefficients.getSize())),
85 _basisType(basisType)
86 {}
int computeOrder(int size)
Infer the order of a shapelet expansion from the number of coefficients.
Definition constants.h:104

◆ ShapeletFunctionKey() [3/3]

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

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"]);
ShapeletFunctionKey()
Default constructor; instance will not be usuable unless subsequently assigned to.
Definition FunctorKeys.h:74

Definition at line 97 of file FunctorKeys.h.

97 :
98 _ellipseKey(s), _coefficientsKey(s),
99 _order(computeOrder(_coefficientsKey.getSize())),
100 _basisType(basisType)
101 {}

Member Function Documentation

◆ addFields()

static ShapeletFunctionKey lsst::shapelet::ShapeletFunctionKey::addFields ( afw::table::Schema & schema,
std::string const & name,
std::string const & doc,
std::string const & ellipseUnit,
std::string const & coeffUnit,
int order,
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]orderOrder of the ShapeletFunction 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 ShapeletFunction lsst::shapelet::ShapeletFunctionKey::get ( afw::table::BaseRecord const & record) const
virtual

◆ getBasisType()

BasisTypeEnum lsst::shapelet::ShapeletFunctionKey::getBasisType ( ) const
inline

Return the type of the shapelet basis.

Definition at line 131 of file FunctorKeys.h.

131{ return _basisType; }

◆ getCoefficients()

afw::table::ArrayKey< double > const & lsst::shapelet::ShapeletFunctionKey::getCoefficients ( ) const
inline

Return a FunctorKey that extracts just the coefficients.

Definition at line 125 of file FunctorKeys.h.

125{ return _coefficientsKey; }

◆ getEllipse()

afw::table::EllipseKey const & lsst::shapelet::ShapeletFunctionKey::getEllipse ( ) const
inline

Return a FunctorKey that extracts just the Ellipse.

Definition at line 122 of file FunctorKeys.h.

122{ return _ellipseKey; }

◆ getOrder()

int lsst::shapelet::ShapeletFunctionKey::getOrder ( ) const
inline

Return the shapelet order.

Definition at line 128 of file FunctorKeys.h.

128{ return _order; }

◆ isValid()

bool lsst::shapelet::ShapeletFunctionKey::isValid ( ) const
inline

Return True if all the constituent Keys are valid.

Definition at line 119 of file FunctorKeys.h.

119{ return _ellipseKey.isValid() && _coefficientsKey.isValid(); }

◆ operator!=()

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

Definition at line 115 of file FunctorKeys.h.

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

◆ operator==()

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

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

Definition at line 111 of file FunctorKeys.h.

111 {
112 return _order == other._order && _ellipseKey == other._ellipseKey
113 && _coefficientsKey == other._coefficientsKey;
114 }

◆ set() [1/3]

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

◆ set() [2/3]

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

◆ set() [3/3]

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

Set a ShapeletFunction in the given record.


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