Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04a91732dc+a777afbe81,g07dc498a13+7e3c5f68a2,g12483e3c20+0145ec33cd,g1409bbee79+7e3c5f68a2,g1a7e361dbc+7e3c5f68a2,g1fd858c14a+9f35e23ec3,g35bb328faa+fcb1d3bbc8,g3ad4f90e5c+0145ec33cd,g3bd4b5ce2c+cbf1bea503,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g5477a8d5ce+db04660fe6,g60b5630c4e+0145ec33cd,g623d845a50+0145ec33cd,g6f0c2978f1+3526b51a37,g75b6c65c88+d54b601591,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+4639f750a5,g89139ef638+7e3c5f68a2,g9125e01d80+fcb1d3bbc8,g919ac25b3e+6220c5324a,g95236ca021+f7a31438ed,g989de1cb63+7e3c5f68a2,g9f33ca652e+2d6fa11d35,gaaedd4e678+7e3c5f68a2,gabe3b4be73+1e0a283bba,gb1101e3267+4a428ef779,gb4a253aaf5+0122250889,gb58c049af0+f03b321e39,gc99c83e5f0+76d20ab76d,gcf25f946ba+4639f750a5,gd6cbbdb0b4+c8606af20c,gde0f65d7ad+3d8a3b7e46,ge278dab8ac+932305ba37,gf795337580+03b96afe58,gfba249425e+fcb1d3bbc8,w.2025.08
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
lsst::afw::table::Point3Key< T > Class Template Referenceabstract

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

#include <aggregates.h>

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

Public Types

using Value
 The data type for get and set.
 

Public Member Functions

 Point3Key () noexcept
 Default constructor; instance will not be usable unless subsequently assigned to.
 
 Point3Key (Key< T > const &x, Key< T > const &y, Key< T > const &z) noexcept
 Construct from a pair of Keys.
 
 Point3Key (Point3Key const &) noexcept=default
 
 Point3Key (Point3Key &&) noexcept=default
 
Point3Keyoperator= (Point3Key const &) noexcept=default
 
Point3Keyoperator= (Point3Key &&) noexcept=default
 
 ~Point3Key () noexcept override=default
 
 Point3Key (SubSchema const &s)
 Construct from a subschema, assuming x and y subfields.
 
lsst::geom::Point< T, 3 > get (BaseRecord const &record) const override
 Get a Point from the given record.
 
void set (BaseRecord &record, lsst::geom::Point< T, 3 > const &value) const override
 Set a Point in the given record.
 
bool operator== (Point3Key< T > const &other) const noexcept
 Compare the FunctorKey for equality with another, using the underlying x, y, and z Keys.
 
bool operator!= (Point3Key< 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 all of the x, y, and z Keys are valid.
 
Key< T > getX () const noexcept
 Return the underlying x Key.
 
Key< T > getY () const noexcept
 Return the underlying y Key.
 
Key< T > getZ () const noexcept
 Return the underlying y Key.
 
virtual void set (BaseRecord &record, T const &value) const=0
 

Static Public Member Functions

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

Detailed Description

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

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

Definition at line 126 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

◆ Point3Key() [1/5]

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

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

Definition at line 141 of file aggregates.h.

141: _x(), _y(), _z() {}

◆ Point3Key() [2/5]

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

Construct from a pair of Keys.

Definition at line 144 of file aggregates.h.

144: _x(x), _y(y), _z(z) {}
A FunctorKey used to get or set a lsst::geom::Point3 from an (x,y,z) tuple of int or double Keys.
Definition aggregates.h:126

◆ Point3Key() [3/5]

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

◆ Point3Key() [4/5]

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

◆ ~Point3Key()

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

◆ Point3Key() [5/5]

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

Construct from a subschema, assuming x and y subfields.

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

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

Definition at line 160 of file aggregates.h.

160: _x(s["x"]), _y(s["y"]), _z(s["z"]) {}

Member Function Documentation

◆ addFields()

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

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

Parameters
[in,out]schemaSchema to add fields to.
[in]nameName prefix for all fields; "_x", "_y", "_z" 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 60 of file aggregates.cc.

61 {
62 Key<T> xKey = schema.addField<T>(schema.join(name, "x"), doc, unit);
63 Key<T> yKey = schema.addField<T>(schema.join(name, "y"), doc, unit);
64 Key<T> zKey = schema.addField<T>(schema.join(name, "z"), doc, unit);
65 return Point3Key<T>(xKey, yKey, zKey);
66}
Point3Key() noexcept
Default constructor; instance will not be usable unless subsequently assigned to.
Definition aggregates.h:141

◆ get()

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

Get a Point from the given record.

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

Definition at line 69 of file aggregates.cc.

69 {
71}
lsst::geom::Point< T, 3 > get(BaseRecord const &record) const override
Get a Point from the given record.
Definition aggregates.cc:69

◆ getX()

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

Return the underlying x Key.

Definition at line 185 of file aggregates.h.

185{ return _x; }

◆ getY()

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

Return the underlying y Key.

Definition at line 188 of file aggregates.h.

188{ return _y; }

◆ getZ()

template<typename T>
Key< T > lsst::afw::table::Point3Key< T >::getZ ( ) const
inlinenoexcept

Return the underlying y Key.

Definition at line 191 of file aggregates.h.

191{ return _z; }

◆ hash_value()

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

Return a hash of this object.

Definition at line 176 of file aggregates.h.

176 {
177 // Completely arbitrary seed
178 return cpputils::hashCombine(137, _x, _y, _z);
179 }
std::size_t hashCombine(std::size_t seed) noexcept
Combine hashes.
Definition hashCombine.h:35

◆ isValid()

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

Return True if all of the x, y, and z Keys are valid.

Definition at line 182 of file aggregates.h.

182{ return _x.isValid() && _y.isValid() && _z.isValid(); }

◆ operator!=()

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

Definition at line 172 of file aggregates.h.

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

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ operator==()

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

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

Definition at line 170 of file aggregates.h.

170 {
171 return _x == other._x && _y == other._y && _z == other._z; }

◆ 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::Point3Key< T >::set ( BaseRecord & record,
lsst::geom::Point< T, 3 > const & value ) const
override

Set a Point in the given record.

Definition at line 74 of file aggregates.cc.

74 {
75 record.set(_x, value.getX());
76 record.set(_y, value.getY());
77 record.set(_z, value.getZ());
78}
Key< T > getX() const noexcept
Return the underlying x Key.
Definition aggregates.h:185
void set(BaseRecord &record, lsst::geom::Point< T, 3 > const &value) const override
Set a Point in the given record.
Definition aggregates.cc:74
Key< T > getY() const noexcept
Return the underlying y Key.
Definition aggregates.h:188
Key< T > getZ() const noexcept
Return the underlying y Key.
Definition aggregates.h:191

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