LSSTApplications  19.0.0-10-g920eed2,19.0.0-11-g48a0200+2,19.0.0-18-gfc4e62b+10,19.0.0-2-g3b2f90d+2,19.0.0-2-gd671419+5,19.0.0-20-g5a5a17ab+8,19.0.0-21-g2644856+10,19.0.0-22-gc5dc5b1+5,19.0.0-23-gdc29a50+2,19.0.0-24-g923e380+10,19.0.0-25-g6c8df7140,19.0.0-27-g567f04d+6,19.0.0-3-g2b32d65+5,19.0.0-3-g8227491+9,19.0.0-3-g9c54d0d+9,19.0.0-3-gca68e65+5,19.0.0-3-gcfc5f51+5,19.0.0-3-ge110943+8,19.0.0-3-ge74d124,19.0.0-3-gfe04aa6+10,19.0.0-4-g06f5963+5,19.0.0-4-g3d16501+10,19.0.0-4-g4a9c019+5,19.0.0-4-g5a8b323,19.0.0-4-g66397f0+1,19.0.0-4-g8278b9b+1,19.0.0-4-g8557e14,19.0.0-4-g8964aba+10,19.0.0-4-ge404a01+9,19.0.0-5-g40f3a5a,19.0.0-5-g4db63b3,19.0.0-5-gfb03ce7+10,19.0.0-6-gbaebbfb+9,19.0.0-60-gafafd468+10,19.0.0-64-gf672fef+7,19.0.0-7-g039c0b5+8,19.0.0-7-gbea9075+4,19.0.0-7-gc567de5+10,19.0.0-8-g3a3ce09+5,19.0.0-9-g463f923+9,w.2020.21
LSSTDataManagementBasePackage
Public Types | Public Member Functions | Static Public Member Functions | List of all members
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:
lsst::afw::table::FunctorKey< lsst::geom::SpherePoint > lsst::afw::table::OutputFunctorKey< lsst::geom::SpherePoint > lsst::afw::table::InputFunctorKey< lsst::geom::SpherePoint >

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
 

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.

223 : _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 226 of file aggregates.h.

227  : _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 237 of file aggregates.h.

237 : _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

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

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

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

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

◆ getDec()

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

Definition at line 268 of file aggregates.h.

268 { return _dec; }

◆ getRa()

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

Return a constituent Key.

Definition at line 267 of file aggregates.h.

267 { return _ra; }

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

258  {
259  // Completely arbitrary seed
260  return utils::hashCombine(17, _ra, _dec);
261  }

◆ isValid()

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

Definition at line 263 of file aggregates.h.

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

◆ operator!=()

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

Definition at line 254 of file aggregates.h.

254 { 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 253 of file aggregates.h.

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

◆ set()

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

93  {
94  record.set(_ra, value.getLongitude());
95  record.set(_dec, value.getLatitude());
96 }

The documentation for this class was generated from the following files:
schema
table::Schema schema
Definition: Amplifier.cc:115
lsst::afw::table::SpherePoint
lsst::geom::SpherePoint SpherePoint
Definition: misc.h:35
dec
double dec
Definition: Match.cc:41
lsst::afw::table::CoordKey::CoordKey
CoordKey() noexcept
Default constructor; instance will not be usable unless subsequently assigned to.
Definition: aggregates.h:223
lsst::afw::geom.transform.transformContinued.name
string name
Definition: transformContinued.py:32
other
ItemVariant const * other
Definition: Schema.cc:56
lsst::afw::table::Key::isValid
bool isValid() const noexcept
Return true if the key was initialized to valid offset.
Definition: Key.h:97
lsst::utils::hashCombine
std::size_t hashCombine(std::size_t seed) noexcept
Combine hashes.
Definition: hashCombine.h:35
lsst::geom::Angle
A class representing an angle.
Definition: Angle.h:127