lsst::afw::table::FluxSlotDefinition Class Reference

SlotDefinition specialization for fluxes. More...

#include <slots.h>

Inheritance diagram for lsst::afw::table::FluxSlotDefinition:

Public Types
using	MeasValue = double
	Type returned by accessing the slot measurement. More...
using	ErrValue = double
	Type returned by accessing the slot uncertainty. More...
using	MeasKey = Key< double >
	Key type used to access the slot measurement. More...
using	ErrKey = Key< double >
	Key type used to access the slot uncertainty. More...

Public Member Functions
	FluxSlotDefinition (std::string const &name)
	Construct a SlotDefinition from the name of the slot (e.g. "PsfFlux") More...
bool	isValid () const
	Return true if the key associated with the measurement is valid. More...
MeasKey	getMeasKey () const
	Return the cached Key used to access the slot measurement. More...
ErrKey	getErrKey () const
	Return the cached Key used to access the slot uncertainty. More...
Key< Flag >	getFlagKey () const
	Return the cached Key used to access the slot failure flag. More...
void	setKeys (std::string const &alias, Schema const &schema)
	Update the cached Keys following an change of aliases in the given Schema. More...
	FluxSlotDefinition (FluxSlotDefinition const &)=default
	FluxSlotDefinition (FluxSlotDefinition &&)=default
FluxSlotDefinition &	operator= (FluxSlotDefinition const &)=default
FluxSlotDefinition &	operator= (FluxSlotDefinition &&)=default
	~FluxSlotDefinition ()=default
std::string	getName () const
	Return the name of the slot (e.g. "Centroid" or "PsfFlux") More...
std::string	getAlias () const
	Return the alias field prefix used to lookup Keys for the slot. More...

Protected Attributes
std::string	_name

Detailed Description

SlotDefinition specialization for fluxes.

Definition at line 73 of file slots.h.

Member Typedef Documentation

ErrKey

using lsst::afw::table::FluxSlotDefinition::ErrKey = Key<double>

Key type used to access the slot uncertainty.

Definition at line 78 of file slots.h.

ErrValue

using lsst::afw::table::FluxSlotDefinition::ErrValue = double

Type returned by accessing the slot uncertainty.

Definition at line 76 of file slots.h.

MeasKey

using lsst::afw::table::FluxSlotDefinition::MeasKey = Key<double>

Key type used to access the slot measurement.

Definition at line 77 of file slots.h.

MeasValue

using lsst::afw::table::FluxSlotDefinition::MeasValue = double

Type returned by accessing the slot measurement.

Definition at line 75 of file slots.h.

Constructor & Destructor Documentation

FluxSlotDefinition() [1/3]

lsst::afw::table::FluxSlotDefinition::FluxSlotDefinition ( std::string const &  name )

inlineexplicit

Construct a SlotDefinition from the name of the slot (e.g. "PsfFlux")

Definition at line 81 of file slots.h.

: SlotDefinition(name) {}

FluxSlotDefinition() [2/3]

lsst::afw::table::FluxSlotDefinition::FluxSlotDefinition ( FluxSlotDefinition const &  )

default

FluxSlotDefinition() [3/3]

lsst::afw::table::FluxSlotDefinition::FluxSlotDefinition ( FluxSlotDefinition &&  )

default

~FluxSlotDefinition()

lsst::afw::table::FluxSlotDefinition::~FluxSlotDefinition ( )

default

Member Function Documentation

getAlias()

std::string lsst::afw::table::SlotDefinition::getAlias ( ) const

inlineinherited

Return the alias field prefix used to lookup Keys for the slot.

This simply prepends "slot_" to the slot name.

Definition at line 60 of file slots.h.

{ return "slot_" + _name; }

getErrKey()

ErrKey lsst::afw::table::FluxSlotDefinition::getErrKey ( ) const

inline

Return the cached Key used to access the slot uncertainty.

Definition at line 90 of file slots.h.

{ return _errKey; }

getFlagKey()

Key<Flag> lsst::afw::table::FluxSlotDefinition::getFlagKey ( ) const

inline

Return the cached Key used to access the slot failure flag.

Definition at line 93 of file slots.h.

{ return _flagKey; }

getMeasKey()

MeasKey lsst::afw::table::FluxSlotDefinition::getMeasKey ( ) const

inline

Return the cached Key used to access the slot measurement.

Definition at line 87 of file slots.h.

{ return _measKey; }

getName()

std::string lsst::afw::table::SlotDefinition::getName ( ) const

inlineinherited

Return the name of the slot (e.g. "Centroid" or "PsfFlux")

Definition at line 53 of file slots.h.

{ return _name; }

isValid()

bool lsst::afw::table::FluxSlotDefinition::isValid ( ) const

inline

Return true if the key associated with the measurement is valid.

Definition at line 84 of file slots.h.

{ return _measKey.isValid(); }

operator=() [1/2]

FluxSlotDefinition& lsst::afw::table::FluxSlotDefinition::operator= ( FluxSlotDefinition &&  )

default

operator=() [2/2]

FluxSlotDefinition& lsst::afw::table::FluxSlotDefinition::operator= ( FluxSlotDefinition const &  )

default

setKeys()

void lsst::afw::table::FluxSlotDefinition::setKeys	(	std::string const &	alias,
		Schema const &	schema
	)

Update the cached Keys following an change of aliases in the given Schema.

This method is intended for internal use by SourceTable only.

Parameters

[in]	alias	If non-empty, abort early if this string does not start with getAlias() (used to see if an alias change might have affected this slot, and avoid unnecessary work if not).
[in]	schema	Schema to search for Keys.

Definition at line 32 of file slots.cc.

                                                                             {
    SubSchema s = schema["slot"][_name];
    if (!alias.empty() && !startsWith(alias, s.getPrefix())) return;
    _measKey = MeasKey();
    _errKey = ErrKey();
    _flagKey = Key<Flag>();
    MeasFieldNameGetter helper(s["instFlux"], schema);
    if (!helper.defined) {
        return;
    }
    _measKey = helper.replaced;
    try {
        _errKey = s["instFluxErr"];
    } catch (pex::exceptions::NotFoundError &) {
    }
    try {
        _flagKey = s["flag"];
    } catch (pex::exceptions::NotFoundError &) {
    }
}

Member Data Documentation

_name

std::string lsst::afw::table::SlotDefinition::_name

protectedinherited

Definition at line 69 of file slots.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/include/lsst/afw/table/slots.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/src/table/slots.cc