Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04a91732dc+a777afbe81,g07dc498a13+7e3c5f68a2,g12483e3c20+0145ec33cd,g1409bbee79+7e3c5f68a2,g1a7e361dbc+7e3c5f68a2,g1fd858c14a+9f35e23ec3,g31cf31e263+9c59251d59,g35bb328faa+fcb1d3bbc8,g3ad4f90e5c+0145ec33cd,g3bd4b5ce2c+9e43d17133,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g5477a8d5ce+d2270fb7b7,g60b5630c4e+0145ec33cd,g623d845a50+0145ec33cd,g6f0c2978f1+a406a63c6f,g75b6c65c88+d54b601591,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+4639f750a5,g89139ef638+7e3c5f68a2,g9125e01d80+fcb1d3bbc8,g95236ca021+f7a31438ed,g989de1cb63+7e3c5f68a2,g9f33ca652e+2d6fa11d35,gaaedd4e678+7e3c5f68a2,gabe3b4be73+1e0a283bba,gb1101e3267+4a428ef779,gb4a253aaf5+0122250889,gb58c049af0+f03b321e39,gc99c83e5f0+76d20ab76d,gcf25f946ba+4639f750a5,gd0fa69b896+890c3b4faa,gd6cbbdb0b4+c8606af20c,gde0f65d7ad+c2b4c879fb,ge278dab8ac+932305ba37,gfba249425e+fcb1d3bbc8,w.2025.07
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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) {}
A FunctorKey used to get or set a lsst::geom::Point from an (x,y) pair of int or double Keys.
Definition aggregates.h:51

◆ 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}
PointKey() noexcept
Default constructor; instance will not be usable unless subsequently assigned to.
Definition aggregates.h:66

◆ 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 {
46}
lsst::geom::Point< T, 2 > get(BaseRecord const &record) const override
Get a Point from the given record.
Definition aggregates.cc:44

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

virtual void lsst::afw::table::InputFunctorKey< T >::set ( BaseRecord & record,
T const & value ) const
pure virtualinherited

◆ set() [2/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}
Key< T > getY() const noexcept
Return the underlying y Key.
Definition aggregates.h:112
void set(BaseRecord &record, lsst::geom::Point< T, 2 > const &value) const override
Set a Point in the given record.
Definition aggregates.cc:49
Key< T > getX() const noexcept
Return the underlying x Key.
Definition aggregates.h:109

The documentation for this class was generated from the following files: