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>
|
| 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 |
|
EllipseKey & | operator= (EllipseKey const &) noexcept=default |
|
EllipseKey & | operator= (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 |
|
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.
◆ Value
The data type for get and set.
Definition at line 77 of file FunctorKey.h.
◆ 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.
◆ EllipseKey() [2/5]
Construct from individual Keys.
Definition at line 379 of file aggregates.h.
◆ 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.
◆ 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 |
◆ addFields()
Add a set of _xx, _yy, _xy, _x, _y fields to a Schema, and return an EllipseKey that points to them.
- Parameters
-
[in,out] | schema | Schema to add fields to. |
[in] | name | Name prefix for all fields; "_xx", "_yy", "_xy", "_x" ,"_y", will be appended to this to form the full field names. |
[in] | doc | String used as the documentation for the fields. |
[in] | unit | String 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.
◆ get()
◆ getCenter()
PointKey< double > lsst::afw::table::EllipseKey::getCenter |
( |
| ) |
const |
|
inlinenoexcept |
◆ getCore()
Return constituent FunctorKeys.
Definition at line 422 of file aggregates.h.
◆ hash_value()
std::size_t lsst::afw::table::EllipseKey::hash_value |
( |
| ) |
const |
|
inlinenoexcept |
◆ 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.
◆ operator!=()
bool lsst::afw::table::EllipseKey::operator!= |
( |
EllipseKey const & |
other | ) |
const |
|
inlinenoexcept |
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ 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.
◆ set()
The documentation for this class was generated from the following files: