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

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
PointKey &	operator= (PointKey const &) noexcept=default
PointKey &	operator= (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...
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. 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

using lsst::afw::table::FunctorKey< lsst::geom::Point< T, 2 > >::Value = lsst::geom::Point< T, 2 >

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

: _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.

: _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.

: _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]	schema	Schema to add fields to.
[in]	name	Name prefix for all fields; "_x", "_y", will be appended to this to form the full field names.
[in]	doc	String used as the documentation for the fields.
[in]	unit	String used as the unit for all fields.

Definition at line 36 of file aggregates.cc.

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

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.

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

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.

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

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

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

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.

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

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

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

                                                                                {
    record.set(_x, value.getX());
    record.set(_y, value.getY());
}

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:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-32-g5ddfab5d3+60ce4897b0/include/lsst/afw/table/aggregates.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-32-g5ddfab5d3+60ce4897b0/src/table/aggregates.cc