Class SlotDefinition

Inheritance Relationships

Derived Types

Class Documentation

class SlotDefinition

Base class for helper classes that define slots on SourceTable/SourceRecord.

Each type of slot corresponds to a subclass of SlotDefinition, and each actual slot corresponds to a particular field name prefix. For instance, to look up the centroid slot, we look for fields named “slot_Centroid_x” and “slot_Centroid_y”. Instead of actually naming a particular field that, however, we use Schema’s alias mechanism (see AliasMap) to make these field name lookups resolve to the name of other fields. The actual definition of the slots is thus managed by the Schema’s AliasMap, though a SourceTable object will cache Keys for the various slots to make sure accessing slot values is efficient (more precisely, when you set an alias related to a slot on an AliasMap, any table it corresponds to will receive a notification that it should update its Keys). These cached Keys are actually stored within the SlotDefinition (as data members of derived classes).

Note that the uncertainty and failure flag components of slots are not required; a slot may have only a measurement defined, or a measurement and either one of these (but not both). A slot may not have only an uncertainty and/or a a failure flag, however.

A SlotDefinition instance is not just an internal object used by SourceTable; it can also be used to inspect the slots via SourceTable::getXxxSlot(), which is now the preferred way to access the Keys that slots correspond to. SlotDefinition objects should only be constructed by SourceTable, however.

Subclassed by lsst::afw::table::CentroidSlotDefinition, lsst::afw::table::FluxSlotDefinition, lsst::afw::table::ShapeSlotDefinition

Public Functions

SlotDefinition(std::string const &name)

Construct a SlotDefinition from the name of the slot (e.g. “Centroid” or “PsfFlux”)

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.

This simply prepends “slot_” to the slot name.

SlotDefinition(SlotDefinition const&)
SlotDefinition(SlotDefinition&&)
SlotDefinition &operator=(SlotDefinition const&)
SlotDefinition &operator=(SlotDefinition&&)
~SlotDefinition()

Protected Attributes

std::string _name