lsst::meas::base::FluxResultKey Class Reference

A FunctorKey for FluxResult. More...

#include <FluxUtilities.h>

Inheritance diagram for lsst::meas::base::FluxResultKey:

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

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 55 of file FluxUtilities.h.

Constructor & Destructor Documentation

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

inline

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

Definition at line 75 of file FluxUtilities.h.

: _flux(), _fluxSigma() {}

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

inline

Construct from a pair of Keys.

Definition at line 78 of file FluxUtilities.h.

      :
        _flux(flux), _fluxSigma(fluxSigma)
    {}

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

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:

*  FluxResultKey k(schema["a"]);
*  

Definition at line 94 of file FluxUtilities.h.

: _flux(s["flux"]), _fluxSigma(s["fluxSigma"]) {}

Member Function Documentation

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

static

Add a pair of _flux, _fluxSigma fields to a Schema, and return a FluxResultKey that points to them.

Parameters

[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 34 of file FluxUtilities.cc.

  {
    FluxResultKey result;
    result._flux = schema.addField<Flux>(schema.join(name, "flux"), doc, "dn");
    result._fluxSigma = schema.addField<FluxErrElement>(schema.join(name, "fluxSigma"),
                                                        "1-sigma flux uncertainty", "dn");
    return result;
}

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 46 of file FluxUtilities.cc.

                                                                     {
    FluxResult r;
    r.flux = record.get(_flux);
    r.fluxSigma = record.get(_fluxSigma);
    return r;
}

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

inline

Return the underlying flux Key.

Definition at line 114 of file FluxUtilities.h.

{ return _flux; }

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

inline

Return the underlying fluxSigma Key.

Definition at line 117 of file FluxUtilities.h.

{ return _fluxSigma; }

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

inline

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

Definition at line 111 of file FluxUtilities.h.

{ return _flux.isValid() && _fluxSigma.isValid(); }

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

inline

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

Definition at line 107 of file FluxUtilities.h.

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

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

inline

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

Definition at line 104 of file FluxUtilities.h.

                                                       {
        return _flux == other._flux && _fluxSigma == other._fluxSigma;
    }

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 53 of file FluxUtilities.cc.

                                                                                   {
    record.set(_flux, value.flux);
    record.set(_fluxSigma, value.fluxSigma);
}

Member Data Documentation

afw::table::Key<Flux> lsst::meas::base::FluxResultKey::_flux

private

Definition at line 120 of file FluxUtilities.h.

afw::table::Key<FluxErrElement> lsst::meas::base::FluxResultKey::_fluxSigma

private

Definition at line 121 of file FluxUtilities.h.

---

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

• /lsst/home/lsstsw/stack/Linux64/meas_base/master-g15627eb03c/include/lsst/meas/base/FluxUtilities.h
• /lsst/home/lsstsw/stack/Linux64/meas_base/master-g15627eb03c/src/FluxUtilities.cc