LSSTApplications
20.0.0
LSSTDataManagementBasePackage
|
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, FluxResult 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< FluxResult >.
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 |