LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
LSST Data Management Base Package
Loading...
Searching...
No Matches
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< lsst::afw::geom::ellipses::Quadrupole > lsst::afw::table::InputFunctorKey< lsst::afw::geom::ellipses::Quadrupole >

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< double > getIxx () const noexcept
 Return a constituent Key.
 
Key< double > getIyy () const noexcept
 
Key< double > getIxy () const noexcept
 
virtual void set (BaseRecord &record, lsst::afw::geom::ellipses::Quadrupole const &value) const=0
 
virtual void set (BaseRecord &record, lsst::afw::geom::ellipses::Quadrupole 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< lsst::afw::geom::ellipses::Quadrupole >.

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 cpputils::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(); }

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

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

◆ set() [2/3]

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

◆ set() [3/3]

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}

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