Class SourceRecord

Inheritance Relationships

Base Type

Class Documentation

class SourceRecord : public lsst::afw::table::SimpleRecord

Record class that contains measurements made on a single exposure.

Sources provide four additions to SimpleRecord / SimpleRecord:

  • Specific fields that must always be present, with specialized getters. The schema for a SourceTable should always be constructed by starting with the result of SourceTable::makeMinimalSchema.

  • A shared_ptr to a Footprint for each record.

  • A system of aliases (called slots) in which a SourceTable instance stores keys for particular measurements (a centroid, a shape, and a number of different fluxes) and SourceRecord uses this keys to provide custom getters and setters. These are not separate fields, but rather aliases that can point to custom fields. See the SlotDefinition hierarchy for more information.

Unnamed Group

RecordId getParent() const

Convenience accessors for the keys in the minimal source schema.

void setParent(RecordId id)

Public Types

typedef SourceTable Table
typedef SourceColumnViewT<SourceRecord> ColumnView
typedef SortedCatalogT<SourceRecord> Catalog
typedef SortedCatalogT<SourceRecord const> ConstCatalog

Public Functions

SourceRecord(ConstructionToken const &token, detail::RecordData &&data)

Constructor used by SourceTable.

While formally public, this constructor is conceptually and effectively protected, due to the (protected) ConstructionToken argument.

This is to allow make_shared to be used, as that cannot be used on a truly protected or private constructor.

std::shared_ptr<Footprint> getFootprint() const
void setFootprint(std::shared_ptr<Footprint> const &footprint)
std::shared_ptr<SourceTable const> getTable() const
FluxSlotDefinition::MeasValue getPsfInstFlux() const

Get the value of the PsfFlux slot measurement.

FluxSlotDefinition::ErrValue getPsfInstFluxErr() const

Get the uncertainty on the PsfFlux slot measurement.

bool getPsfFluxFlag() const

Return true if the measurement in the PsfFlux slot failed.

FluxSlotDefinition::MeasValue getModelInstFlux() const

Get the value of the ModelFlux slot measurement.

FluxSlotDefinition::ErrValue getModelInstFluxErr() const

Get the uncertainty on the ModelFlux slot measurement.

bool getModelFluxFlag() const

Return true if the measurement in the ModelFlux slot failed.

FluxSlotDefinition::MeasValue getApInstFlux() const

Get the value of the ApFlux slot measurement.

FluxSlotDefinition::ErrValue getApInstFluxErr() const

Get the uncertainty on the ApFlux slot measurement.

bool getApFluxFlag() const

Return true if the measurement in the ApFlux slot failed.

FluxSlotDefinition::MeasValue getGaussianInstFlux() const

Get the value of the GaussianFlux slot measurement.

FluxSlotDefinition::ErrValue getGaussianInstFluxErr() const

Get the uncertainty on the GaussianFlux slot measurement.

bool getGaussianFluxFlag() const

Return true if the measurement in the GaussianFlux slot failed.

FluxSlotDefinition::MeasValue getCalibInstFlux() const

Get the value of the CalibFlux slot measurement.

FluxSlotDefinition::ErrValue getCalibInstFluxErr() const

Get the uncertainty on the CalibFlux slot measurement.

bool getCalibFluxFlag() const

Return true if the measurement in the CalibFlux slot failed.

CentroidSlotDefinition::MeasValue getCentroid() const

Get the value of the Centroid slot measurement.

CentroidSlotDefinition::ErrValue getCentroidErr() const

Get the uncertainty on the Centroid slot measurement.

bool getCentroidFlag() const

Return true if the measurement in the Centroid slot failed.

ShapeSlotDefinition::MeasValue getShape() const

Get the value of the Shape slot measurement.

ShapeSlotDefinition::ErrValue getShapeErr() const

Get the uncertainty on the Shape slot measurement.

bool getShapeFlag() const

Return true if the measurement in the Shape slot failed.

double getX() const

Return the centroid slot x coordinate.

double getY() const

Return the centroid slot y coordinate.

double getIxx() const

Return the shape slot Ixx value.

double getIyy() const

Return the shape slot Iyy value.

double getIxy() const

Return the shape slot Ixy value.

void updateCoord(geom::SkyWcs const &wcs)

Update the coord field using the given Wcs and the field in the centroid slot.

void updateCoord(geom::SkyWcs const &wcs, PointKey<double> const &key)

Update the coord field using the given Wcs and the image center from the given key.

SourceRecord(const SourceRecord&)
SourceRecord &operator=(const SourceRecord&)
SourceRecord(SourceRecord&&)
SourceRecord &operator=(SourceRecord&&)
~SourceRecord()

Protected Functions

virtual void _assign(BaseRecord const &other)

Called by assign() after transferring fields to allow subclass data members to be copied.