LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
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. | |
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 |
Construct from a pair of PointKeys.
Definition at line 233 of file aggregates.h.
|
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< Box >.
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.
|
overridevirtual |
Set a Box in the given record.
Implements lsst::afw::table::InputFunctorKey< Box >.
Definition at line 99 of file aggregates.cc.