LSSTApplications  10.0-2-g4f67435,11.0.rc2+1,11.0.rc2+12,11.0.rc2+3,11.0.rc2+4,11.0.rc2+5,11.0.rc2+6,11.0.rc2+7,11.0.rc2+8
LSSTDataManagementBasePackage
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
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:
lsst.afw.table::FunctorKey< lsst::afw::geom::ellipses::Quadrupole > lsst.afw.table::OutputFunctorKey< lsst::afw::geom::ellipses::Quadrupole > lsst.afw.table::InputFunctorKey< lsst::afw::geom::ellipses::Quadrupole >

Public Member Functions

 QuadrupoleKey ()
 Default constructor; instance will not be usable unless subsequently assigned to. More...
 
 QuadrupoleKey (Key< double > const &ixx, Key< double > const &iyy, Key< double > const &ixy)
 Construct from individual Keys. More...
 
 QuadrupoleKey (SubSchema const &s)
 Construct from a subschema with appropriate 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, CoordinateType coordType=CoordinateType::PIXEL)
 

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 a tuple of constituent Keys.

Definition at line 188 of file aggregates.h.

Constructor & Destructor Documentation

lsst.afw.table::QuadrupoleKey::QuadrupoleKey ( )
inline

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

Definition at line 210 of file aggregates.h.

210 : _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 213 of file aggregates.h.

213  :
214  _ixx(ixx), _iyy(iyy), _ixy(ixy)
215  {}
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 227 of file aggregates.h.

227 : _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,
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]schemaSchema to add fields to.
[in]nameName 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]docString used as the documentation for the fields.
[in]coordTypeType of coordinates in use (PIXEL or CELESTIAL).
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 248 of file aggregates.h.

248 { return _ixx; }
Key<double> lsst.afw.table::QuadrupoleKey::getIxy ( ) const
inline

Return a constituent Key.

Definition at line 250 of file aggregates.h.

250 { return _ixy; }
Key<double> lsst.afw.table::QuadrupoleKey::getIyy ( ) const
inline

Return a constituent Key.

Definition at line 249 of file aggregates.h.

249 { return _iyy; }
bool lsst.afw.table::QuadrupoleKey::isValid ( ) const
inline

Return True if all the constituent Keys are valid.

Definition at line 244 of file aggregates.h.

244 { return _ixx.isValid() && _iyy.isValid() && _ixy.isValid(); }
bool isValid() const
Return true if the key was initialized to valid offset.
Definition: Key.h:83
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 240 of file aggregates.h.

240 { 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 237 of file aggregates.h.

237  {
238  return _ixx == other._ixx && _iyy == other._iyy && _ixy == other._ixy;
239  }
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 254 of file aggregates.h.

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

Definition at line 256 of file aggregates.h.

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

Definition at line 255 of file aggregates.h.


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