LSSTApplications  19.0.0-10-g920eed2,19.0.0-11-g48a0200+2,19.0.0-18-gfc4e62b+11,19.0.0-2-g3b2f90d+2,19.0.0-2-gd671419+5,19.0.0-20-g5a5a17ab+9,19.0.0-21-g2644856+11,19.0.0-22-gc5dc5b1+6,19.0.0-23-gdc29a50+3,19.0.0-24-g923e380+11,19.0.0-25-g6c8df7140,19.0.0-28-g9b887e2,19.0.0-3-g2b32d65+5,19.0.0-3-g8227491+10,19.0.0-3-g9c54d0d+10,19.0.0-3-gca68e65+6,19.0.0-3-gcfc5f51+5,19.0.0-3-ge110943+9,19.0.0-3-ge74d124,19.0.0-3-gfe04aa6+11,19.0.0-4-g06f5963+5,19.0.0-4-g3d16501+11,19.0.0-4-g4a9c019+5,19.0.0-4-g5a8b323,19.0.0-4-g66397f0+1,19.0.0-4-g8278b9b+1,19.0.0-4-g8557e14,19.0.0-4-g8964aba+11,19.0.0-4-ge404a01+10,19.0.0-5-g40f3a5a,19.0.0-5-g4db63b3,19.0.0-5-gfb03ce7+11,19.0.0-6-gbaebbfb+10,19.0.0-60-gafafd468+11,19.0.0-67-g3ab1e6e,19.0.0-7-g039c0b5+9,19.0.0-7-gbea9075+4,19.0.0-7-gc567de5+11,19.0.0-8-g3a3ce09+6,19.0.0-9-g463f923+10,w.2020.21
LSSTDataManagementBasePackage
Public Types | Public Member Functions | Static Public Member Functions | List of all members
lsst::meas::base::FluxResultKey Class Referenceabstract

A FunctorKey for FluxResult. More...

#include <FluxUtilities.h>

Inheritance diagram for lsst::meas::base::FluxResultKey:
lsst::afw::table::FunctorKey< FluxResult > lsst::afw::table::OutputFunctorKey< FluxResult > lsst::afw::table::InputFunctorKey< FluxResult >

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::FluxgetInstFlux () const
 Return the underlying instFlux Key. More...
 
afw::table::Key< FluxErrElementgetInstFluxErr () 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...
 

Detailed Description

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.

Member Typedef Documentation

◆ Value

The data type for get and set.

Definition at line 77 of file FunctorKey.h.

Constructor & Destructor Documentation

◆ FluxResultKey() [1/3]

lsst::meas::base::FluxResultKey::FluxResultKey ( )
inline

Default constructor; instance will not be usuable unless subsequently assigned to.

Definition at line 76 of file FluxUtilities.h.

76 : _instFlux(), _instFluxErr() {}

◆ FluxResultKey() [2/3]

lsst::meas::base::FluxResultKey::FluxResultKey ( afw::table::Key< meas::base::Flux > const &  instFlux,
afw::table::Key< meas::base::FluxErrElement > const &  instFluxErr 
)
inline

Construct from a pair of Keys.

Definition at line 79 of file FluxUtilities.h.

82  : _instFlux(instFlux), _instFluxErr(instFluxErr) {}

◆ FluxResultKey() [3/3]

lsst::meas::base::FluxResultKey::FluxResultKey ( afw::table::SubSchema const &  s)
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.

94  : _instFlux(s["instFlux"]), _instFluxErr(s["instFluxErr"]) {}

Member Function Documentation

◆ addFields()

FluxResultKey lsst::meas::base::FluxResultKey::addFields ( afw::table::Schema schema,
std::string const &  name,
std::string const &  doc 
)
static

Add a pair of _instFlux, _instFluxErr fields to a Schema, and return a FluxResultKey that points to them.

Parameters
[in,out]schemaSchema to add fields to.
[in]nameName prefix for all fields; "_instFlux", "_instFluxErr" will be appended to this to form the full field names.
[in]docString used as the documentation for the fields.

The unit for both fields will be "count".

Definition at line 36 of file FluxUtilities.cc.

37  {
39  result._instFlux = schema.addField<meas::base::Flux>(schema.join(name, "instFlux"), doc, "count");
40  result._instFluxErr = schema.addField<meas::base::FluxErrElement>(
41  schema.join(name, "instFluxErr"), "1-sigma instFlux uncertainty", "count");
42  return result;
43 }

◆ get()

FluxResult lsst::meas::base::FluxResultKey::get ( afw::table::BaseRecord const &  record) const
virtual

Get a FluxResult from the given record.

Implements lsst::afw::table::OutputFunctorKey< FluxResult >.

Definition at line 45 of file FluxUtilities.cc.

45  {
46  FluxResult r;
47  r.instFlux = record.get(_instFlux);
48  r.instFluxErr = record.get(_instFluxErr);
49  return r;
50 }

◆ getInstFlux()

afw::table::Key<meas::base::Flux> lsst::meas::base::FluxResultKey::getInstFlux ( ) const
inline

Return the underlying instFlux Key.

Definition at line 114 of file FluxUtilities.h.

114 { return _instFlux; }

◆ getInstFluxErr()

afw::table::Key<FluxErrElement> lsst::meas::base::FluxResultKey::getInstFluxErr ( ) const
inline

Return the underlying instFluxErr Key.

Definition at line 117 of file FluxUtilities.h.

117 { return _instFluxErr; }

◆ isValid()

bool lsst::meas::base::FluxResultKey::isValid ( ) const
inline

Return True if both the instFlux and instFluxErr Keys are valid.

Definition at line 111 of file FluxUtilities.h.

111 { return _instFlux.isValid() && _instFluxErr.isValid(); }

◆ operator!=()

bool lsst::meas::base::FluxResultKey::operator!= ( FluxResultKey const &  other) const
inline

Definition at line 107 of file FluxUtilities.h.

107 { return !(*this == other); }

◆ operator==()

bool lsst::meas::base::FluxResultKey::operator== ( FluxResultKey const &  other) const
inline

Compare the FunctorKey for equality with another, using the underlying instFlux and instFluxErr Keys.

Definition at line 104 of file FluxUtilities.h.

104  {
105  return _instFlux == other._instFlux && _instFluxErr == other._instFluxErr;
106  }

◆ set() [1/2]

void lsst::meas::base::FluxResultKey::set ( afw::table::BaseRecord record,
FluxResult const &  other 
) const
virtual

Set a FluxResult in the given record.

Definition at line 52 of file FluxUtilities.cc.

52  {
53  record.set(_instFlux, value.instFlux);
54  record.set(_instFluxErr, value.instFluxErr);
55 }

◆ set() [2/2]

virtual void lsst::afw::table::InputFunctorKey< FluxResult >::set ( BaseRecord record,
FluxResult const &  value 
) const
pure virtualinherited

The documentation for this class was generated from the following files:
schema
table::Schema schema
Definition: Amplifier.cc:115
lsst::meas::base::FluxErrElement
double FluxErrElement
Definition: constants.h:52
lsst::afw::geom.transform.transformContinued.name
string name
Definition: transformContinued.py:32
lsst::meas::base::FluxResultKey::FluxResultKey
FluxResultKey()
Default constructor; instance will not be usuable unless subsequently assigned to.
Definition: FluxUtilities.h:76
other
ItemVariant const * other
Definition: Schema.cc:56
lsst::afw::table::Key::isValid
bool isValid() const noexcept
Return true if the key was initialized to valid offset.
Definition: Key.h:97
result
py::object result
Definition: _schema.cc:429
lsst::meas::base::Flux
double Flux
Definition: constants.h:51