lsst.afw.table::ShapeSlotDefinition Class Reference

SlotDefinition specialization for shapes. More...

#include <slots.h>

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

Public Types
typedef geom::ellipses::Quadrupole	MeasValue
	Type returned by accessing the slot measurement. More...
typedef Eigen::Matrix< float, 3, 3 >	ErrValue
	Type returned by accessing the slot uncertainty. More...
typedef QuadrupoleKey	MeasKey
	Key type used to access the slot measurement. More...
typedef CovarianceMatrixKey < float, 3 >	ErrKey
	Key type used to access the slot uncertainty. More...

Public Member Functions
	ShapeSlotDefinition (std::string const &name)
	Construct a SlotDefinition from the name of the slot (e.g. "Shape") 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 shapes.

Definition at line 153 of file slots.h.

Member Typedef Documentation

typedef CovarianceMatrixKey<float,3> lsst.afw.table::ShapeSlotDefinition::ErrKey

Key type used to access the slot uncertainty.

Definition at line 159 of file slots.h.

typedef Eigen::Matrix<float,3,3> lsst.afw.table::ShapeSlotDefinition::ErrValue

Type returned by accessing the slot uncertainty.

Definition at line 157 of file slots.h.

typedef QuadrupoleKey lsst.afw.table::ShapeSlotDefinition::MeasKey

Key type used to access the slot measurement.

Definition at line 158 of file slots.h.

typedef geom::ellipses::Quadrupole lsst.afw.table::ShapeSlotDefinition::MeasValue

Type returned by accessing the slot measurement.

Definition at line 156 of file slots.h.

Constructor & Destructor Documentation

lsst.afw.table::ShapeSlotDefinition::ShapeSlotDefinition ( std::string const &  name )

inlineexplicit

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

Definition at line 162 of file slots.h.

: SlotDefinition(name) {}

Member Function Documentation

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

inline

Return the cached Key used to access the slot uncertainty.

Definition at line 171 of file slots.h.

{ return _errKey; }

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

inline

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

Definition at line 174 of file slots.h.

{ return _flagKey; }

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

inline

Return the cached Key used to access the slot measurement.

Definition at line 168 of file slots.h.

{ return _measKey; }

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

inline

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

Definition at line 165 of file slots.h.

{ return _measKey.isValid(); }

void lsst.afw.table::ShapeSlotDefinition::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::ShapeSlotDefinition::_errKey

private

Definition at line 190 of file slots.h.

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

private

Definition at line 191 of file slots.h.

MeasKey lsst.afw.table::ShapeSlotDefinition::_measKey

private

Definition at line 189 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