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:

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
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...
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...
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
	Compare the FunctorKey for equality with another, using the underlying Ixx, Iyy, Ixy Keys. More...
QuadrupoleKey	getCore () const noexcept
	Return constituent FunctorKeys. More...
PointKey< double >	getCenter () const noexcept
	Return constituent FunctorKeys. More...

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

using lsst::afw::table::FunctorKey< lsst::afw::geom::ellipses::Ellipse >::Value = lsst::afw::geom::ellipses::Ellipse

inherited

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.

: _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.

: _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.

: _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]	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.

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

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.

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

getCenter()

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

inlinenoexcept

Return constituent FunctorKeys.

Definition at line 423 of file aggregates.h.

{ return _pKey; }

getCore()

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

inlinenoexcept

Return constituent FunctorKeys.

Definition at line 422 of file aggregates.h.

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

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

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.

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

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

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

operator=() [1/2]

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

defaultnoexcept

operator=() [2/2]

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

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.

                                                            {
        return _qKey == other._qKey && _pKey == other._pKey;
    }

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.

                                                                               {
    _qKey.set(record, value.getCore());
    _pKey.set(record, value.getCenter());
}

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/afw/19.0.0-4-ga671dab3b+1/include/lsst/afw/table/aggregates.h
• /j/snowflake/release/lsstsw/stack/Linux64/afw/19.0.0-4-ga671dab3b+1/src/table/aggregates.cc