LSSTApplications
18.0.0+106,18.0.0+50,19.0.0,19.0.0+1,19.0.0+10,19.0.0+11,19.0.0+13,19.0.0+17,19.0.0+2,19.0.0-1-g20d9b18+6,19.0.0-1-g425ff20,19.0.0-1-g5549ca4,19.0.0-1-g580fafe+6,19.0.0-1-g6fe20d0+1,19.0.0-1-g7011481+9,19.0.0-1-g8c57eb9+6,19.0.0-1-gb5175dc+11,19.0.0-1-gdc0e4a7+9,19.0.0-1-ge272bc4+6,19.0.0-1-ge3aa853,19.0.0-10-g448f008b,19.0.0-12-g6990b2c,19.0.0-2-g0d9f9cd+11,19.0.0-2-g3d9e4fb2+11,19.0.0-2-g5037de4,19.0.0-2-gb96a1c4+3,19.0.0-2-gd955cfd+15,19.0.0-3-g2d13df8,19.0.0-3-g6f3c7dc,19.0.0-4-g725f80e+11,19.0.0-4-ga671dab3b+1,19.0.0-4-gad373c5+3,19.0.0-5-ga2acb9c+2,19.0.0-5-gfe96e6c+2,w.2020.01
LSSTDataManagementBasePackage
|
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 | 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... | |
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 |
Compare the FunctorKey for equality with another, using the underlying x and y Keys. 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... | |
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< Box >.
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 |
Compare the FunctorKey for equality with another, using the underlying x and y Keys.
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.
|
overridevirtual |
Set a Box in the given record.
Implements lsst::afw::table::InputFunctorKey< Box >.
Definition at line 73 of file aggregates.cc.