lsst::afw::table::BoxKey< Box > Class Template Reference

A FunctorKey used to get or set a lsst::geom::Box2I or Box2D from a (min, max) pair of PointKeys. More...

#include <aggregates.h>

Inheritance diagram for lsst::afw::table::BoxKey< Box >:

Public Types
using	Element = typename Box::Element
	Type of coordinate elements (i.e. int or double). More...
using	Value = Box
	The data type for get and set. More...

Public Member Functions
	BoxKey () noexcept=default
	Default constructor; instance will not be usable unless subsequently assigned to. More...
	BoxKey (PointKey< Element > const &min, PointKey< Element > const &max) noexcept
	Construct from a pair of PointKeys. More...
	BoxKey (SubSchema const &s)
	Construct from a subschema, assuming _min_x, _max_x, _min_y, _max_y subfields. More...
	BoxKey (BoxKey const &) noexcept=default
	BoxKey (BoxKey &&) noexcept=default
BoxKey &	operator= (BoxKey const &) noexcept=default
BoxKey &	operator= (BoxKey &&) noexcept=default
	~BoxKey () noexcept override=default
std::size_t	hash_value () const noexcept
	Return a hash of this object. More...
Box	get (BaseRecord const &record) const override
	Get a Box from the given record. More...
void	set (BaseRecord &record, Box const &value) const override
	Set a Box in the given record. More...
bool	operator== (BoxKey const &other) const noexcept
	Compare the FunctorKey for equality with another, using the underlying x and y Keys. More...
bool	operator!= (BoxKey const &other) const noexcept
bool	isValid () const noexcept
	Return True if both the min and max PointKeys are valid. More...
PointKey< Element >	getMin () const noexcept
	Return the underlying min PointKey. More...
PointKey< Element >	getMax () const noexcept
	Return the underlying max PointKey. More...
virtual void	set (BaseRecord &record, T const &value) const =0

Static Public Member Functions
static BoxKey	addFields (Schema &schema, std::string const &name, std::string const &doc, std::string const &unit)
	Add _min_x, _min_y, _max_x, _max_y fields to a Schema, and return a BoxKey that points to them. More...

Detailed Description

template<typename Box>
class lsst::afw::table::BoxKey< Box >

A FunctorKey used to get or set a lsst::geom::Box2I or Box2D from a (min, max) pair of PointKeys.

The Box2IKey and Box2DKey typedefs should be preferred to using the template name directly.

Definition at line 126 of file aggregates.h.

Member Typedef Documentation

Element

template<typename Box >

using lsst::afw::table::BoxKey< Box >::Element = typename Box::Element

Type of coordinate elements (i.e. int or double).

Definition at line 129 of file aggregates.h.

Value

using lsst::afw::table::FunctorKey< Box >::Value = Box

inherited

The data type for get and set.

Definition at line 77 of file FunctorKey.h.

Constructor & Destructor Documentation

BoxKey() [1/5]

template<typename Box >

lsst::afw::table::BoxKey< Box >::BoxKey ( )

defaultnoexcept

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

BoxKey() [2/5]

template<typename Box >

lsst::afw::table::BoxKey< Box >::BoxKey ( PointKey< Element > const &  min, PointKey< Element > const &  max  )

inlinenoexcept

Construct from a pair of PointKeys.

Definition at line 151 of file aggregates.h.

: _min(min), _max(max) {}

BoxKey() [3/5]

template<typename Box >

lsst::afw::table::BoxKey< Box >::BoxKey ( SubSchema const &  s )

inline

Construct from a subschema, assuming _min_x, _max_x, _min_y, _max_y subfields.

If a schema has "a_min_x" and "a_min_x" (etc) fields, this constructor allows you to construct a BoxKey via:

BoxKey<Box> k(schema["a"]);

Definition at line 161 of file aggregates.h.

: _min(s["min"]), _max(s["max"]) {}

BoxKey() [4/5]

template<typename Box >

lsst::afw::table::BoxKey< Box >::BoxKey ( BoxKey< Box > const &  )

defaultnoexcept

BoxKey() [5/5]

template<typename Box >

lsst::afw::table::BoxKey< Box >::BoxKey ( BoxKey< Box > &&  )

defaultnoexcept

~BoxKey()

template<typename Box >

lsst::afw::table::BoxKey< Box >::~BoxKey ( )

overridedefaultnoexcept

Member Function Documentation

addFields()

template<typename Box >

BoxKey< Box > lsst::afw::table::BoxKey< Box >::addFields ( Schema &  schema, std::string const &  name, std::string const &  doc, std::string const &  unit  )

static

Add _min_x, _min_y, _max_x, _max_y fields to a Schema, and return a BoxKey that points to them.

Parameters

[in,out]	schema	Schema to add fields to.
[in]	name	Name prefix for all fields; suffixes above will be appended to this to form the full field names. For example, if name == "b", the fields added will be "b_min_x", "b_min_y", "b_max_x", and "b_max_y".
[in]	doc	String used as the documentation for the fields.
[in]	unit	String used as the unit for all fields.

Definition at line 60 of file aggregates.cc.

                                                          {
    auto minKey = PointKey<Element>::addFields(schema, schema.join(name, "min"), doc + " (minimum)", unit);
    auto maxKey = PointKey<Element>::addFields(schema, schema.join(name, "max"), doc + " (maximum)", unit);
    return BoxKey<Box>(minKey, maxKey);
}

get()

template<typename Box >

Box lsst::afw::table::BoxKey< Box >::get ( BaseRecord const &  record ) const

overridevirtual

Get a Box from the given record.

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

Definition at line 68 of file aggregates.cc.

                                                   {
    return Box(record.get(_min), record.get(_max), /*invert=*/false);
}

getMax()

template<typename Box >

PointKey<Element> lsst::afw::table::BoxKey< Box >::getMax ( ) const

inlinenoexcept

Return the underlying max PointKey.

Definition at line 194 of file aggregates.h.

{ return _max; }

getMin()

template<typename Box >

PointKey<Element> lsst::afw::table::BoxKey< Box >::getMin ( ) const

inlinenoexcept

Return the underlying min PointKey.

Definition at line 191 of file aggregates.h.

{ return _min; }

hash_value()

template<typename Box >

std::size_t lsst::afw::table::BoxKey< Box >::hash_value ( ) const

inlinenoexcept

Return a hash of this object.

Definition at line 170 of file aggregates.h.

                                          {
        // Completely arbitrary seed
        return utils::hashCombine(17, _min, _max);
    }

isValid()

template<typename Box >

bool lsst::afw::table::BoxKey< Box >::isValid ( ) const

inlinenoexcept

Return True if both the min and max PointKeys are valid.

Definition at line 188 of file aggregates.h.

{ return _min.isValid() && _max.isValid(); }

operator!=()

template<typename Box >

bool lsst::afw::table::BoxKey< Box >::operator!= ( BoxKey< Box > const &  other ) const

inlinenoexcept

Definition at line 184 of file aggregates.h.

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

operator=() [1/2]

template<typename Box >

BoxKey& lsst::afw::table::BoxKey< Box >::operator= ( BoxKey< Box > &&  )

defaultnoexcept

operator=() [2/2]

template<typename Box >

BoxKey& lsst::afw::table::BoxKey< Box >::operator= ( BoxKey< Box > const &  )

defaultnoexcept

operator==()

template<typename Box >

bool lsst::afw::table::BoxKey< Box >::operator== ( BoxKey< Box > const &  other ) const

inlinenoexcept

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

Definition at line 183 of file aggregates.h.

{ return _min == other._min && _max == other._max; }

set() [1/2]

template<typename Box >

void lsst::afw::table::BoxKey< Box >::set ( BaseRecord &  record, Box const &  value  ) const

override

Set a Box in the given record.

Definition at line 73 of file aggregates.cc.

                                                                {
    _min.set(record, value.getMin());
    _max.set(record, value.getMax());
}

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/0.4.3/Linux64/afw/21.0.0-25-g1d57be3cd+e73869a214/include/lsst/afw/table/aggregates.h
• /j/snowflake/release/lsstsw/stack/0.4.3/Linux64/afw/21.0.0-25-g1d57be3cd+e73869a214/src/table/aggregates.cc