LSST Applications g0265f82a02+c6dfa2ddaf,g1162b98a3f+b2075782a9,g2079a07aa2+1b2e822518,g2bbee38e9b+c6dfa2ddaf,g337abbeb29+c6dfa2ddaf,g3ddfee87b4+a60788ef87,g50ff169b8f+2eb0e556e8,g52b1c1532d+90ebb246c7,g555ede804d+a60788ef87,g591dd9f2cf+ba8caea58f,g5ec818987f+864ee9cddb,g858d7b2824+9ee1ab4172,g876c692160+a40945ebb7,g8a8a8dda67+90ebb246c7,g8cdfe0ae6a+4fd9e222a8,g99cad8db69+5e309b7bc6,g9ddcbc5298+a1346535a5,ga1e77700b3+df8f93165b,ga8c6da7877+aa12a14d27,gae46bcf261+c6dfa2ddaf,gb0e22166c9+8634eb87fb,gb3f2274832+d0da15e3be,gba4ed39666+1ac82b564f,gbb8dafda3b+5dfd9c994b,gbeb006f7da+97157f9740,gc28159a63d+c6dfa2ddaf,gc86a011abf+9ee1ab4172,gcf0d15dbbd+a60788ef87,gdaeeff99f8+1cafcb7cd4,gdc0c513512+9ee1ab4172,ge79ae78c31+c6dfa2ddaf,geb67518f79+ba1859f325,geb961e4c1e+f9439d1e6f,gee10cc3b42+90ebb246c7,gf1cff7945b+9ee1ab4172,w.2024.12
LSST Data Management Base Package
Loading...
Searching...
No Matches
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 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
 
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.
 
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::AnglegetRa () const noexcept
 Return a constituent Key.
 
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.
 
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

Definition at line 304 of file aggregates.h.

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

310: _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.

314 : _ra(ra), _dec(dec) {}
double dec
Definition Match.cc:41

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

324: _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.

128 {
129 return ErrorKey::addFields(schema, "coord", {"ra", "dec"}, "rad");
130}
static CovarianceMatrixKey addFields(Schema &schema, std::string const &prefix, NameArray const &names, std::string const &unit, bool diagonalOnly=false)
Add covariance matrix fields to a Schema, and return a CovarianceMatrixKey to manage them.

◆ 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 109 of file aggregates.cc.

109 {
110 Key<lsst::geom::Angle> ra = schema.addField<lsst::geom::Angle>(schema.join(name, "ra"), doc);
111 Key<lsst::geom::Angle> dec = schema.addField<lsst::geom::Angle>(schema.join(name, "dec"), doc);
112 return CoordKey(ra, dec);
113}
CoordKey() noexcept
Default constructor; instance will not be usable unless subsequently assigned to.
Definition aggregates.h:310
A class representing an angle.
Definition Angle.h:128

◆ 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 115 of file aggregates.cc.

115 {
116 return lsst::geom::SpherePoint(record.get(_ra), record.get(_dec));
117}
Point in an unspecified spherical coordinate system.
Definition SpherePoint.h:57

◆ getDec()

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

Definition at line 355 of file aggregates.h.

355{ return _dec; }

◆ getErrorKey()

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

Definition at line 124 of file aggregates.cc.

124 {
125 return ErrorKey(schema["coord"], {"ra", "dec"});
126}
CovarianceMatrixKey< float, 2 > ErrorKey
Definition aggregates.h:304

◆ getRa()

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

Return a constituent Key.

Definition at line 354 of file aggregates.h.

354{ 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.

345 {
346 // Completely arbitrary seed
347 return utils::hashCombine(17, _ra, _dec);
348 }
std::size_t hashCombine(std::size_t seed) noexcept
Combine hashes.
Definition hashCombine.h:35

◆ isValid()

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

Definition at line 350 of file aggregates.h.

350{ return _ra.isValid() && _dec.isValid(); }
bool isValid() const noexcept
Return true if the key was initialized to valid offset.
Definition Key.h:97

◆ operator!=()

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

Definition at line 341 of file aggregates.h.

341{ 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.

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

◆ 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 119 of file aggregates.cc.

119 {
120 record.set(_ra, value.getLongitude());
121 record.set(_dec, value.getLatitude());
122}

◆ 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: