LSSTApplications
10.0+286,10.0+36,10.0+46,10.0-2-g4f67435,10.1+152,10.1+37,11.0,11.0+1,11.0-1-g47edd16,11.0-1-g60db491,11.0-1-g7418c06,11.0-2-g04d2804,11.0-2-g68503cd,11.0-2-g818369d,11.0-2-gb8b8ce7
LSSTDataManagementBasePackage
|
A FunctorKey for FluxResult. More...
#include <FluxUtilities.h>
Public Member Functions | |
FluxResultKey () | |
Default constructor; instance will not be usuable unless subsequently assigned to. More... | |
FluxResultKey (afw::table::Key< meas::base::Flux > const &flux, afw::table::Key< FluxErrElement > const &fluxSigma) | |
Construct from a pair of Keys. More... | |
FluxResultKey (afw::table::SubSchema const &s) | |
Construct from a subschema, assuming flux and fluxSigma 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 | isValid () const |
Return True if both the flux and fluxSigma Keys are valid. More... | |
afw::table::Key< meas::base::Flux > | getFlux () const |
Return the underlying flux Key. More... | |
afw::table::Key< FluxErrElement > | getFluxSigma () const |
Return the underlying fluxSigma Key. More... | |
bool | operator== (FluxResultKey const &other) const |
Compare the FunctorKey for equality with another, using the underlying flux and fluxSigma Keys. More... | |
bool | operator!= (FluxResultKey const &other) const |
Compare the FunctorKey for equality with another, using the underlying flux and fluxSigma Keys. More... | |
Public Member Functions inherited from lsst::afw::table::OutputFunctorKey< FluxResult > | |
virtual | ~OutputFunctorKey () |
Public Member Functions inherited from lsst::afw::table::InputFunctorKey< FluxResult > | |
virtual void | set (BaseRecord &record, FluxResultconst &value) const =0 |
virtual | ~InputFunctorKey () |
Static Public Member Functions | |
static FluxResultKey | addFields (afw::table::Schema &schema, std::string const &name, std::string const &doc) |
Private Attributes | |
afw::table::Key< Flux > | _flux |
afw::table::Key< FluxErrElement > | _fluxSigma |
A FunctorKey for FluxResult.
This class makes it easy to copy fluxes and their uncertainties to and from records, and provides a method to add the appropriate fields to a Schema.
Definition at line 56 of file FluxUtilities.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 flux and fluxSigma subfields.
If a schema has "a_flux" and "a_fluxSigma" fields, this constructor allows you to construct a FluxResultKey via:
Definition at line 95 of file FluxUtilities.h.
|
static |
Add a pair of _flux, _fluxSigma 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; "_flux", "_fluxSigma" 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 "dn".
Definition at line 35 of file FluxUtilities.cc.
|
virtual |
Get a FluxResult from the given record.
Implements lsst::afw::table::OutputFunctorKey< FluxResult >.
Definition at line 47 of file FluxUtilities.cc.
|
inline |
|
inline |
Return the underlying fluxSigma Key.
Definition at line 118 of file FluxUtilities.h.
|
inline |
Return True if both the flux and fluxSigma Keys are valid.
Definition at line 112 of file FluxUtilities.h.
|
inline |
Compare the FunctorKey for equality with another, using the underlying flux and fluxSigma Keys.
Definition at line 108 of file FluxUtilities.h.
|
inline |
Compare the FunctorKey for equality with another, using the underlying flux and fluxSigma Keys.
Definition at line 105 of file FluxUtilities.h.
|
virtual |
Set a FluxResult in the given record.
Definition at line 54 of file FluxUtilities.cc.
|
private |
Definition at line 121 of file FluxUtilities.h.
|
private |
Definition at line 122 of file FluxUtilities.h.