LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
|
A FunctorKey used to get or set a lsst::geom::Box2I or Box2D from a (min, max) pair of Point3Keys. More...
#include <aggregates.h>
Public Types | |
using | Element = typename Box::Element |
Type of coordinate elements (i.e. int or double). | |
using | Value |
The data type for get and set. | |
Public Member Functions | |
BoxKey () noexcept=default | |
Default constructor; instance will not be usable unless subsequently assigned to. | |
BoxKey (PointKey< Element > const &min, PointKey< Element > const &max) noexcept | |
Construct from a pair of PointKeys. | |
BoxKey (SubSchema const &s) | |
Construct from a subschema, assuming _min_x, _max_x, _min_y, _max_y subfields. | |
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. | |
Box | get (BaseRecord const &record) const override |
Get a Box from the given record. | |
void | set (BaseRecord &record, Box const &value) const override |
Set a Box in the given record. | |
bool | operator== (BoxKey const &other) const noexcept |
Compare the FunctorKey for equality with another, using the underlying x and y Keys. | |
bool | operator!= (BoxKey const &other) const noexcept |
bool | isValid () const noexcept |
Return True if both the min and max PointKeys are valid. | |
PointKey< Element > | getMin () const noexcept |
Return the underlying min PointKey. | |
PointKey< Element > | getMax () const noexcept |
Return the underlying max PointKey. | |
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. | |
A FunctorKey used to get or set a lsst::geom::Box2I or Box2D from a (min, max) pair of Point3Keys.
The Box2IKey and Box2DKey typedefs should be preferred to using the template name directly.
Definition at line 208 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 211 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 243 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 86 of file aggregates.cc.
|
overridevirtual |
Get a Box from the given record.
Implements lsst::afw::table::OutputFunctorKey< T >.
Definition at line 94 of file aggregates.cc.
|
inlinenoexcept |
Return the underlying max PointKey.
Definition at line 276 of file aggregates.h.
|
inlinenoexcept |
Return the underlying min PointKey.
Definition at line 273 of file aggregates.h.
|
inlinenoexcept |
Return a hash of this object.
Definition at line 252 of file aggregates.h.
|
inlinenoexcept |
Return True if both the min and max PointKeys are valid.
Definition at line 270 of file aggregates.h.
|
inlinenoexcept |
Definition at line 266 of file aggregates.h.
|
defaultnoexcept |
|
defaultnoexcept |
|
inlinenoexcept |
Compare the FunctorKey for equality with another, using the underlying x and y Keys.
Definition at line 265 of file aggregates.h.
|
override |
Set a Box in the given record.
Definition at line 99 of file aggregates.cc.
|
pure virtualinherited |