lsst::afw::table::CoordKey Class Reference

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:

Public Types
using	ErrorKey = CovarianceMatrixKey<float, 2>
using	Value
	The data type for get and set.

Public Member Functions
	CoordKey () noexcept
	Default constructor; instance will not be usable unless subsequently assigned to.
	CoordKey (Key< lsst::geom::Angle > const &ra, Key< lsst::geom::Angle > const &dec) noexcept
	Construct from a pair of Keys.
	CoordKey (SubSchema const &s)
	Construct from a subschema, assuming ra and dec subfields.
	CoordKey (CoordKey const &) noexcept=default
	CoordKey (CoordKey &&) noexcept=default
CoordKey &	operator= (CoordKey const &) noexcept=default
CoordKey &	operator= (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.
void	set (BaseRecord &record, lsst::geom::SpherePoint const &value) const override
	Set an lsst::geom::SpherePoint in the given record.
bool	operator== (CoordKey const &other) const noexcept
	Compare CoordKeys for equality using the constituent ra and dec Keys.
bool	operator!= (CoordKey const &other) const noexcept
std::size_t	hash_value () const noexcept
	Return a hash of this object.
bool	isValid () const noexcept
Key< lsst::geom::Angle >	getRa () const noexcept
	Return a constituent Key.
Key< lsst::geom::Angle >	getDec () const noexcept
virtual void	set (BaseRecord &record, lsst::geom::SpherePoint 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.
static ErrorKey	getErrorKey (Schema const &schema)
static ErrorKey	addErrorFields (Schema &schema)

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

Member Typedef Documentation

ErrorKey

using lsst::afw::table::CoordKey::ErrorKey = CovarianceMatrixKey<float, 2>

Definition at line 304 of file aggregates.h.

Value

using lsst::afw::table::FunctorKey< lsst::geom::SpherePoint >::Value

inherited

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

: _ra(), _dec() {}

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

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

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

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

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

addErrorFields()

CoordKey::ErrorKey lsst::afw::table::CoordKey::addErrorFields ( Schema & schema )

static

Definition at line 128 of file aggregates.cc.

                                                         {
    return ErrorKey::addFields(schema, "coord", {"ra", "dec"}, "rad");
}

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]	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.

Definition at line 109 of file aggregates.cc.

                                                                                        {
    Key<lsst::geom::Angle> ra = schema.addField<lsst::geom::Angle>(schema.join(name, "ra"), doc);
    Key<lsst::geom::Angle> dec = schema.addField<lsst::geom::Angle>(schema.join(name, "dec"), doc);
    return CoordKey(ra, dec);
}

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< lsst::geom::SpherePoint >.

Definition at line 115 of file aggregates.cc.

                                                                {
    return lsst::geom::SpherePoint(record.get(_ra), record.get(_dec));
}

getDec()

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

inlinenoexcept

Definition at line 355 of file aggregates.h.

{ return _dec; }

getErrorKey()

CoordKey::ErrorKey lsst::afw::table::CoordKey::getErrorKey ( Schema const & schema )

static

Definition at line 124 of file aggregates.cc.

                                                            {
    return ErrorKey(schema["coord"], {"ra", "dec"});
}

getRa()

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

inlinenoexcept

Return a constituent Key.

Definition at line 354 of file aggregates.h.

{ return _ra; }

hash_value()

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

inlinenoexcept

Return a hash of this object.

Definition at line 345 of file aggregates.h.

                                          {
        // Completely arbitrary seed
        return cpputils::hashCombine(17, _ra, _dec);
    }

isValid()

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

inlinenoexcept

Definition at line 350 of file aggregates.h.

{ return _ra.isValid() && _dec.isValid(); }

operator!=()

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

inlinenoexcept

Definition at line 341 of file aggregates.h.

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

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

{ return _ra == other._ra && _dec == other._dec; }

set() [1/2]

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

overridevirtual

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

Implements lsst::afw::table::InputFunctorKey< lsst::geom::SpherePoint >.

Definition at line 119 of file aggregates.cc.

                                                                             {
    record.set(_ra, value.getLongitude());
    record.set(_dec, value.getLatitude());
}

set() [2/2]

virtual void lsst::afw::table::InputFunctorKey< lsst::geom::SpherePoint >::set ( BaseRecord & record, lsst::geom::SpherePoint const & value ) const

pure virtualinherited

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-10.0.0/Linux64/afw/g5a012ec0e7+3632fc3ff3/include/lsst/afw/table/aggregates.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-10.0.0/Linux64/afw/g5a012ec0e7+3632fc3ff3/src/table/aggregates.cc