LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
LSST Data Management Base Package
Loading...
Searching...
No Matches
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< lsst::geom::SpherePoint > lsst::afw::table::InputFunctorKey< lsst::geom::SpherePoint >

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, 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

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) {}

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

◆ 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
T dec(T... args)

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

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

◆ 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 cpputils::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(); }

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

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

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