lsst::afw::table::SourceRecord Class Reference

Record class that contains measurements made on a single exposure. More...

#include <Source.h>

Inheritance diagram for lsst::afw::table::SourceRecord:

Public Types
typedef SourceTable	Table
typedef SourceColumnViewT < SourceRecord >	ColumnView
typedef SortedCatalogT < SourceRecord >	Catalog
typedef SortedCatalogT < SourceRecord const >	ConstCatalog
Public Types inherited from lsst::afw::table::SimpleRecord
typedef SimpleTable	Table
typedef ColumnViewT< SimpleRecord >	ColumnView
typedef SortedCatalogT < SimpleRecord >	Catalog
typedef SortedCatalogT < SimpleRecord const >	ConstCatalog
Public Types inherited from lsst::afw::table::BaseRecord
typedef BaseTable	Table
	The associated table class. More...
typedef BaseColumnView	ColumnView
	The associated ColumnView class. More...
typedef CatalogT< BaseRecord >	Catalog
	Template of CatalogT used to hold records of this type. More...
typedef CatalogT< BaseRecord const >	ConstCatalog
	Template of CatalogT used to hold const records of this type. More...
Public Types inherited from lsst::daf::base::Citizen
enum	{ magicSentinel = 0xdeadbeef }
typedef unsigned long	memId
	Type of the block's ID. More...
typedef memId(*	memNewCallback )(const memId cid)
	A function used to register a callback. More...
typedef memId(*	memCallback )(const Citizen *ptr)

Public Member Functions
boost::shared_ptr< Footprint >	getFootprint () const
void	setFootprint (boost::shared_ptr< Footprint > const &footprint)
boost::shared_ptr< SourceTable const >	getTable () const
FluxSlotDefinition::MeasValue	getPsfFlux () const
	Get the value of the PsfFlux slot measurement. More...
FluxSlotDefinition::ErrValue	getPsfFluxErr () const
	Get the uncertainty on the PsfFlux slot measurement. More...
bool	getPsfFluxFlag () const
	Return true if the measurement in the PsfFlux slot failed. More...
FluxSlotDefinition::MeasValue	getModelFlux () const
	Get the value of the ModelFlux slot measurement. More...
FluxSlotDefinition::ErrValue	getModelFluxErr () const
	Get the uncertainty on the ModelFlux slot measurement. More...
bool	getModelFluxFlag () const
	Return true if the measurement in the ModelFlux slot failed. More...
FluxSlotDefinition::MeasValue	getApFlux () const
	Get the value of the ApFlux slot measurement. More...
FluxSlotDefinition::ErrValue	getApFluxErr () const
	Get the uncertainty on the ApFlux slot measurement. More...
bool	getApFluxFlag () const
	Return true if the measurement in the ApFlux slot failed. More...
FluxSlotDefinition::MeasValue	getInstFlux () const
	Get the value of the InstFlux slot measurement. More...
FluxSlotDefinition::ErrValue	getInstFluxErr () const
	Get the uncertainty on the InstFlux slot measurement. More...
bool	getInstFluxFlag () const
	Return true if the measurement in the InstFlux slot failed. More...
FluxSlotDefinition::MeasValue	getCalibFlux () const
	Get the value of the CalibFlux slot measurement. More...
FluxSlotDefinition::ErrValue	getCalibFluxErr () const
	Get the uncertainty on the CalibFlux slot measurement. More...
bool	getCalibFluxFlag () const
	Return true if the measurement in the CalibFlux slot failed. More...
CentroidSlotDefinition::MeasValue	getCentroid () const
	Get the value of the Centroid slot measurement. More...
CentroidSlotDefinition::ErrValue	getCentroidErr () const
	Get the uncertainty on the Centroid slot measurement. More...
bool	getCentroidFlag () const
	Return true if the measurement in the Centroid slot failed. More...
ShapeSlotDefinition::MeasValue	getShape () const
	Get the value of the Shape slot measurement. More...
ShapeSlotDefinition::ErrValue	getShapeErr () const
	Get the uncertainty on the Shape slot measurement. More...
bool	getShapeFlag () const
	Return true if the measurement in the Shape slot failed. More...
double	getX () const
	Return the centroid slot x coordinate. More...
double	getY () const
	Return the centroid slot y coordinate. More...
double	getIxx () const
	Return the shape slot Ixx value. More...
double	getIyy () const
	Return the shape slot Iyy value. More...
double	getIxy () const
	Return the shape slot Ixy value. More...
void	updateCoord (image::Wcs const &wcs)
	Update the coord field using the given Wcs and the field in the centroid slot. More...
void	updateCoord (image::Wcs const &wcs, PointKey< double > const &key)
	Update the coord field using the given Wcs and the image center from the given key. More...
RecordId	getParent () const
	Convenience accessors for the keys in the minimal source schema. More...
void	setParent (RecordId id)
	Convenience accessors for the keys in the minimal source schema. More...
Public Member Functions inherited from lsst::afw::table::SimpleRecord
boost::shared_ptr< SimpleTable const >	getTable () const
RecordId	getId () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setId (RecordId id)
	Convenience accessors for the keys in the minimal reference schema. More...
IcrsCoord	getCoord () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setCoord (IcrsCoord const &coord)
	Convenience accessors for the keys in the minimal reference schema. More...
void	setCoord (Coord const &coord)
	Convenience accessors for the keys in the minimal reference schema. More...
Angle	getRa () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setRa (Angle ra)
	Convenience accessors for the keys in the minimal reference schema. More...
Angle	getDec () const
	Convenience accessors for the keys in the minimal reference schema. More...
void	setDec (Angle dec)
	Convenience accessors for the keys in the minimal reference schema. More...
Public Member Functions inherited from lsst::afw::table::BaseRecord
Schema	getSchema () const
	Return the Schema that holds this record's fields and keys. More...
boost::shared_ptr< BaseTable const >	getTable () const
	Return the table this record is associated with. More...
template<typename T >
Field< T >::Element *	getElement (Key< T > const &key)
	Return a pointer to the underlying elements of a field (non-const). More...
template<typename T >
Field< T >::Element const *	getElement (Key< T > const &key) const
	Return a pointer to the underlying elements of a field (const). More...
template<typename T >
Field< T >::Reference	operator[] (Key< T > const &key)
	Return a reference (or reference-like type) to the field's value. More...
template<typename T >
Field< T >::ConstReference	operator[] (Key< T > const &key) const
	Return a const reference (or const-reference-like type) to the field's value. More...
template<typename T >
Field< T >::Value	get (Key< T > const &key) const
	Return the value of a field for the given key. More...
template<typename T , typename U >
void	set (Key< T > const &key, U const &value)
	Set value of a field for the given key. More...
template<typename T >
T	get (OutputFunctorKey< T > const &key) const
	Compute a calculated or aggregate field. More...
template<typename T , typename U >
void	set (InputFunctorKey< T > const &key, U const &value)
	Set a calculated or aggregate field. More...
template<typename Ref >
Ref	operator[] (ReferenceFunctorKey< Ref > const &key)
template<typename ConstRef >
ConstRef	operator[] (ConstReferenceFunctorKey< ConstRef > const &key) const
void	assign (BaseRecord const &other)
	Copy all field values from other to this, requiring that they have equal schemas. More...
void	assign (BaseRecord const &other, SchemaMapper const &mapper)
	Copy field values from other to this, using a mapper. More...
ndarray::Manager::Ptr	getManager () const
virtual	~BaseRecord ()
Public Member Functions inherited from lsst::daf::base::Citizen
	Citizen (const std::type_info &)
	Citizen (Citizen const &)
	~Citizen ()
Citizen &	operator= (Citizen const &)
std::string	repr () const
	Return a string representation of a Citizen. More...
void	markPersistent (void)
	Mark a Citizen as persistent and not destroyed until process end. More...
memId	getId () const
	Return the Citizen's ID. More...

Protected Member Functions
	SourceRecord (boost::shared_ptr< SourceTable > const &table)
virtual void	_assign (BaseRecord const &other)
	Called by assign() after transferring fields to allow subclass data members to be copied. More...
Protected Member Functions inherited from lsst::afw::table::SimpleRecord
	SimpleRecord (boost::shared_ptr< SimpleTable > const &table)
Protected Member Functions inherited from lsst::afw::table::BaseRecord
	BaseRecord (boost::shared_ptr< BaseTable > const &table)
	Construct a record with uninitialized data. More...

Private Attributes
boost::shared_ptr< Footprint >	_footprint

Additional Inherited Members
Static Public Member Functions inherited from lsst::daf::base::Citizen
static bool	hasBeenCorrupted ()
	Check all allocated blocks for corruption. More...
static memId	getNextMemId ()
	Return the memId of the next object to be allocated. More...
static int	init ()
	Called once when the memory system is being initialised. More...
static int	census (int, memId startingMemId=0)
	How many active Citizens are there? More...
static void	census (std::ostream &stream, memId startingMemId=0)
	Print a list of all active Citizens to stream, sorted by ID. More...
static const std::vector < const Citizen * > *	census ()
	Return a (newly allocated) std::vector of active Citizens sorted by ID. More...
static memId	setNewCallbackId (memId id)
	Call the NewCallback when block is allocated. More...
static memId	setDeleteCallbackId (memId id)
	Call the current DeleteCallback when block is deleted. More...
static memNewCallback	setNewCallback (memNewCallback func)
	Set the NewCallback function. More...
static memCallback	setDeleteCallback (memCallback func)
	Set the DeleteCallback function. More...
static memCallback	setCorruptionCallback (memCallback func)
	Set the CorruptionCallback function. More...

Detailed Description

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.

Definition at line 81 of file Source.h.

Member Typedef Documentation

typedef SortedCatalogT<SourceRecord> lsst::afw::table::SourceRecord::Catalog

Definition at line 86 of file Source.h.

typedef SourceColumnViewT<SourceRecord> lsst::afw::table::SourceRecord::ColumnView

Definition at line 85 of file Source.h.

typedef SortedCatalogT<SourceRecord const> lsst::afw::table::SourceRecord::ConstCatalog

Definition at line 87 of file Source.h.

typedef SourceTable lsst::afw::table::SourceRecord::Table

Definition at line 84 of file Source.h.

Constructor & Destructor Documentation

lsst::afw::table::SourceRecord::SourceRecord ( boost::shared_ptr< SourceTable > const &  table )

protected

Member Function Documentation

virtual void lsst::afw::table::SourceRecord::_assign ( BaseRecord const &  other )

protectedvirtual

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

Reimplemented from lsst::afw::table::BaseRecord.

FluxSlotDefinition::MeasValue lsst::afw::table::SourceRecord::getApFlux ( ) const

inline

Get the value of the ApFlux slot measurement.

Definition at line 867 of file Source.h.

                                                                 {
    return this->get(getTable()->getApFluxSlot().getMeasKey());
}

FluxSlotDefinition::ErrValue lsst::afw::table::SourceRecord::getApFluxErr ( ) const

inline

Get the uncertainty on the ApFlux slot measurement.

Definition at line 871 of file Source.h.

                                                                   {
    return this->get(getTable()->getApFluxSlot().getErrKey());
}

bool lsst::afw::table::SourceRecord::getApFluxFlag ( ) const

inline

Return true if the measurement in the ApFlux slot failed.

Definition at line 875 of file Source.h.

                                              {
    return this->get(getTable()->getApFluxSlot().getFlagKey());
}

FluxSlotDefinition::MeasValue lsst::afw::table::SourceRecord::getCalibFlux ( ) const

inline

Get the value of the CalibFlux slot measurement.

Definition at line 891 of file Source.h.

                                                                    {
    return this->get(getTable()->getCalibFluxSlot().getMeasKey());
}

FluxSlotDefinition::ErrValue lsst::afw::table::SourceRecord::getCalibFluxErr ( ) const

inline

Get the uncertainty on the CalibFlux slot measurement.

Definition at line 895 of file Source.h.

                                                                      {
    return this->get(getTable()->getCalibFluxSlot().getErrKey());
}

bool lsst::afw::table::SourceRecord::getCalibFluxFlag ( ) const

inline

Return true if the measurement in the CalibFlux slot failed.

Definition at line 899 of file Source.h.

                                                 {
    return this->get(getTable()->getCalibFluxSlot().getFlagKey());
}

CentroidSlotDefinition::MeasValue lsst::afw::table::SourceRecord::getCentroid ( ) const

inline

Get the value of the Centroid slot measurement.

Definition at line 903 of file Source.h.

                                                                       {
    return this->get(getTable()->getCentroidSlot().getMeasKey());
}

CentroidSlotDefinition::ErrValue lsst::afw::table::SourceRecord::getCentroidErr ( ) const

inline

Get the uncertainty on the Centroid slot measurement.

Definition at line 907 of file Source.h.

                                                                         {
    return this->get(getTable()->getCentroidSlot().getErrKey());
}

bool lsst::afw::table::SourceRecord::getCentroidFlag ( ) const

inline

Return true if the measurement in the Centroid slot failed.

Definition at line 911 of file Source.h.

                                                {
    return this->get(getTable()->getCentroidSlot().getFlagKey());
}

boost::shared_ptr< Footprint > lsst::afw::table::SourceRecord::getFootprint ( ) const

inline

Definition at line 89 of file Source.h.

{ return _footprint; }

FluxSlotDefinition::MeasValue lsst::afw::table::SourceRecord::getInstFlux ( ) const

inline

Get the value of the InstFlux slot measurement.

Definition at line 879 of file Source.h.

                                                                   {
    return this->get(getTable()->getInstFluxSlot().getMeasKey());
}

FluxSlotDefinition::ErrValue lsst::afw::table::SourceRecord::getInstFluxErr ( ) const

inline

Get the uncertainty on the InstFlux slot measurement.

Definition at line 883 of file Source.h.

                                                                     {
    return this->get(getTable()->getInstFluxSlot().getErrKey());
}

bool lsst::afw::table::SourceRecord::getInstFluxFlag ( ) const

inline

Return true if the measurement in the InstFlux slot failed.

Definition at line 887 of file Source.h.

                                                {
    return this->get(getTable()->getInstFluxSlot().getFlagKey());
}

double lsst::afw::table::SourceRecord::getIxx ( ) const

inline

Return the shape slot Ixx value.

Definition at line 936 of file Source.h.

                                         {
    return get(getTable()->getShapeKey().getIxx());
}

double lsst::afw::table::SourceRecord::getIxy ( ) const

inline

Return the shape slot Ixy value.

Definition at line 942 of file Source.h.

                                         {
    return get(getTable()->getShapeKey().getIxy());
}

double lsst::afw::table::SourceRecord::getIyy ( ) const

inline

Return the shape slot Iyy value.

Definition at line 939 of file Source.h.

                                         {
    return get(getTable()->getShapeKey().getIyy());
}

FluxSlotDefinition::MeasValue lsst::afw::table::SourceRecord::getModelFlux ( ) const

inline

Get the value of the ModelFlux slot measurement.

Definition at line 855 of file Source.h.

                                                                    {
    return this->get(getTable()->getModelFluxSlot().getMeasKey());
}

FluxSlotDefinition::ErrValue lsst::afw::table::SourceRecord::getModelFluxErr ( ) const

inline

Get the uncertainty on the ModelFlux slot measurement.

Definition at line 859 of file Source.h.

                                                                      {
    return this->get(getTable()->getModelFluxSlot().getErrKey());
}

bool lsst::afw::table::SourceRecord::getModelFluxFlag ( ) const

inline

Return true if the measurement in the ModelFlux slot failed.

Definition at line 863 of file Source.h.

                                                 {
    return this->get(getTable()->getModelFluxSlot().getFlagKey());
}

RecordId lsst::afw::table::SourceRecord::getParent ( ) const

inline

Convenience accessors for the keys in the minimal source schema.

Definition at line 928 of file Source.h.

{ return get(SourceTable::getParentKey()); }

FluxSlotDefinition::MeasValue lsst::afw::table::SourceRecord::getPsfFlux ( ) const

inline

Get the value of the PsfFlux slot measurement.

Definition at line 843 of file Source.h.

                                                                  {
    return this->get(getTable()->getPsfFluxSlot().getMeasKey());
}

FluxSlotDefinition::ErrValue lsst::afw::table::SourceRecord::getPsfFluxErr ( ) const

inline

Get the uncertainty on the PsfFlux slot measurement.

Definition at line 847 of file Source.h.

                                                                    {
    return this->get(getTable()->getPsfFluxSlot().getErrKey());
}

bool lsst::afw::table::SourceRecord::getPsfFluxFlag ( ) const

inline

Return true if the measurement in the PsfFlux slot failed.

Definition at line 851 of file Source.h.

                                               {
    return this->get(getTable()->getPsfFluxSlot().getFlagKey());
}

ShapeSlotDefinition::MeasValue lsst::afw::table::SourceRecord::getShape ( ) const

inline

Get the value of the Shape slot measurement.

Definition at line 915 of file Source.h.

                                                                 {
    return this->get(getTable()->getShapeSlot().getMeasKey());
}

ShapeSlotDefinition::ErrValue lsst::afw::table::SourceRecord::getShapeErr ( ) const

inline

Get the uncertainty on the Shape slot measurement.

Definition at line 919 of file Source.h.

                                                                   {
    return this->get(getTable()->getShapeSlot().getErrKey());
}

bool lsst::afw::table::SourceRecord::getShapeFlag ( ) const

inline

Return true if the measurement in the Shape slot failed.

Definition at line 923 of file Source.h.

                                             {
    return this->get(getTable()->getShapeSlot().getFlagKey());
}

boost::shared_ptr< SourceTable const> lsst::afw::table::SourceRecord::getTable ( ) const

inline

Definition at line 93 of file Source.h.

                                            {
        return boost::static_pointer_cast<SourceTable const>(BaseRecord::getTable());
    }

double lsst::afw::table::SourceRecord::getX ( ) const

inline

Return the centroid slot x coordinate.

Definition at line 930 of file Source.h.

                                       {
    return get(getTable()->getCentroidKey().getX());
}

double lsst::afw::table::SourceRecord::getY ( ) const

inline

Return the centroid slot y coordinate.

Definition at line 933 of file Source.h.

                                       {
    return get(getTable()->getCentroidKey().getY());
}

void lsst::afw::table::SourceRecord::setFootprint ( boost::shared_ptr< Footprint > const &  footprint )

inline

Definition at line 91 of file Source.h.

{ _footprint = footprint; }

void lsst::afw::table::SourceRecord::setParent ( RecordId  id )

inline

Convenience accessors for the keys in the minimal source schema.

Definition at line 929 of file Source.h.

{ set(SourceTable::getParentKey(), id); }

void lsst::afw::table::SourceRecord::updateCoord

(

image::Wcs const &

wcs

)

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

void lsst::afw::table::SourceRecord::updateCoord	(	image::Wcs const &	wcs,
		PointKey< double > const &	key
	)

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

Member Data Documentation

boost::shared_ptr< Footprint > lsst::afw::table::SourceRecord::_footprint

private

Definition at line 195 of file Source.h.

---

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

• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/table/Source.h