LSST Applications
21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
|
A FunctorKey used to get or set a lsst::geom::Box2I or Box2D from a (min, max) pair of PointKeys. More...
#include <aggregates.h>
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... | |
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.
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.
|
inherited |
The data type for get and set.
Definition at line 77 of file FunctorKey.h.
|
defaultnoexcept |
Default constructor; instance will not be usable unless subsequently assigned to.
|
inlinenoexcept |
|
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.
|
defaultnoexcept |
|
defaultnoexcept |
|
overridedefaultnoexcept |
|
static |
Add _min_x, _min_y, _max_x, _max_y fields to a Schema, and return a BoxKey that points to them.
[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.
|
overridevirtual |
Get a Box from the given record.
Implements lsst::afw::table::OutputFunctorKey< T >.
Definition at line 68 of file aggregates.cc.
|
inlinenoexcept |
Return the underlying max PointKey.
Definition at line 194 of file aggregates.h.
|
inlinenoexcept |
Return the underlying min PointKey.
Definition at line 191 of file aggregates.h.
|
inlinenoexcept |
Return a hash of this object.
Definition at line 170 of file aggregates.h.
|
inlinenoexcept |
Return True if both the min and max PointKeys are valid.
Definition at line 188 of file aggregates.h.
|
inlinenoexcept |
Definition at line 184 of file aggregates.h.
|
defaultnoexcept |
|
defaultnoexcept |
|
inlinenoexcept |
Compare the FunctorKey for equality with another, using the underlying x and y Keys.
Definition at line 183 of file aggregates.h.
|
override |
Set a Box in the given record.
Definition at line 73 of file aggregates.cc.
|
pure virtualinherited |