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

A FunctorKey used to get or set a geom::ellipses::Quadrupole from an (xx,yy,xy) tuple of Keys. More...

#include <aggregates.h>

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

Public Member Functions
	QuadrupoleKey ()
	Default constructor; instance will not be usuable unless subsequently assigned to. More...
	QuadrupoleKey (Key< double > const &ixx, Key< double > const &iyy, Key< double > const &ixy)
	Construct from individual Keys. More...
	QuadrupoleKey (Key< Moments< double > > const &other)
	QuadrupoleKey (SubSchema const &s)
	Construct from a subschema, assuming xx, yy, and xy subfields. More...
virtual geom::ellipses::Quadrupole	get (BaseRecord const &record) const
	Get a Quadrupole from the given record. More...
virtual void	set (BaseRecord &record, geom::ellipses::Quadrupole const &value) const
	Set a Quadrupole in the given record. More...
bool	isValid () const
	Return True if all the constituent Keys are valid. More...
bool	operator== (QuadrupoleKey const &other) const
	Compare the FunctorKey for equality with another, using the underlying Ixx, Iyy, Ixy Keys. More...
bool	operator!= (QuadrupoleKey const &other) const
	Compare the FunctorKey for equality with another, using the underlying Ixx, Iyy, Ixy Keys. More...
Key< double >	getIxx () const
	Return a constituent Key. More...
Key< double >	getIyy () const
	Return a constituent Key. More...
Key< double >	getIxy () const
	Return a constituent Key. More...
Public Member Functions inherited from lsst::afw::table::OutputFunctorKey< lsst::afw::geom::ellipses::Quadrupole >
virtual	~OutputFunctorKey ()
Public Member Functions inherited from lsst::afw::table::InputFunctorKey< lsst::afw::geom::ellipses::Quadrupole >
virtual	~InputFunctorKey ()

Static Public Member Functions
static QuadrupoleKey	addFields (Schema &schema, std::string const &name, std::string const &doc, std::string const &unit)

Private Attributes
Key< double >	_ixx
Key< double >	_iyy
Key< double >	_ixy

Detailed Description

A FunctorKey used to get or set a geom::ellipses::Quadrupole from an (xx,yy,xy) tuple of Keys.

Definition at line 125 of file aggregates.h.

Constructor & Destructor Documentation

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

inline

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

Definition at line 145 of file aggregates.h.

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

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

inline

Construct from individual Keys.

Definition at line 148 of file aggregates.h.

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

lsst::afw::table::QuadrupoleKey::QuadrupoleKey ( Key< Moments< double > > const &  other )

inlineexplicit

Construct from a compound Key<Moments<double>>

Key<Moments> is now deprecated in favor of QuadrupoleKey; this constructor is intended to aid in the transition.

Definition at line 158 of file aggregates.h.

                                                                 :
        _ixx(other.getIxx()), _iyy(other.getIyy()), _ixy(other.getIxy())
    {}

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

inline

Construct from a subschema, assuming xx, yy, and xy subfields.

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

*  QuadrupoleKey k(schema["a"]);
*  

Definition at line 171 of file aggregates.h.

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

Member Function Documentation

static QuadrupoleKey lsst::afw::table::QuadrupoleKey::addFields ( Schema &  schema, std::string const &  name, std::string const &  doc, std::string const &  unit  )

static

Add a set of _xx, _yy, _xy fields 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]	doc	String used as the documentation for the fields.
[in]	unit	String used as the unit for all fields.

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

virtual

Get a Quadrupole from the given record.

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

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

inline

Return a constituent Key.

Definition at line 192 of file aggregates.h.

{ return _ixx; }

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

inline

Return a constituent Key.

Definition at line 194 of file aggregates.h.

{ return _ixy; }

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

inline

Return a constituent Key.

Definition at line 193 of file aggregates.h.

{ return _iyy; }

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

inline

Return True if all the constituent Keys are valid.

Definition at line 188 of file aggregates.h.

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

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

inline

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

Definition at line 184 of file aggregates.h.

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

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

inline

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

Definition at line 181 of file aggregates.h.

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

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

virtual

Set a Quadrupole in the given record.

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

Member Data Documentation

Key<double> lsst::afw::table::QuadrupoleKey::_ixx

private

Definition at line 198 of file aggregates.h.

Key<double> lsst::afw::table::QuadrupoleKey::_ixy

private

Definition at line 200 of file aggregates.h.

Key<double> lsst::afw::table::QuadrupoleKey::_iyy

private

Definition at line 199 of file aggregates.h.

---

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

• /lsst/home/lsstsw/stack/Linux64/afw/master-gae20e2b580+3/include/lsst/afw/table/aggregates.h