lsst.meas.base  16.0-12-g5ad1ebf+4
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< T > lsst::afw::table::InputFunctorKey< T >

Public Types

typedef FluxResult Value
 

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 &fluxErr)
 Construct from a pair of Keys. More...
 
 FluxResultKey (afw::table::SubSchema const &s)
 Construct from a subschema, assuming flux and fluxErr 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 fluxErr Keys are valid. More...
 
afw::table::Key< meas::base::FluxgetFlux () const
 Return the underlying flux Key. More...
 
afw::table::Key< FluxErrElementgetFluxErr () const
 Return the underlying fluxErr Key. More...
 
virtual void set (BaseRecord &record, FluxResult const &value) const =0
 
virtual void set (BaseRecord &record, T const &value) const=0
 
bool operator== (FluxResultKey const &other) const
 Compare the FunctorKey for equality with another, using the underlying flux and fluxErr Keys. More...
 
bool operator!= (FluxResultKey const &other) const
 Compare the FunctorKey for equality with another, using the underlying flux and fluxErr Keys. More...
 

Static Public Member Functions

static FluxResultKey addFields (afw::table::Schema &schema, std::string const &name, std::string const &doc)
 Add a pair of _flux, _fluxErr 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 fluxes and their uncertainties to and from records, and provides a method to add the appropriate fields to a Schema.

Definition at line 58 of file FluxUtilities.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 74 of file FluxUtilities.h.

◆ FluxResultKey() [2/3]

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

Construct from a pair of Keys.

Definition at line 77 of file FluxUtilities.h.

◆ FluxResultKey() [3/3]

lsst::meas::base::FluxResultKey::FluxResultKey ( afw::table::SubSchema const &  s)
inline

Construct from a subschema, assuming flux and fluxErr subfields.

If a schema has "a_flux" and "a_fluxErr" fields, this constructor allows you to construct a FluxResultKey via:

FluxResultKey k(schema["a"]);

Definition at line 90 of file FluxUtilities.h.

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 _flux, _fluxErr 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; "_flux", "_fluxErr" 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.

◆ 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::FunctorKey< FluxResult >.

Definition at line 45 of file FluxUtilities.cc.

◆ getFlux()

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

Return the underlying flux Key.

Definition at line 110 of file FluxUtilities.h.

◆ getFluxErr()

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

Return the underlying fluxErr Key.

Definition at line 113 of file FluxUtilities.h.

◆ isValid()

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

Return True if both the flux and fluxErr Keys are valid.

Definition at line 107 of file FluxUtilities.h.

◆ operator!=()

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

Compare the FunctorKey for equality with another, using the underlying flux and fluxErr Keys.

Definition at line 103 of file FluxUtilities.h.

◆ operator==()

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

Compare the FunctorKey for equality with another, using the underlying flux and fluxErr Keys.

Definition at line 100 of file FluxUtilities.h.

◆ set()

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.


The documentation for this class was generated from the following files: