LSSTApplications  19.0.0-10-g920eed2,19.0.0-11-g48a0200+2,19.0.0-18-gfc4e62b+10,19.0.0-2-g3b2f90d+2,19.0.0-2-gd671419+5,19.0.0-20-g5a5a17ab+8,19.0.0-21-g2644856+10,19.0.0-22-gc5dc5b1+5,19.0.0-23-gdc29a50+2,19.0.0-24-g923e380+10,19.0.0-25-g6c8df7140,19.0.0-27-g567f04d+6,19.0.0-3-g2b32d65+5,19.0.0-3-g8227491+9,19.0.0-3-g9c54d0d+9,19.0.0-3-gca68e65+5,19.0.0-3-gcfc5f51+5,19.0.0-3-ge110943+8,19.0.0-3-ge74d124,19.0.0-3-gfe04aa6+10,19.0.0-4-g06f5963+5,19.0.0-4-g3d16501+10,19.0.0-4-g4a9c019+5,19.0.0-4-g5a8b323,19.0.0-4-g66397f0+1,19.0.0-4-g8278b9b+1,19.0.0-4-g8557e14,19.0.0-4-g8964aba+10,19.0.0-4-ge404a01+9,19.0.0-5-g40f3a5a,19.0.0-5-g4db63b3,19.0.0-5-gfb03ce7+10,19.0.0-6-gbaebbfb+9,19.0.0-60-gafafd468+10,19.0.0-64-gf672fef+7,19.0.0-7-g039c0b5+8,19.0.0-7-gbea9075+4,19.0.0-7-gc567de5+10,19.0.0-8-g3a3ce09+5,19.0.0-9-g463f923+9,w.2020.21
LSSTDataManagementBasePackage
Public Types | Public Member Functions | Static Public Member Functions | List of all members
lsst::afw::table::EllipseKey Class Reference

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 = lsst::afw::geom::ellipses::Ellipse
 The data type for get and set. More...
 

Public Member Functions

 EllipseKey () noexcept
 Default constructor; instance will not be usable unless subsequently assigned to. More...
 
 EllipseKey (QuadrupoleKey const &qKey, PointKey< double > const &pKey) noexcept
 Construct from individual Keys. More...
 
 EllipseKey (SubSchema const &s)
 Construct from a subschema, assuming (xx, yy, xy, x, y) subfields. More...
 
 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. More...
 
void set (BaseRecord &record, geom::ellipses::Ellipse const &value) const override
 Set an Ellipse in the given record. More...
 
bool operator== (EllipseKey const &other) const noexcept
 Compare the FunctorKey for equality with another, using the underlying Ixx, Iyy, Ixy Keys. More...
 
bool operator!= (EllipseKey const &other) const noexcept
 
std::size_t hash_value () const noexcept
 Return a hash of this object. More...
 
bool isValid () const noexcept
 Return True if all the constituent Keys are valid. More...
 
QuadrupoleKey getCore () const noexcept
 Return constituent FunctorKeys. More...
 
PointKey< double > getCenter () const noexcept
 

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. More...
 

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 360 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 376 of file aggregates.h.

376 : _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 379 of file aggregates.h.

379 : _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 389 of file aggregates.h.

389 : _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 122 of file aggregates.cc.

123  {
124  QuadrupoleKey qKey = QuadrupoleKey::addFields(schema, name, doc, CoordinateType::PIXEL);
125  PointKey<double> pKey = PointKey<double>::addFields(schema, name, doc, unit);
126  return EllipseKey(qKey, pKey);
127 }

◆ 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 129 of file aggregates.cc.

129  {
130  return geom::ellipses::Ellipse(record.get(_qKey), record.get(_pKey));
131 }

◆ getCenter()

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

Definition at line 423 of file aggregates.h.

423 { return _pKey; }

◆ getCore()

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

Return constituent FunctorKeys.

Definition at line 422 of file aggregates.h.

422 { return _qKey; }

◆ hash_value()

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

Return a hash of this object.

Definition at line 412 of file aggregates.h.

412  {
413  // Completely arbitrary seed
414  return utils::hashCombine(17, _qKey, _pKey);
415  }

◆ isValid()

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

Return True if all the constituent Keys are valid.

Definition at line 418 of file aggregates.h.

418 { return _qKey.isValid() && _pKey.isValid(); }

◆ operator!=()

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

Definition at line 408 of file aggregates.h.

408 { 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 405 of file aggregates.h.

405  {
406  return _qKey == other._qKey && _pKey == other._pKey;
407  }

◆ set()

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

Set an Ellipse in the given record.

Implements lsst::afw::table::InputFunctorKey< lsst::afw::geom::ellipses::Ellipse >.

Definition at line 133 of file aggregates.cc.

133  {
134  _qKey.set(record, value.getCore());
135  _pKey.set(record, value.getCenter());
136 }

The documentation for this class was generated from the following files:
schema
table::Schema schema
Definition: Amplifier.cc:115
lsst::afw::table::PointKey::set
void set(BaseRecord &record, lsst::geom::Point< T, 2 > const &value) const override
Set a Point in the given record.
Definition: aggregates.cc:49
lsst::afw::table::CoordinateType::PIXEL
@ PIXEL
lsst::afw::table::QuadrupoleKey::set
void set(BaseRecord &record, geom::ellipses::Quadrupole const &value) const override
Set a Quadrupole in the given record.
Definition: aggregates.cc:114
lsst::afw::table::PointKey::addFields
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
lsst::afw::geom.transform.transformContinued.name
string name
Definition: transformContinued.py:32
lsst::afw::table::PointKey::isValid
bool isValid() const noexcept
Return True if both the x and y Keys are valid.
Definition: aggregates.h:104
lsst::afw::table::QuadrupoleKey::addFields
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.
Definition: aggregates.cc:100
other
ItemVariant const * other
Definition: Schema.cc:56
lsst::utils::hashCombine
std::size_t hashCombine(std::size_t seed) noexcept
Combine hashes.
Definition: hashCombine.h:35
lsst::afw::table::EllipseKey::EllipseKey
EllipseKey() noexcept
Default constructor; instance will not be usable unless subsequently assigned to.
Definition: aggregates.h:376
lsst::afw::table::QuadrupoleKey::isValid
bool isValid() const noexcept
Return True if all the constituent Keys are valid.
Definition: aggregates.h:342