lsst.afw  21.0.0-19-g1706eef1c+e734d31160
Public Types | Public Member Functions | Static Public Member Functions | List of all members
lsst::afw::table::CoordKey Class Referenceabstract

A FunctorKey used to get or set celestial coordinates from a pair of lsst::geom::Angle keys. More...

#include <aggregates.h>

Inheritance diagram for lsst::afw::table::CoordKey:
lsst::afw::table::FunctorKey< lsst::geom::SpherePoint > lsst::afw::table::OutputFunctorKey< T > lsst::afw::table::InputFunctorKey< T >

Public Types

using Value = lsst::geom::SpherePoint
 The data type for get and set. More...
 

Public Member Functions

 CoordKey () noexcept
 Default constructor; instance will not be usable unless subsequently assigned to. More...
 
 CoordKey (Key< lsst::geom::Angle > const &ra, Key< lsst::geom::Angle > const &dec) noexcept
 Construct from a pair of Keys. More...
 
 CoordKey (SubSchema const &s)
 Construct from a subschema, assuming ra and dec subfields. More...
 
 CoordKey (CoordKey const &) noexcept=default
 
 CoordKey (CoordKey &&) noexcept=default
 
CoordKeyoperator= (CoordKey const &) noexcept=default
 
CoordKeyoperator= (CoordKey &&) noexcept=default
 
 ~CoordKey () noexcept override=default
 
lsst::geom::SpherePoint get (BaseRecord const &record) const override
 Get an lsst::geom::SpherePoint from the given record. More...
 
void set (BaseRecord &record, lsst::geom::SpherePoint const &value) const override
 Set an lsst::geom::SpherePoint in the given record. More...
 
bool operator== (CoordKey const &other) const noexcept
 Compare CoordKeys for equality using the constituent ra and dec Keys. More...
 
bool operator!= (CoordKey const &other) const noexcept
 
std::size_t hash_value () const noexcept
 Return a hash of this object. More...
 
bool isValid () const noexcept
 
Key< lsst::geom::AnglegetRa () const noexcept
 Return a constituent Key. More...
 
Key< lsst::geom::AnglegetDec () const noexcept
 
virtual void set (BaseRecord &record, T const &value) const =0
 

Static Public Member Functions

static CoordKey addFields (afw::table::Schema &schema, std::string const &name, std::string const &doc)
 Add a pair of _ra, _dec fields to a Schema, and return a CoordKey that points to them. More...
 

Detailed Description

A FunctorKey used to get or set celestial coordinates from a pair of lsst::geom::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 210 of file aggregates.h.

Member Typedef Documentation

◆ Value

The data type for get and set.

Definition at line 77 of file FunctorKey.h.

Constructor & Destructor Documentation

◆ CoordKey() [1/5]

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

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

Definition at line 223 of file aggregates.h.

◆ CoordKey() [2/5]

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

Construct from a pair of Keys.

Definition at line 226 of file aggregates.h.

◆ CoordKey() [3/5]

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:

CoordKey k(schema["a"]);

Definition at line 237 of file aggregates.h.

◆ CoordKey() [4/5]

lsst::afw::table::CoordKey::CoordKey ( CoordKey const &  )
defaultnoexcept

◆ CoordKey() [5/5]

lsst::afw::table::CoordKey::CoordKey ( CoordKey &&  )
defaultnoexcept

◆ ~CoordKey()

lsst::afw::table::CoordKey::~CoordKey ( )
overridedefaultnoexcept

Member Function Documentation

◆ addFields()

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]schemaSchema to add fields to.
[in]nameName prefix for all fields; "_ra", "_dec", will be appended to this to form the full field names.
[in]docString used as the documentation for the fields.

Definition at line 83 of file aggregates.cc.

◆ get()

lsst::geom::SpherePoint lsst::afw::table::CoordKey::get ( BaseRecord const &  record) const
overridevirtual

Get an lsst::geom::SpherePoint from the given record.

Implements lsst::afw::table::OutputFunctorKey< T >.

Definition at line 89 of file aggregates.cc.

◆ getDec()

Key<lsst::geom::Angle> lsst::afw::table::CoordKey::getDec ( ) const
inlinenoexcept

Definition at line 268 of file aggregates.h.

◆ getRa()

Key<lsst::geom::Angle> lsst::afw::table::CoordKey::getRa ( ) const
inlinenoexcept

Return a constituent Key.

Definition at line 267 of file aggregates.h.

◆ hash_value()

std::size_t lsst::afw::table::CoordKey::hash_value ( ) const
inlinenoexcept

Return a hash of this object.

Definition at line 258 of file aggregates.h.

◆ isValid()

bool lsst::afw::table::CoordKey::isValid ( ) const
inlinenoexcept

Definition at line 263 of file aggregates.h.

◆ operator!=()

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

Definition at line 254 of file aggregates.h.

◆ operator=() [1/2]

CoordKey& lsst::afw::table::CoordKey::operator= ( CoordKey &&  )
defaultnoexcept

◆ operator=() [2/2]

CoordKey& lsst::afw::table::CoordKey::operator= ( CoordKey const &  )
defaultnoexcept

◆ operator==()

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

Compare CoordKeys for equality using the constituent ra and dec Keys.

Definition at line 253 of file aggregates.h.

◆ set() [1/2]

void lsst::afw::table::CoordKey::set ( BaseRecord record,
lsst::geom::SpherePoint const &  value 
) const
override

Set an lsst::geom::SpherePoint in the given record.

Definition at line 93 of file aggregates.cc.

◆ set() [2/2]

template<typename T >
virtual void lsst::afw::table::InputFunctorKey< T >::set ( BaseRecord record,
T const &  value 
) const
pure virtualinherited

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