lsst::afw::table::QuadrupoleKey Class Reference

A FunctorKey used to get or set a geom::ellipses::Quadrupole from a tuple of constituent Keys. More...

#include <aggregates.h>

Inheritance diagram for lsst::afw::table::QuadrupoleKey:

Public Types
using	Value
	The data type for get and set.

Public Member Functions
	QuadrupoleKey () noexcept
	Default constructor; instance will not be usable unless subsequently assigned to.
	QuadrupoleKey (Key< double > const &ixx, Key< double > const &iyy, Key< double > const &ixy) noexcept
	Construct from individual Keys.
	QuadrupoleKey (SubSchema const &s)
	Construct from a subschema with appropriate subfields.
	QuadrupoleKey (QuadrupoleKey const &) noexcept=default
	QuadrupoleKey (QuadrupoleKey &&) noexcept=default
QuadrupoleKey &	operator= (QuadrupoleKey const &) noexcept=default
QuadrupoleKey &	operator= (QuadrupoleKey &&) noexcept=default
	~QuadrupoleKey () noexcept override=default
geom::ellipses::Quadrupole	get (BaseRecord const &record) const override
	Get a Quadrupole from the given record.
void	set (BaseRecord &record, geom::ellipses::Quadrupole const &value) const override
	Set a Quadrupole in the given record.
bool	operator== (QuadrupoleKey const &other) const noexcept
	Compare the FunctorKey for equality with another, using the underlying Ixx, Iyy, Ixy Keys.
bool	operator!= (QuadrupoleKey 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.
Key< double >	getIxx () const noexcept
	Return a constituent Key.
Key< double >	getIyy () const noexcept
Key< double >	getIxy () const noexcept
virtual void	set (BaseRecord &record, lsst::afw::geom::ellipses::Quadrupole const &value) const=0
virtual void	set (BaseRecord &record, lsst::afw::geom::ellipses::Quadrupole const &value) const=0

Static Public Member Functions
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.

Detailed Description

A FunctorKey used to get or set a geom::ellipses::Quadrupole from a tuple of constituent Keys.

Definition at line 369 of file aggregates.h.

Member Typedef Documentation

Value

using lsst::afw::table::FunctorKey< lsst::afw::geom::ellipses::Quadrupole >::Value

inherited

The data type for get and set.

Definition at line 77 of file FunctorKey.h.

Constructor & Destructor Documentation

QuadrupoleKey() [1/5]

lsst::afw::table::QuadrupoleKey::QuadrupoleKey ( )

inlinenoexcept

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

Definition at line 386 of file aggregates.h.

: _ixx(), _iyy(), _ixy() {}

QuadrupoleKey() [2/5]

lsst::afw::table::QuadrupoleKey::QuadrupoleKey ( Key< double > const & ixx, Key< double > const & iyy, Key< double > const & ixy )

inlinenoexcept

Construct from individual Keys.

Definition at line 389 of file aggregates.h.

            : _ixx(ixx), _iyy(iyy), _ixy(ixy) {}

QuadrupoleKey() [3/5]

lsst::afw::table::QuadrupoleKey::QuadrupoleKey ( SubSchema const & s )

inline

Construct from a subschema with appropriate subfields.

If the schema has "a_xx", "a_yy" and "a_xy" fields this constructor enables you to construct a QuadrupoleKey via:

QuadrupoleKey k(schema["a"], coordType);

Definition at line 400 of file aggregates.h.

: _ixx(s["xx"]), _iyy(s["yy"]), _ixy(s["xy"]) {}

QuadrupoleKey() [4/5]

lsst::afw::table::QuadrupoleKey::QuadrupoleKey ( QuadrupoleKey const & )

defaultnoexcept

QuadrupoleKey() [5/5]

lsst::afw::table::QuadrupoleKey::QuadrupoleKey ( QuadrupoleKey && )

defaultnoexcept

~QuadrupoleKey()

lsst::afw::table::QuadrupoleKey::~QuadrupoleKey ( )

overridedefaultnoexcept

Member Function Documentation

addFields()

QuadrupoleKey lsst::afw::table::QuadrupoleKey::addFields ( Schema & schema, std::string const & name, std::string const & doc, CoordinateType coordType = CoordinateType::PIXEL )

static

Add a set of quadrupole subfields to a schema and return a QuadrupoleKey that points to them.

Parameters

[in,out]	schema	Schema to add fields to.
[in]	name	Name prefix for all fields; ("_xx", "_yy", "_xy") will be appended to this to form the full field names. In celestial coordinates, we use "x" as a synonym for "RA" and "y" for "dec".
[in]	doc	String used as the documentation for the fields.
[in]	coordType	Type of coordinates in use (PIXEL or CELESTIAL).

Definition at line 134 of file aggregates.cc.

                                                                 {
    std::string unit = coordType == CoordinateType::PIXEL ? "pixel^2" : "rad^2";
 
    Key<double> xxKey = schema.addField<double>(schema.join(name, "xx"), doc, unit);
    Key<double> yyKey = schema.addField<double>(schema.join(name, "yy"), doc, unit);
    Key<double> xyKey = schema.addField<double>(schema.join(name, "xy"), doc, unit);
    return QuadrupoleKey(xxKey, yyKey, xyKey);
}

get()

geom::ellipses::Quadrupole lsst::afw::table::QuadrupoleKey::get ( BaseRecord const & record ) const

overridevirtual

Get a Quadrupole from the given record.

Implements lsst::afw::table::OutputFunctorKey< lsst::afw::geom::ellipses::Quadrupole >.

Definition at line 144 of file aggregates.cc.

                                                                        {
    return geom::ellipses::Quadrupole(record.get(_ixx), record.get(_iyy), record.get(_ixy));
}

getIxx()

Key< double > lsst::afw::table::QuadrupoleKey::getIxx ( ) const

inlinenoexcept

Return a constituent Key.

Definition at line 433 of file aggregates.h.

{ return _ixx; }

getIxy()

Key< double > lsst::afw::table::QuadrupoleKey::getIxy ( ) const

inlinenoexcept

Definition at line 435 of file aggregates.h.

{ return _ixy; }

getIyy()

Key< double > lsst::afw::table::QuadrupoleKey::getIyy ( ) const

inlinenoexcept

Definition at line 434 of file aggregates.h.

{ return _iyy; }

hash_value()

std::size_t lsst::afw::table::QuadrupoleKey::hash_value ( ) const

inlinenoexcept

Return a hash of this object.

Definition at line 423 of file aggregates.h.

                                          {
        // Completely arbitrary seed
        return cpputils::hashCombine(17, _ixx, _iyy, _ixy);
    }

isValid()

bool lsst::afw::table::QuadrupoleKey::isValid ( ) const

inlinenoexcept

Return True if all the constituent Keys are valid.

Definition at line 429 of file aggregates.h.

{ return _ixx.isValid() && _iyy.isValid() && _ixy.isValid(); }

operator!=()

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

inlinenoexcept

Definition at line 419 of file aggregates.h.

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

operator=() [1/2]

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

defaultnoexcept

operator=() [2/2]

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

defaultnoexcept

operator==()

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

inlinenoexcept

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

Definition at line 416 of file aggregates.h.

                                                               {
        return _ixx == other._ixx && _iyy == other._iyy && _ixy == other._ixy;
    }

set() [1/3]

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

pure virtualinherited

set() [2/3]

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

pure virtualinherited

set() [3/3]

void lsst::afw::table::QuadrupoleKey::set ( BaseRecord & record, geom::ellipses::Quadrupole const & value ) const

override

Set a Quadrupole in the given record.

Definition at line 148 of file aggregates.cc.

                                                                                     {
    record.set(_ixx, value.getIxx());
    record.set(_iyy, value.getIyy());
    record.set(_ixy, value.getIxy());
}

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/afw/g083dd6704c+2e189452a7/include/lsst/afw/table/aggregates.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/afw/g083dd6704c+2e189452a7/src/table/aggregates.cc