LSST Applications g04a91732dc+a777afbe81,g07dc498a13+7e3c5f68a2,g12483e3c20+0145ec33cd,g1409bbee79+7e3c5f68a2,g1a7e361dbc+7e3c5f68a2,g1fd858c14a+9f35e23ec3,g35bb328faa+fcb1d3bbc8,g3ad4f90e5c+0145ec33cd,g3bd4b5ce2c+cbf1bea503,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g5477a8d5ce+db04660fe6,g60b5630c4e+0145ec33cd,g623d845a50+0145ec33cd,g6f0c2978f1+3526b51a37,g75b6c65c88+d54b601591,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+4639f750a5,g89139ef638+7e3c5f68a2,g9125e01d80+fcb1d3bbc8,g919ac25b3e+6220c5324a,g95236ca021+f7a31438ed,g989de1cb63+7e3c5f68a2,g9f33ca652e+2d6fa11d35,gaaedd4e678+7e3c5f68a2,gabe3b4be73+1e0a283bba,gb1101e3267+4a428ef779,gb4a253aaf5+0122250889,gb58c049af0+f03b321e39,gc99c83e5f0+76d20ab76d,gcf25f946ba+4639f750a5,gd6cbbdb0b4+c8606af20c,gde0f65d7ad+3d8a3b7e46,ge278dab8ac+932305ba37,gf795337580+03b96afe58,gfba249425e+fcb1d3bbc8,w.2025.08
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.