A FunctorKey used to get or set celestial coordiantes from a pair of Angle keys. More...

#include <aggregates.h>

Inheritance diagram for lsst::afw::table::CoordKey:

Public Member Functions
	CoordKey ()
	Default constructor; instance will not be usable unless subsequently assigned to. More...

	CoordKey (Key< geom::Angle > const &ra, Key< geom::Angle > const &dec)
	Construct from a pair of Keys. More...

	CoordKey (SubSchema const &s)
	Construct from a subschema, assuming ra and dec subfields. More...

virtual coord::IcrsCoord	get (BaseRecord const &record) const
	Get an IcrsCoord from the given record. More...

virtual void	set (BaseRecord &record, coord::IcrsCoord const &value) const
	Set an IcrsCoord in the given record. More...

virtual void	set (BaseRecord &record, coord::Coord const &value) const
	Set a Coord of another type in the given record; must be convertable to ICRS. More...

bool	isValid () const


Key< geom::Angle >	getRa () const
	Return a constituent Key. More...

Key< geom::Angle >	getDec () const
	Return a constituent Key. More...

Public Member Functions inherited from lsst::afw::table::OutputFunctorKey< coord::IcrsCoord >
virtual	~OutputFunctorKey ()

Public Member Functions inherited from lsst::afw::table::InputFunctorKey< coord::IcrsCoord >
virtual	~InputFunctorKey ()

Static Public Member Functions
static CoordKey	addFields (afw::table::Schema &schema, std::string const &name, std::string const &doc)

Detailed Description

A FunctorKey used to get or set celestial coordiantes from a pair of Angle keys.

Coords are always stored and returned in the ICRS system. Coords in other systems may be assigned, but this will result in a conversion to ICRS.

Definition at line 119 of file aggregates.h.

Constructor & Destructor Documentation

lsst::afw::table::CoordKey::CoordKey ( )

inline

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

Definition at line 136 of file aggregates.h.

136 : _ra(), _dec() {}

Key< geom::Angle > _dec

Definition: aggregates.h:176

Key< geom::Angle > _ra

Definition: aggregates.h:175

lsst::afw::table::CoordKey::CoordKey	(	Key< geom::Angle > const &	ra,
		Key< geom::Angle > const &	dec
	)

inline

Construct from a pair of Keys.

Definition at line 139 of file aggregates.h.

       :
         _ra(ra), _dec(dec)
     {}

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

inline

Construct from a subschema, assuming ra and dec subfields.

If a schema has "a_ra" and "a_dec" fields, this constructor allows you to construct a CoordKey via:

*

Definition at line 155 of file aggregates.h.

155 : _ra(s["ra"]), _dec(s["dec"]) {}

Key< geom::Angle > _dec

Definition: aggregates.h:176

Key< geom::Angle > _ra

Definition: aggregates.h:175

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

static

Add a pair of _ra, _dec fields to a Schema, and return a CoordKey that points to them.

Parameters

[in,out]	schema	Schema to add fields to.
[in]	name	Name prefix for all fields; "_ra", "_dec", will be appended to this to form the full field names.
[in]	doc	String used as the documentation for the fields.