LSST Applications g0aad566f14+98bdd3b178,g0dd44d6229+e0c2448475,g2079a07aa2+86d27d4dc4,g2305ad1205+28192cebb5,g2bbee38e9b+047b288a59,g337abbeb29+047b288a59,g33d1c0ed96+047b288a59,g3a166c0a6a+047b288a59,g3d1719c13e+98bdd3b178,g487adcacf7+08349b74a1,g4be5004598+98bdd3b178,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+742623b69a,g63cd9335cc+585e252eca,g858d7b2824+98bdd3b178,g88963caddf+0cb8e002cc,g88c60e1ba4+10d1129650,g99cad8db69+26979ce5a5,g9ddcbc5298+9a081db1e4,ga1e77700b3+a912195c07,gae0086650b+585e252eca,gb0e22166c9+60f28cb32d,gb1fda7adca+90d62c6f66,gb3a676b8dc+b4feba26a1,gb4b16eec92+950562e714,gba4ed39666+c2a2e4ac27,gbb8dafda3b+2fe9a6a885,gc120e1dc64+0553034b2f,gc28159a63d+047b288a59,gc3e9b769f7+f8a3f20ab6,gcf0d15dbbd+e0c2448475,gdaeeff99f8+f9a426f77a,gdb0af172c8+f61b8374e1,ge79ae78c31+047b288a59,w.2024.20
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::PointKey< T > Class Template Referenceabstract

A FunctorKey used to get or set a lsst::geom::Point from an (x,y) pair of int or double Keys. More...

#include <aggregates.h>

Inheritance diagram for lsst::afw::table::PointKey< T >:
lsst::afw::table::FunctorKey< lsst::geom::Point< T, 2 > > lsst::afw::table::OutputFunctorKey< T > lsst::afw::table::InputFunctorKey< T >

Public Types

using Value
 The data type for get and set.
 

Public Member Functions

 PointKey () noexcept
 Default constructor; instance will not be usable unless subsequently assigned to.
 
 PointKey (Key< T > const &x, Key< T > const &y) noexcept
 Construct from a pair of Keys.
 
 PointKey (PointKey const &) noexcept=default
 
 PointKey (PointKey &&) noexcept=default
 
PointKeyoperator= (PointKey const &) noexcept=default
 
PointKeyoperator= (PointKey &&) noexcept=default
 
 ~PointKey () noexcept override=default
 
 PointKey (SubSchema const &s)
 Construct from a subschema, assuming x and y subfields.
 
lsst::geom::Point< T, 2 > get (BaseRecord const &record) const override
 Get a Point from the given record.
 
void set (BaseRecord &record, lsst::geom::Point< T, 2 > const &value) const override
 Set a Point in the given record.
 
bool operator== (PointKey< T > const &other) const noexcept
 Compare the FunctorKey for equality with another, using the underlying x and y Keys.
 
bool operator!= (PointKey< T > const &other) const noexcept
 
std::size_t hash_value () const noexcept
 Return a hash of this object.
 
bool isValid () const noexcept
 Return True if both the x and y Keys are valid.
 
Key< T > getX () const noexcept
 Return the underlying x Key.
 
Key< T > getY () const noexcept
 Return the underlying y Key.
 
virtual void set (BaseRecord &record, T const &value) const =0
 

Static Public Member Functions

static PointKey addFields (Schema &schema, std::string const &name, std::string const &doc, std::string const &unit)
 Add a pair of _x, _y fields to a Schema, and return a PointKey that points to them.
 

Detailed Description

template<typename T>
class lsst::afw::table::PointKey< T >

A FunctorKey used to get or set a lsst::geom::Point from an (x,y) pair of int or double Keys.

Definition at line 51 of file aggregates.h.

Member Typedef Documentation

◆ Value

using lsst::afw::table::FunctorKey< T >::Value
inherited

The data type for get and set.

Definition at line 77 of file FunctorKey.h.

Constructor & Destructor Documentation

◆ PointKey() [1/5]

template<typename T >
lsst::afw::table::PointKey< T >::PointKey ( )
inlinenoexcept

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

Definition at line 66 of file aggregates.h.

66: _x(), _y() {}

◆ PointKey() [2/5]

template<typename T >
lsst::afw::table::PointKey< T >::PointKey ( Key< T > const & x,
Key< T > const & y )
inlinenoexcept

Construct from a pair of Keys.

Definition at line 69 of file aggregates.h.

69: _x(x), _y(y) {}
int y
Definition SpanSet.cc:48

◆ PointKey() [3/5]

template<typename T >
lsst::afw::table::PointKey< T >::PointKey ( PointKey< T > const & )
defaultnoexcept

◆ PointKey() [4/5]

template<typename T >
lsst::afw::table::PointKey< T >::PointKey ( PointKey< T > && )
defaultnoexcept

◆ ~PointKey()

template<typename T >
lsst::afw::table::PointKey< T >::~PointKey ( )
overridedefaultnoexcept

◆ PointKey() [5/5]

template<typename T >
lsst::afw::table::PointKey< T >::PointKey ( SubSchema const & s)
inline

Construct from a subschema, assuming x and y subfields.

If a schema has "a_x" and "a_y" fields, this constructor allows you to construct a PointKey via:

PointKey<T> k(schema["a"]);

Definition at line 85 of file aggregates.h.

85: _x(s["x"]), _y(s["y"]) {}

Member Function Documentation

◆ addFields()

template<typename T >
PointKey< T > lsst::afw::table::PointKey< T >::addFields ( Schema & schema,
std::string const & name,
std::string const & doc,
std::string const & unit )
static

Add a pair of _x, _y fields to a Schema, and return a PointKey that points to them.

Parameters
[in,out]schemaSchema to add fields to.
[in]nameName prefix for all fields; "_x", "_y", will be appended to this to form the full field names.
[in]docString used as the documentation for the fields.
[in]unitString used as the unit for all fields.

Definition at line 36 of file aggregates.cc.

37 {
38 Key<T> xKey = schema.addField<T>(schema.join(name, "x"), doc, unit);
39 Key<T> yKey = schema.addField<T>(schema.join(name, "y"), doc, unit);
40 return PointKey<T>(xKey, yKey);
41}

◆ get()

template<typename T >
lsst::geom::Point< T, 2 > lsst::afw::table::PointKey< T >::get ( BaseRecord const & record) const
overridevirtual

Get a Point from the given record.

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

Definition at line 44 of file aggregates.cc.

44 {
45 return lsst::geom::Point<T, 2>(record.get(_x), record.get(_y));
46}
A coordinate class intended to represent absolute positions.
Definition Point.h:169

◆ getX()

template<typename T >
Key< T > lsst::afw::table::PointKey< T >::getX ( ) const
inlinenoexcept

Return the underlying x Key.

Definition at line 109 of file aggregates.h.

109{ return _x; }

◆ getY()

template<typename T >
Key< T > lsst::afw::table::PointKey< T >::getY ( ) const
inlinenoexcept

Return the underlying y Key.

Definition at line 112 of file aggregates.h.

112{ return _y; }

◆ hash_value()

template<typename T >
std::size_t lsst::afw::table::PointKey< T >::hash_value ( ) const
inlinenoexcept

Return a hash of this object.

Definition at line 100 of file aggregates.h.

100 {
101 // Completely arbitrary seed
102 return utils::hashCombine(17, _x, _y);
103 }
std::size_t hashCombine(std::size_t seed) noexcept
Combine hashes.
Definition hashCombine.h:35

◆ isValid()

template<typename T >
bool lsst::afw::table::PointKey< T >::isValid ( ) const
inlinenoexcept

Return True if both the x and y Keys are valid.

Definition at line 106 of file aggregates.h.

106{ return _x.isValid() && _y.isValid(); }

◆ operator!=()

template<typename T >
bool lsst::afw::table::PointKey< T >::operator!= ( PointKey< T > const & other) const
inlinenoexcept

Definition at line 96 of file aggregates.h.

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

◆ operator=() [1/2]

template<typename T >
PointKey & lsst::afw::table::PointKey< T >::operator= ( PointKey< T > && )
defaultnoexcept

◆ operator=() [2/2]

template<typename T >
PointKey & lsst::afw::table::PointKey< T >::operator= ( PointKey< T > const & )
defaultnoexcept

◆ operator==()

template<typename T >
bool lsst::afw::table::PointKey< T >::operator== ( PointKey< T > const & other) const
inlinenoexcept

Compare the FunctorKey for equality with another, using the underlying x and y Keys.

Definition at line 95 of file aggregates.h.

95{ return _x == other._x && _y == other._y; }

◆ set() [1/2]

template<typename T >
void lsst::afw::table::PointKey< T >::set ( BaseRecord & record,
lsst::geom::Point< T, 2 > const & value ) const
override

Set a Point in the given record.

Definition at line 49 of file aggregates.cc.

49 {
50 record.set(_x, value.getX());
51 record.set(_y, value.getY());
52}

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