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::PointKey< T > Class Template Reference

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< lsst::geom::Point< T, 2 > > lsst::afw::table::InputFunctorKey< lsst::geom::Point< T, 2 > >

Public Types

using Value = lsst::geom::Point< T, 2 >
 The data type for get and set. More...
 

Public Member Functions

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

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

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

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

64 : _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 67 of file aggregates.h.

67 : _x(x), _y(y) {}

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

83 : _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< lsst::geom::Point< T, 2 > >.

Definition at line 44 of file aggregates.cc.

44  {
45  return lsst::geom::Point<T, 2>(record.get(_x), record.get(_y));
46 }

◆ getX()

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

Return the underlying x Key.

Definition at line 107 of file aggregates.h.

107 { return _x; }

◆ getY()

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

Return the underlying y Key.

Definition at line 110 of file aggregates.h.

110 { 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 98 of file aggregates.h.

98  {
99  // Completely arbitrary seed
100  return utils::hashCombine(17, _x, _y);
101  }

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

104 { 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 94 of file aggregates.h.

94 { 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 93 of file aggregates.h.

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

◆ set()

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

Set a Point in the given record.

Implements lsst::afw::table::InputFunctorKey< lsst::geom::Point< T, 2 > >.

Definition at line 49 of file aggregates.cc.

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

The documentation for this class was generated from the following files:
y
int y
Definition: SpanSet.cc:49
schema
table::Schema schema
Definition: Amplifier.cc:115
lsst::afw::geom.transform.transformContinued.name
string name
Definition: transformContinued.py:32
x
double x
Definition: ChebyshevBoundedField.cc:277
other
ItemVariant const * other
Definition: Schema.cc:56
lsst::utils::hashCombine
std::size_t hashCombine(std::size_t seed) noexcept
Combine hashes.
Definition: hashCombine.h:35
lsst::geom::Point< T, 2 >
A coordinate class intended to represent absolute positions (2-d specialization).
Definition: Point.h:211