LSST Applications
21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
|
A FunctorKey for FluxResult. More...
#include <FluxUtilities.h>
Public Types | |
using | Value = FluxResult |
The data type for get and set. More... | |
Public Member Functions | |
FluxResultKey () | |
Default constructor; instance will not be usuable unless subsequently assigned to. More... | |
FluxResultKey (afw::table::Key< meas::base::Flux > const &instFlux, afw::table::Key< meas::base::FluxErrElement > const &instFluxErr) | |
Construct from a pair of Keys. More... | |
FluxResultKey (afw::table::SubSchema const &s) | |
Construct from a subschema, assuming instFlux and instFluxErr subfields. More... | |
virtual FluxResult | get (afw::table::BaseRecord const &record) const |
Get a FluxResult from the given record. More... | |
virtual void | set (afw::table::BaseRecord &record, FluxResult const &other) const |
Set a FluxResult in the given record. More... | |
bool | operator== (FluxResultKey const &other) const |
Compare the FunctorKey for equality with another, using the underlying instFlux and instFluxErr Keys. More... | |
bool | operator!= (FluxResultKey const &other) const |
bool | isValid () const |
Return True if both the instFlux and instFluxErr Keys are valid. More... | |
afw::table::Key< meas::base::Flux > | getInstFlux () const |
Return the underlying instFlux Key. More... | |
afw::table::Key< FluxErrElement > | getInstFluxErr () const |
Return the underlying instFluxErr Key. More... | |
virtual void | set (BaseRecord &record, T const &value) const =0 |
Static Public Member Functions | |
static FluxResultKey | addFields (afw::table::Schema &schema, std::string const &name, std::string const &doc) |
Add a pair of _instFlux, _instFluxErr fields to a Schema, and return a FluxResultKey that points to them. More... | |
A FunctorKey for FluxResult.
This class makes it easy to copy instFluxes and their uncertainties to and from records, and provides a method to add the appropriate fields to a Schema.
Definition at line 59 of file FluxUtilities.h.
|
inherited |
The data type for get and set.
Definition at line 77 of file FunctorKey.h.
|
inline |
Default constructor; instance will not be usuable unless subsequently assigned to.
Definition at line 76 of file FluxUtilities.h.
|
inline |
Construct from a pair of Keys.
Definition at line 79 of file FluxUtilities.h.
|
inline |
Construct from a subschema, assuming instFlux and instFluxErr subfields.
If a schema has "a_instFlux" and "a_instFluxErr" fields, this constructor allows you to construct a FluxResultKey via:
Definition at line 93 of file FluxUtilities.h.
|
static |
Add a pair of _instFlux, _instFluxErr fields to a Schema, and return a FluxResultKey that points to them.
[in,out] | schema | Schema to add fields to. |
[in] | name | Name prefix for all fields; "_instFlux", "_instFluxErr" will be appended to this to form the full field names. |
[in] | doc | String used as the documentation for the fields. |
The unit for both fields will be "count".
Definition at line 36 of file FluxUtilities.cc.
|
virtual |
Get a FluxResult from the given record.
Implements lsst::afw::table::OutputFunctorKey< T >.
Definition at line 45 of file FluxUtilities.cc.
|
inline |
Return the underlying instFlux Key.
Definition at line 114 of file FluxUtilities.h.
|
inline |
Return the underlying instFluxErr Key.
Definition at line 117 of file FluxUtilities.h.
|
inline |
Return True if both the instFlux and instFluxErr Keys are valid.
Definition at line 111 of file FluxUtilities.h.
|
inline |
Definition at line 107 of file FluxUtilities.h.
|
inline |
Compare the FunctorKey for equality with another, using the underlying instFlux and instFluxErr Keys.
Definition at line 104 of file FluxUtilities.h.
|
virtual |
Set a FluxResult in the given record.
Definition at line 52 of file FluxUtilities.cc.
|
pure virtualinherited |