LSST Applications g0265f82a02+0e5473021a,g02d81e74bb+0dd8ce4237,g1470d8bcf6+3ea6592b6f,g2079a07aa2+86d27d4dc4,g2305ad1205+5ca4c0b359,g295015adf3+d10818ec9d,g2a9a014e59+6f9be1b9cd,g2bbee38e9b+0e5473021a,g337abbeb29+0e5473021a,g3ddfee87b4+703ba97ebf,g487adcacf7+4fa16da234,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+ffa42b374e,g5a732f18d5+53520f316c,g64a986408d+0dd8ce4237,g858d7b2824+0dd8ce4237,g8a8a8dda67+585e252eca,g99cad8db69+d39438377f,g9ddcbc5298+9a081db1e4,ga1e77700b3+15fc3df1f7,ga8c6da7877+f1d96605c8,gb0e22166c9+60f28cb32d,gb6a65358fc+0e5473021a,gba4ed39666+c2a2e4ac27,gbb8dafda3b+e5339d463f,gc120e1dc64+da31e9920e,gc28159a63d+0e5473021a,gcf0d15dbbd+703ba97ebf,gdaeeff99f8+f9a426f77a,ge6526c86ff+889fc9d533,ge79ae78c31+0e5473021a,gee10cc3b42+585e252eca,gf18bd8381d+7268b93478,gff1a9f87cc+0dd8ce4237,w.2024.16
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::EllipseKey Class Referenceabstract

A FunctorKey used to get or set a geom::ellipses::Ellipse from an (xx,yy,xy,x,y) tuple of Keys. More...

#include <aggregates.h>

Inheritance diagram for lsst::afw::table::EllipseKey:
lsst::afw::table::FunctorKey< lsst::afw::geom::ellipses::Ellipse > lsst::afw::table::OutputFunctorKey< T > lsst::afw::table::InputFunctorKey< T >

Public Types

using Value
 The data type for get and set.
 

Public Member Functions

 EllipseKey () noexcept
 Default constructor; instance will not be usable unless subsequently assigned to.
 
 EllipseKey (QuadrupoleKey const &qKey, PointKey< double > const &pKey) noexcept
 Construct from individual Keys.
 
 EllipseKey (SubSchema const &s)
 Construct from a subschema, assuming (xx, yy, xy, x, y) subfields.
 
 EllipseKey (EllipseKey const &) noexcept=default
 
 EllipseKey (EllipseKey &&) noexcept=default
 
EllipseKeyoperator= (EllipseKey const &) noexcept=default
 
EllipseKeyoperator= (EllipseKey &&) noexcept=default
 
 ~EllipseKey () noexcept override=default
 
geom::ellipses::Ellipse get (BaseRecord const &record) const override
 Get an Ellipse from the given record.
 
void set (BaseRecord &record, geom::ellipses::Ellipse const &value) const override
 Set an Ellipse in the given record.
 
bool operator== (EllipseKey const &other) const noexcept
 Compare the FunctorKey for equality with another, using the underlying Ixx, Iyy, Ixy Keys.
 
bool operator!= (EllipseKey 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.
 
QuadrupoleKey getCore () const noexcept
 Return constituent FunctorKeys.
 
PointKey< doublegetCenter () const noexcept
 
virtual void set (BaseRecord &record, T const &value) const =0
 

Static Public Member Functions

static EllipseKey addFields (Schema &schema, std::string const &name, std::string const &doc, std::string const &unit)
 Add a set of _xx, _yy, _xy, _x, _y fields to a Schema, and return an EllipseKey that points to them.
 

Detailed Description

A FunctorKey used to get or set a geom::ellipses::Ellipse from an (xx,yy,xy,x,y) tuple of Keys.

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

◆ EllipseKey() [1/5]

lsst::afw::table::EllipseKey::EllipseKey ( )
inlinenoexcept

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

Definition at line 463 of file aggregates.h.

463: _qKey(), _pKey() {}

◆ EllipseKey() [2/5]

lsst::afw::table::EllipseKey::EllipseKey ( QuadrupoleKey const & qKey,
PointKey< double > const & pKey )
inlinenoexcept

Construct from individual Keys.

Definition at line 466 of file aggregates.h.

466: _qKey(qKey), _pKey(pKey) {}

◆ EllipseKey() [3/5]

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

Construct from a subschema, assuming (xx, yy, xy, x, y) subfields.

If a schema has "a_xx", "a_yy", "a_xy", "a_x", and "a_y" fields, this constructor allows you to construct an EllipseKey via:

EllipseKey k(schema["a"]);

Definition at line 476 of file aggregates.h.

476: _qKey(s), _pKey(s) {}

◆ EllipseKey() [4/5]

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

◆ EllipseKey() [5/5]

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

◆ ~EllipseKey()

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

Member Function Documentation

◆ addFields()

EllipseKey lsst::afw::table::EllipseKey::addFields ( Schema & schema,
std::string const & name,
std::string const & doc,
std::string const & unit )
static

Add a set of _xx, _yy, _xy, _x, _y fields to a Schema, and return an EllipseKey that points to them.

Parameters
[in,out]schemaSchema to add fields to.
[in]nameName prefix for all fields; "_xx", "_yy", "_xy", "_x" ,"_y", will be appended to this to form the full field names.
[in]docString used as the documentation for the fields.
[in]unitString used as the unit for x and y fields; "<unit>^2" will be used for xx, yy, and xy fields.

Definition at line 156 of file aggregates.cc.

157 {
158 QuadrupoleKey qKey = QuadrupoleKey::addFields(schema, name, doc, CoordinateType::PIXEL);
159 PointKey<double> pKey = PointKey<double>::addFields(schema, name, doc, unit);
160 return EllipseKey(qKey, pKey);
161}
EllipseKey() noexcept
Default constructor; instance will not be usable unless subsequently assigned to.
Definition aggregates.h:463
static PointKey addFields(Schema &schema, std::string const &name, std::string const &doc, std::string const &unit)
Add a pair of _x, _y fields to a Schema, and return a PointKey that points to them.
Definition aggregates.cc:36
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.

◆ get()

geom::ellipses::Ellipse lsst::afw::table::EllipseKey::get ( BaseRecord const & record) const
overridevirtual

Get an Ellipse from the given record.

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

Definition at line 163 of file aggregates.cc.

163 {
164 return geom::ellipses::Ellipse(record.get(_qKey), record.get(_pKey));
165}

◆ getCenter()

PointKey< double > lsst::afw::table::EllipseKey::getCenter ( ) const
inlinenoexcept

Definition at line 510 of file aggregates.h.

510{ return _pKey; }

◆ getCore()

QuadrupoleKey lsst::afw::table::EllipseKey::getCore ( ) const
inlinenoexcept

Return constituent FunctorKeys.

Definition at line 509 of file aggregates.h.

509{ return _qKey; }

◆ hash_value()

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

Return a hash of this object.

Definition at line 499 of file aggregates.h.

499 {
500 // Completely arbitrary seed
501 return utils::hashCombine(17, _qKey, _pKey);
502 }
std::size_t hashCombine(std::size_t seed) noexcept
Combine hashes.
Definition hashCombine.h:35

◆ isValid()

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

Return True if all the constituent Keys are valid.

Definition at line 505 of file aggregates.h.

505{ return _qKey.isValid() && _pKey.isValid(); }
bool isValid() const noexcept
Return True if both the x and y Keys are valid.
Definition aggregates.h:106
bool isValid() const noexcept
Return True if all the constituent Keys are valid.
Definition aggregates.h:429

◆ operator!=()

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

Definition at line 495 of file aggregates.h.

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

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ operator==()

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

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

Definition at line 492 of file aggregates.h.

492 {
493 return _qKey == other._qKey && _pKey == other._pKey;
494 }

◆ set() [1/2]

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

Set an Ellipse in the given record.

Definition at line 167 of file aggregates.cc.

167 {
168 _qKey.set(record, value.getCore());
169 _pKey.set(record, value.getCenter());
170}
void set(BaseRecord &record, lsst::geom::Point< T, 2 > const &value) const override
Set a Point in the given record.
Definition aggregates.cc:49
void set(BaseRecord &record, geom::ellipses::Quadrupole const &value) const override
Set a Quadrupole in the given record.

◆ 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: