lsst.afw  21.0.0-13-g512c41855+47cba9fc36
Public Types | Public Member Functions | Static Public Member Functions | List of all members
lsst::afw::table::BoxKey< Box > Class Template Referenceabstract

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 >:
lsst::afw::table::FunctorKey< Box > lsst::afw::table::OutputFunctorKey< T > lsst::afw::table::InputFunctorKey< T >

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
 
BoxKeyoperator= (BoxKey const &) noexcept=default
 
BoxKeyoperator= (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< ElementgetMin () const noexcept
 Return the underlying min PointKey. More...
 
PointKey< ElementgetMax () 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.

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

◆ 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]schemaSchema to add fields to.
[in]nameName 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]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.

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

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

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

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

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

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

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

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

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