LSSTApplications  19.0.0-10-g920eed2,19.0.0-11-g48a0200+2,19.0.0-18-gfc4e62b+10,19.0.0-2-g3b2f90d+2,19.0.0-2-gd671419+5,19.0.0-20-g5a5a17ab+8,19.0.0-21-g2644856+10,19.0.0-22-gc5dc5b1+5,19.0.0-23-gdc29a50+2,19.0.0-24-g923e380+10,19.0.0-25-g6c8df7140,19.0.0-27-g567f04d+6,19.0.0-3-g2b32d65+5,19.0.0-3-g8227491+9,19.0.0-3-g9c54d0d+9,19.0.0-3-gca68e65+5,19.0.0-3-gcfc5f51+5,19.0.0-3-ge110943+8,19.0.0-3-ge74d124,19.0.0-3-gfe04aa6+10,19.0.0-4-g06f5963+5,19.0.0-4-g3d16501+10,19.0.0-4-g4a9c019+5,19.0.0-4-g5a8b323,19.0.0-4-g66397f0+1,19.0.0-4-g8278b9b+1,19.0.0-4-g8557e14,19.0.0-4-g8964aba+10,19.0.0-4-ge404a01+9,19.0.0-5-g40f3a5a,19.0.0-5-g4db63b3,19.0.0-5-gfb03ce7+10,19.0.0-6-gbaebbfb+9,19.0.0-60-gafafd468+10,19.0.0-64-gf672fef+7,19.0.0-7-g039c0b5+8,19.0.0-7-gbea9075+4,19.0.0-7-gc567de5+10,19.0.0-8-g3a3ce09+5,19.0.0-9-g463f923+9,w.2020.21
LSSTDataManagementBasePackage
Public Types | Public Member Functions | Static Public Member Functions | List of all members
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 >:
lsst::afw::table::FunctorKey< Box > lsst::afw::table::OutputFunctorKey< Box > lsst::afw::table::InputFunctorKey< 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
 
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...
 

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.

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

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

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

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

Definition at line 68 of file aggregates.cc.

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

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

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

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

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

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

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

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

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

◆ set()

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

Set a Box in the given record.

Implements lsst::afw::table::InputFunctorKey< Box >.

Definition at line 73 of file aggregates.cc.

73  {
74  _min.set(record, value.getMin());
75  _max.set(record, value.getMax());
76 }

The documentation for this class was generated from the following files:
schema
table::Schema schema
Definition: Amplifier.cc:115
lsst::afw::table::PointKey::set
void set(BaseRecord &record, lsst::geom::Point< T, 2 > const &value) const override
Set a Point in the given record.
Definition: aggregates.cc:49
lsst::afw::table::PointKey::addFields
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.
Definition: aggregates.cc:36
lsst::afw::geom.transform.transformContinued.name
string name
Definition: transformContinued.py:32
lsst::afw::table::PointKey::isValid
bool isValid() const noexcept
Return True if both the x and y Keys are valid.
Definition: aggregates.h:104
other
ItemVariant const * other
Definition: Schema.cc:56
max
int max
Definition: BoundedField.cc:104
lsst::utils::hashCombine
std::size_t hashCombine(std::size_t seed) noexcept
Combine hashes.
Definition: hashCombine.h:35
min
int min
Definition: BoundedField.cc:103