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

A FunctorKey for FluxResult. More...

#include <FluxUtilities.h>

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

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, T 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

using lsst::afw::table::FunctorKey< FluxResult >::Value = FluxResult

inherited

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.

: _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.

            : _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:

FluxResultKey k(schema["a"]);

Definition at line 93 of file FluxUtilities.h.

            : _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]	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.

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

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< T >.

Definition at line 45 of file FluxUtilities.cc.

                                                                    {
    FluxResult r;
    r.instFlux = record.get(_instFlux);
    r.instFluxErr = record.get(_instFluxErr);
    return r;
}

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.

{ 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.

{ 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.

{ 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.

{ 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.

                                                      {
        return _instFlux == other._instFlux && _instFluxErr == other._instFluxErr;
    }

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.

                                                                                 {
    record.set(_instFlux, value.instFlux);
    record.set(_instFluxErr, value.instFluxErr);
}

set() [2/2]

template<typename T >

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

pure virtualinherited

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_base/22.0.1-19-g93a5c75+d23f2fb6d8/include/lsst/meas/base/FluxUtilities.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_base/22.0.1-19-g93a5c75+d23f2fb6d8/src/FluxUtilities.cc