lsst::afw::table::CentroidSlotDefinition Class Reference

SlotDefinition specialization for centroids. More...

#include <slots.h>

Inheritance diagram for lsst::afw::table::CentroidSlotDefinition:

Public Types
using	MeasValue = lsst::geom::Point2D
	Type returned by accessing the slot measurement.
using	ErrValue = Eigen::Matrix<float, 2, 2>
	Type returned by accessing the slot uncertainty.
using	MeasKey = Point2DKey
	Key type used to access the slot measurement.
using	ErrKey = CovarianceMatrixKey<float, 2>
	Key type used to access the slot uncertainty.

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

Protected Attributes
std::string	_name

Detailed Description

SlotDefinition specialization for centroids.

Definition at line 120 of file slots.h.

Member Typedef Documentation

ErrKey

using lsst::afw::table::CentroidSlotDefinition::ErrKey = CovarianceMatrixKey<float, 2>

Key type used to access the slot uncertainty.

Definition at line 125 of file slots.h.

ErrValue

using lsst::afw::table::CentroidSlotDefinition::ErrValue = Eigen::Matrix<float, 2, 2>

Type returned by accessing the slot uncertainty.

Definition at line 123 of file slots.h.

MeasKey

using lsst::afw::table::CentroidSlotDefinition::MeasKey = Point2DKey

Key type used to access the slot measurement.

Definition at line 124 of file slots.h.

MeasValue

using lsst::afw::table::CentroidSlotDefinition::MeasValue = lsst::geom::Point2D

Type returned by accessing the slot measurement.

Definition at line 122 of file slots.h.

Constructor & Destructor Documentation

CentroidSlotDefinition() [1/3]

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

inlineexplicit

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

Definition at line 128 of file slots.h.

: SlotDefinition(name) {}

CentroidSlotDefinition() [2/3]

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

default

CentroidSlotDefinition() [3/3]

lsst::afw::table::CentroidSlotDefinition::CentroidSlotDefinition ( CentroidSlotDefinition && )

default

~CentroidSlotDefinition()

lsst::afw::table::CentroidSlotDefinition::~CentroidSlotDefinition ( )

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::CentroidSlotDefinition::getErrKey ( ) const

inline

Return the cached Key used to access the slot uncertainty.

Definition at line 137 of file slots.h.

{ return _errKey; }

getFlagKey()

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

inline

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

Definition at line 140 of file slots.h.

{ return _flagKey; }

getMeasKey()

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

inline

Return the cached Key used to access the slot measurement.

Definition at line 134 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::CentroidSlotDefinition::isValid ( ) const

inline

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

Definition at line 131 of file slots.h.

{ return _measKey.isValid(); }

operator=() [1/2]

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

default

operator=() [2/2]

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

default

setKeys()

void lsst::afw::table::CentroidSlotDefinition::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 64 of file slots.cc.

                                                                                 {
    SubSchema s = schema["slot"][_name];
    if (!alias.empty() && !startsWith(alias, s.getPrefix())) return;
    static ErrKey::NameArray names = makeCentroidNameArray();
    _measKey = MeasKey();
    _errKey = ErrKey();
    _flagKey = Key<Flag>();
    MeasFieldNameGetter helper(s, schema);
    if (!helper.defined) return;
    _measKey = helper.replaced;
    try {
        _errKey = ErrKey(s, names);
    } 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-12.0.0/Linux/afw/g083dd6704c+2e189452a7/include/lsst/afw/table/slots.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/afw/g083dd6704c+2e189452a7/src/table/slots.cc