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::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< lsst::afw::geom::ellipses::Ellipse > lsst::afw::table::InputFunctorKey< lsst::afw::geom::ellipses::Ellipse >

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< double > getCenter () const noexcept
 
virtual void set (BaseRecord &record, lsst::afw::geom::ellipses::Ellipse const &value) const=0
 
virtual void set (BaseRecord &record, lsst::afw::geom::ellipses::Ellipse 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< lsst::afw::geom::ellipses::Ellipse >.

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

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

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}

◆ set() [2/3]

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

◆ set() [3/3]

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

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