LSST Applications g0f08755f38+9c285cab97,g1635faa6d4+13f3999e92,g1653933729+a8ce1bb630,g1a0ca8cf93+bf6eb00ceb,g28da252d5a+0829b12dee,g29321ee8c0+5700dc9eac,g2bbee38e9b+9634bc57db,g2bc492864f+9634bc57db,g2cdde0e794+c2c89b37c4,g3156d2b45e+41e33cbcdc,g347aa1857d+9634bc57db,g35bb328faa+a8ce1bb630,g3a166c0a6a+9634bc57db,g3e281a1b8c+9f2c4e2fc3,g414038480c+077ccc18e7,g41af890bb2+fde0dd39b6,g5fbc88fb19+17cd334064,g781aacb6e4+a8ce1bb630,g80478fca09+55a9465950,g82479be7b0+d730eedb7d,g858d7b2824+9c285cab97,g9125e01d80+a8ce1bb630,g9726552aa6+10f999ec6a,ga5288a1d22+2a84bb7594,gacf8899fa4+c69c5206e8,gae0086650b+a8ce1bb630,gb58c049af0+d64f4d3760,gc28159a63d+9634bc57db,gcf0d15dbbd+4b7d09cae4,gda3e153d99+9c285cab97,gda6a2b7d83+4b7d09cae4,gdaeeff99f8+1711a396fd,ge2409df99d+5e831397f4,ge79ae78c31+9634bc57db,gf0baf85859+147a0692ba,gf3967379c6+41c94011de,gf3fb38a9a8+8f07a9901b,gfb92a5be7c+9c285cab97,w.2024.46
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::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) {}
double z
Definition Match.cc:44
int y
Definition SpanSet.cc:48

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

◆ 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 {
70 return lsst::geom::Point<T, 3>(record.get(_x), record.get(_y), record.get(_z));
71}
A coordinate class intended to represent absolute positions.
Definition Point.h:169

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

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}

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