LSST Applications g0265f82a02+093ff98f47,g02d81e74bb+10352d6f39,g1f3e9fa97e+40b0fc677d,g2079a07aa2+14824f138e,g2bbee38e9b+093ff98f47,g337abbeb29+093ff98f47,g3ddfee87b4+064c02c7ee,g487adcacf7+7e842ebf4b,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g568d43a26c+1d7ac31cb0,g591dd9f2cf+fb1f69e2ea,g858d7b2824+10352d6f39,g8a8a8dda67+a6fc98d2e7,g8cdfe0ae6a+66d966b544,g99cad8db69+7ce8a7c20a,g9ddcbc5298+d4bad12328,ga1e77700b3+246acaaf9c,ga2e4dd1c03+064c02c7ee,ga8c6da7877+04f6ba86dc,gae46bcf261+093ff98f47,gb0e22166c9+3863383f4c,gba4ed39666+9664299f35,gbb8dafda3b+db40f59a7d,gbeb006f7da+e6a448e96d,gbf5cecdb8a+10352d6f39,gc0f3af6251+10a3fd39cd,gc120e1dc64+5839e50a77,gc28159a63d+093ff98f47,gcf0d15dbbd+064c02c7ee,gd2a12a3803+0c2c227a2b,gdaeeff99f8+a38ce5ea23,ge79ae78c31+093ff98f47,gee10cc3b42+a6fc98d2e7,gf1cff7945b+10352d6f39,w.2024.15
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | List of all members
lsst::afw::table::QuadrupoleKey Class Referenceabstract

A FunctorKey used to get or set a geom::ellipses::Quadrupole from a tuple of constituent Keys. More...

#include <aggregates.h>

Inheritance diagram for lsst::afw::table::QuadrupoleKey:
lsst::afw::table::FunctorKey< lsst::afw::geom::ellipses::Quadrupole > lsst::afw::table::OutputFunctorKey< T > lsst::afw::table::InputFunctorKey< T >

Public Types

using Value
 The data type for get and set.
 

Public Member Functions

 QuadrupoleKey () noexcept
 Default constructor; instance will not be usable unless subsequently assigned to.
 
 QuadrupoleKey (Key< double > const &ixx, Key< double > const &iyy, Key< double > const &ixy) noexcept
 Construct from individual Keys.
 
 QuadrupoleKey (SubSchema const &s)
 Construct from a subschema with appropriate subfields.
 
 QuadrupoleKey (QuadrupoleKey const &) noexcept=default
 
 QuadrupoleKey (QuadrupoleKey &&) noexcept=default
 
QuadrupoleKeyoperator= (QuadrupoleKey const &) noexcept=default
 
QuadrupoleKeyoperator= (QuadrupoleKey &&) noexcept=default
 
 ~QuadrupoleKey () noexcept override=default
 
geom::ellipses::Quadrupole get (BaseRecord const &record) const override
 Get a Quadrupole from the given record.
 
void set (BaseRecord &record, geom::ellipses::Quadrupole const &value) const override
 Set a Quadrupole in the given record.
 
bool operator== (QuadrupoleKey const &other) const noexcept
 Compare the FunctorKey for equality with another, using the underlying Ixx, Iyy, Ixy Keys.
 
bool operator!= (QuadrupoleKey const &other) const noexcept
 
std::size_t hash_value () const noexcept
 Return a hash of this object.
 
bool isValid () const noexcept
 Return True if all the constituent Keys are valid.
 
Key< doublegetIxx () const noexcept
 Return a constituent Key.
 
Key< doublegetIyy () const noexcept
 
Key< doublegetIxy () const noexcept
 
virtual void set (BaseRecord &record, T const &value) const =0
 

Static Public Member Functions

static QuadrupoleKey addFields (Schema &schema, std::string const &name, std::string const &doc, CoordinateType coordType=CoordinateType::PIXEL)
 Add a set of quadrupole subfields to a schema and return a QuadrupoleKey that points to them.
 

Detailed Description

A FunctorKey used to get or set a geom::ellipses::Quadrupole from a tuple of constituent Keys.

Definition at line 369 of file aggregates.h.

Member Typedef Documentation

◆ Value

The data type for get and set.

Definition at line 77 of file FunctorKey.h.

Constructor & Destructor Documentation

◆ QuadrupoleKey() [1/5]

lsst::afw::table::QuadrupoleKey::QuadrupoleKey ( )
inlinenoexcept

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

Definition at line 386 of file aggregates.h.

386: _ixx(), _iyy(), _ixy() {}

◆ QuadrupoleKey() [2/5]

lsst::afw::table::QuadrupoleKey::QuadrupoleKey ( Key< double > const & ixx,
Key< double > const & iyy,
Key< double > const & ixy )
inlinenoexcept

Construct from individual Keys.

Definition at line 389 of file aggregates.h.

390 : _ixx(ixx), _iyy(iyy), _ixy(ixy) {}

◆ QuadrupoleKey() [3/5]

lsst::afw::table::QuadrupoleKey::QuadrupoleKey ( SubSchema const & s)
inline

Construct from a subschema with appropriate subfields.

If the schema has "a_xx", "a_yy" and "a_xy" fields this constructor enables you to construct a QuadrupoleKey via:

QuadrupoleKey k(schema["a"], coordType);

Definition at line 400 of file aggregates.h.

400: _ixx(s["xx"]), _iyy(s["yy"]), _ixy(s["xy"]) {}

◆ QuadrupoleKey() [4/5]

lsst::afw::table::QuadrupoleKey::QuadrupoleKey ( QuadrupoleKey const & )
defaultnoexcept

◆ QuadrupoleKey() [5/5]

lsst::afw::table::QuadrupoleKey::QuadrupoleKey ( QuadrupoleKey && )
defaultnoexcept

◆ ~QuadrupoleKey()

lsst::afw::table::QuadrupoleKey::~QuadrupoleKey ( )
overridedefaultnoexcept

Member Function Documentation

◆ addFields()

QuadrupoleKey lsst::afw::table::QuadrupoleKey::addFields ( Schema & schema,
std::string const & name,
std::string const & doc,
CoordinateType coordType = CoordinateType::PIXEL )
static

Add a set of quadrupole subfields to a schema and return a QuadrupoleKey that points to them.

Parameters
[in,out]schemaSchema to add fields to.
[in]nameName prefix for all fields; ("_xx", "_yy", "_xy") will be appended to this to form the full field names. In celestial coordinates, we use "x" as a synonym for "RA" and "y" for "dec".
[in]docString used as the documentation for the fields.
[in]coordTypeType of coordinates in use (PIXEL or CELESTIAL).

Definition at line 134 of file aggregates.cc.

135 {
136 std::string unit = coordType == CoordinateType::PIXEL ? "pixel^2" : "rad^2";
137
138 Key<double> xxKey = schema.addField<double>(schema.join(name, "xx"), doc, unit);
139 Key<double> yyKey = schema.addField<double>(schema.join(name, "yy"), doc, unit);
140 Key<double> xyKey = schema.addField<double>(schema.join(name, "xy"), doc, unit);
141 return QuadrupoleKey(xxKey, yyKey, xyKey);
142}
QuadrupoleKey() noexcept
Default constructor; instance will not be usable unless subsequently assigned to.
Definition aggregates.h:386

◆ get()

geom::ellipses::Quadrupole lsst::afw::table::QuadrupoleKey::get ( BaseRecord const & record) const
overridevirtual

Get a Quadrupole from the given record.

Implements lsst::afw::table::OutputFunctorKey< T >.

Definition at line 144 of file aggregates.cc.

144 {
145 return geom::ellipses::Quadrupole(record.get(_ixx), record.get(_iyy), record.get(_ixy));
146}

◆ getIxx()

Key< double > lsst::afw::table::QuadrupoleKey::getIxx ( ) const
inlinenoexcept

Return a constituent Key.

Definition at line 433 of file aggregates.h.

433{ return _ixx; }

◆ getIxy()

Key< double > lsst::afw::table::QuadrupoleKey::getIxy ( ) const
inlinenoexcept

Definition at line 435 of file aggregates.h.

435{ return _ixy; }

◆ getIyy()

Key< double > lsst::afw::table::QuadrupoleKey::getIyy ( ) const
inlinenoexcept

Definition at line 434 of file aggregates.h.

434{ return _iyy; }

◆ hash_value()

std::size_t lsst::afw::table::QuadrupoleKey::hash_value ( ) const
inlinenoexcept

Return a hash of this object.

Definition at line 423 of file aggregates.h.

423 {
424 // Completely arbitrary seed
425 return utils::hashCombine(17, _ixx, _iyy, _ixy);
426 }
std::size_t hashCombine(std::size_t seed) noexcept
Combine hashes.
Definition hashCombine.h:35

◆ isValid()

bool lsst::afw::table::QuadrupoleKey::isValid ( ) const
inlinenoexcept

Return True if all the constituent Keys are valid.

Definition at line 429 of file aggregates.h.

429{ return _ixx.isValid() && _iyy.isValid() && _ixy.isValid(); }
bool isValid() const noexcept
Return true if the key was initialized to valid offset.
Definition Key.h:97

◆ operator!=()

bool lsst::afw::table::QuadrupoleKey::operator!= ( QuadrupoleKey const & other) const
inlinenoexcept

Definition at line 419 of file aggregates.h.

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

◆ operator=() [1/2]

QuadrupoleKey & lsst::afw::table::QuadrupoleKey::operator= ( QuadrupoleKey && )
defaultnoexcept

◆ operator=() [2/2]

QuadrupoleKey & lsst::afw::table::QuadrupoleKey::operator= ( QuadrupoleKey const & )
defaultnoexcept

◆ operator==()

bool lsst::afw::table::QuadrupoleKey::operator== ( QuadrupoleKey const & other) const
inlinenoexcept

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

Definition at line 416 of file aggregates.h.

416 {
417 return _ixx == other._ixx && _iyy == other._iyy && _ixy == other._ixy;
418 }

◆ set() [1/2]

void lsst::afw::table::QuadrupoleKey::set ( BaseRecord & record,
geom::ellipses::Quadrupole const & value ) const
override

Set a Quadrupole in the given record.

Definition at line 148 of file aggregates.cc.

148 {
149 record.set(_ixx, value.getIxx());
150 record.set(_iyy, value.getIyy());
151 record.set(_ixy, value.getIxy());
152}

◆ set() [2/2]

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

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