lsst.afw.table::FluxSlotDefinition Class Reference

SlotDefinition specialization for fluxes. More...

#include <slots.h>

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

Public Types
typedef double	MeasValue
	Type returned by accessing the slot measurement. More...
typedef double	ErrValue
	Type returned by accessing the slot uncertainty. More...
typedef Key< double >	MeasKey
	Key type used to access the slot measurement. More...
typedef Key< double >	ErrKey
	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)
Public Member Functions inherited from lsst.afw.table::SlotDefinition
	SlotDefinition (std::string const &name)
	Construct a SlotDefinition from the name of the slot (e.g. "Centroid" or "PsfFlux") More...
std::string	getName () const
	Return the name of the slot (e.g. "Centroid" or "PsfFlux") More...
std::string	getAlias () const

Private Attributes
MeasKey	_measKey
ErrKey	_errKey
Key< Flag >	_flagKey

Additional Inherited Members
Protected Attributes inherited from lsst.afw.table::SlotDefinition
std::string	_name

Detailed Description

SlotDefinition specialization for fluxes.

Definition at line 69 of file slots.h.

Member Typedef Documentation

typedef Key<double> lsst.afw.table::FluxSlotDefinition::ErrKey

Key type used to access the slot uncertainty.

Definition at line 75 of file slots.h.

typedef double lsst.afw.table::FluxSlotDefinition::ErrValue

Type returned by accessing the slot uncertainty.

Definition at line 73 of file slots.h.

typedef Key<double> lsst.afw.table::FluxSlotDefinition::MeasKey

Key type used to access the slot measurement.

Definition at line 74 of file slots.h.

typedef double lsst.afw.table::FluxSlotDefinition::MeasValue

Type returned by accessing the slot measurement.

Definition at line 72 of file slots.h.

Constructor & Destructor Documentation

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 78 of file slots.h.

: SlotDefinition(name) {}

Member Function Documentation

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

inline

Return the cached Key used to access the slot uncertainty.

Definition at line 87 of file slots.h.

{ return _errKey; }

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

inline

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

Definition at line 90 of file slots.h.

{ return _flagKey; }

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

inline

Return the cached Key used to access the slot measurement.

Definition at line 84 of file slots.h.

{ return _measKey; }

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

inline

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

Definition at line 81 of file slots.h.

{ return _measKey.isValid(); }

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.

Member Data Documentation

ErrKey lsst.afw.table::FluxSlotDefinition::_errKey

private

Definition at line 106 of file slots.h.

Key<Flag> lsst.afw.table::FluxSlotDefinition::_flagKey

private

Definition at line 107 of file slots.h.

MeasKey lsst.afw.table::FluxSlotDefinition::_measKey

private

Definition at line 105 of file slots.h.

---

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

• /home/lsstsw/stack/Linux64/afw/11.0.rc2+4/include/lsst/afw/table/slots.h