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::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:
lsst.afw.table::FunctorKey< lsst::afw::geom::ellipses::Ellipse > lsst.afw.table::OutputFunctorKey< lsst::afw::geom::ellipses::Ellipse > lsst.afw.table::InputFunctorKey< lsst::afw::geom::ellipses::Ellipse >

Public Member Functions

 EllipseKey ()
 Default constructor; instance will not be usable unless subsequently assigned to. More...
 
 EllipseKey (QuadrupoleKey const &qKey, PointKey< double > const &pKey)
 Construct from individual Keys. More...
 
 EllipseKey (SubSchema const &s)
 Construct from a subschema, assuming (xx, yy, xy, x, y) subfields. More...
 
virtual geom::ellipses::Ellipse get (BaseRecord const &record) const
 Get an Ellipse from the given record. More...
 
virtual void set (BaseRecord &record, geom::ellipses::Ellipse const &value) const
 Set an Ellipse in the given record. More...
 
bool isValid () const
 Return True if all the constituent Keys are valid. More...
 
bool operator== (EllipseKey const &other) const
 Compare the FunctorKey for equality with another, using the underlying Ixx, Iyy, Ixy Keys. More...
 
bool operator!= (EllipseKey const &other) const
 Compare the FunctorKey for equality with another, using the underlying Ixx, Iyy, Ixy Keys. More...
 
QuadrupoleKey getCore () const
 Return constituent FunctorKeys. More...
 
PointKey< double > getCenter () const
 Return constituent FunctorKeys. More...
 
- Public Member Functions inherited from lsst.afw.table::OutputFunctorKey< lsst::afw::geom::ellipses::Ellipse >
virtual ~OutputFunctorKey ()
 
- Public Member Functions inherited from lsst.afw.table::InputFunctorKey< lsst::afw::geom::ellipses::Ellipse >
virtual ~InputFunctorKey ()
 

Static Public Member Functions

static EllipseKey addFields (Schema &schema, std::string const &name, std::string const &doc, std::string const &unit)
 

Private Attributes

QuadrupoleKey _qKey
 
PointKey< double > _pKey
 

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

Constructor & Destructor Documentation

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

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

Definition at line 284 of file aggregates.h.

284 : _qKey(), _pKey() {}
PointKey< double > _pKey
Definition: aggregates.h:327
lsst.afw.table::EllipseKey::EllipseKey ( QuadrupoleKey const &  qKey,
PointKey< double > const &  pKey 
)
inline

Construct from individual Keys.

Definition at line 287 of file aggregates.h.

287  :
288  _qKey(qKey), _pKey(pKey)
289  {}
PointKey< double > _pKey
Definition: aggregates.h:327
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 300 of file aggregates.h.

300 : _qKey(s), _pKey(s) {}
PointKey< double > _pKey
Definition: aggregates.h:327

Member Function Documentation

static 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]schemaSchema to add fields to.
[in]nameName prefix for all fields; "_xx", "_yy", "_xy", "_x" ,"_y", will be appended to this to form the full field names.
[in]docString used as the documentation for the fields.
[in]unitString used as the unit for x and y fields; "<unit>^2" will be used for xx, yy, and xy fields.
virtual geom::ellipses::Ellipse lsst.afw.table::EllipseKey::get ( BaseRecord const &  record) const
virtual

Get an Ellipse from the given record.

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

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

Return constituent FunctorKeys.

Definition at line 322 of file aggregates.h.

322 { return _pKey; }
PointKey< double > _pKey
Definition: aggregates.h:327
QuadrupoleKey lsst.afw.table::EllipseKey::getCore ( ) const
inline

Return constituent FunctorKeys.

Definition at line 321 of file aggregates.h.

321 { return _qKey; }
bool lsst.afw.table::EllipseKey::isValid ( ) const
inline

Return True if all the constituent Keys are valid.

Definition at line 317 of file aggregates.h.

317 { return _qKey.isValid() && _pKey.isValid(); }
bool isValid() const
Return True if all the constituent Keys are valid.
Definition: aggregates.h:244
PointKey< double > _pKey
Definition: aggregates.h:327
bool isValid() const
Return True if both the x and y Keys are valid.
Definition: aggregates.h:97
bool lsst.afw.table::EllipseKey::operator!= ( EllipseKey const &  other) const
inline

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

Definition at line 313 of file aggregates.h.

313 { return !(*this == other); }
bool lsst.afw.table::EllipseKey::operator== ( EllipseKey const &  other) const
inline

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

Definition at line 310 of file aggregates.h.

310  {
311  return _qKey == other._qKey && _pKey == other._pKey;
312  }
PointKey< double > _pKey
Definition: aggregates.h:327
virtual void lsst.afw.table::EllipseKey::set ( BaseRecord record,
geom::ellipses::Ellipse const &  value 
) const
virtual

Set an Ellipse in the given record.

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

Member Data Documentation

PointKey<double> lsst.afw.table::EllipseKey::_pKey
private

Definition at line 327 of file aggregates.h.

QuadrupoleKey lsst.afw.table::EllipseKey::_qKey
private

Definition at line 326 of file aggregates.h.


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