lsst.afw.table::SourceTable Class Reference

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

#include <Source.h>

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

Classes
struct	MinimalSchema

Public Types
typedef SourceRecord	Record
typedef SourceColumnViewT < SourceRecord >	ColumnView
typedef SortedCatalogT< Record >	Catalog
typedef SortedCatalogT< Record const >	ConstCatalog
Public Types inherited from lsst.afw.table::SimpleTable
typedef SimpleRecord	Record
typedef ColumnViewT< SimpleRecord >	ColumnView
typedef SortedCatalogT< Record >	Catalog
typedef SortedCatalogT< Record const >	ConstCatalog
Public Types inherited from lsst.afw.table::BaseTable
typedef BaseRecord	Record
	The associated record class. More...
typedef BaseColumnView	ColumnView
	The associated ColumnView class. More...
typedef CatalogT< Record >	Catalog
	Template of CatalogT used to hold records of the associated type. More...
typedef CatalogT< Record const >	ConstCatalog
	Template of CatalogT used to hold const records of the associated 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< SourceTable >	clone () const
	Return a polymorphic deep copy of the table. More...
boost::shared_ptr< SourceRecord >	makeRecord ()
	Default-construct an associated record. More...
boost::shared_ptr< SourceRecord >	copyRecord (BaseRecord const &other)
	Deep-copy a record, requiring that it have the same schema as this table. More...
boost::shared_ptr< SourceRecord >	copyRecord (BaseRecord const &other, SchemaMapper const &mapper)
	Deep-copy a record, requiring that it have the same schema as this table. More...
FluxSlotDefinition const &	getPsfFluxSlot () const
void	definePsfFlux (std::string const &name)
	Set the measurement used for the PsfFlux slot. More...
std::string	getPsfFluxDefinition () const
	Return the name of the field used for the PsfFlux slot. More...
bool	hasPsfFluxSlot () const
	Return true if the PsfFlux slot corresponds to a valid field. More...
FluxSlotDefinition::MeasKey	getPsfFluxKey () const
	Return the key used for the PsfFlux slot measurement value. More...
FluxSlotDefinition::ErrKey	getPsfFluxErrKey () const
	Return the key used for the PsfFlux slot uncertainty. More...
Key< Flag >	getPsfFluxFlagKey () const
	Return the key used for the PsfFlux slot failure flag. More...
FluxSlotDefinition const &	getModelFluxSlot () const
void	defineModelFlux (std::string const &name)
	Set the measurement used for the ModelFlux slot. More...
std::string	getModelFluxDefinition () const
	Return the name of the field used for the ModelFlux slot. More...
bool	hasModelFluxSlot () const
	Return true if the ModelFlux slot corresponds to a valid field. More...
FluxSlotDefinition::MeasKey	getModelFluxKey () const
	Return the key used for the ModelFlux slot measurement value. More...
FluxSlotDefinition::ErrKey	getModelFluxErrKey () const
	Return the key used for the ModelFlux slot uncertainty. More...
Key< Flag >	getModelFluxFlagKey () const
	Return the key used for the ModelFlux slot failure flag. More...
FluxSlotDefinition const &	getApFluxSlot () const
void	defineApFlux (std::string const &name)
	Set the measurement used for the ApFlux slot. More...
std::string	getApFluxDefinition () const
	Return the name of the field used for the ApFlux slot. More...
bool	hasApFluxSlot () const
	Return true if the ApFlux slot corresponds to a valid field. More...
FluxSlotDefinition::MeasKey	getApFluxKey () const
	Return the key used for the ApFlux slot measurement value. More...
FluxSlotDefinition::ErrKey	getApFluxErrKey () const
	Return the key used for the ApFlux slot uncertainty. More...
Key< Flag >	getApFluxFlagKey () const
	Return the key used for the ApFlux slot failure flag. More...
FluxSlotDefinition const &	getInstFluxSlot () const
void	defineInstFlux (std::string const &name)
	Set the measurement used for the InstFlux slot. More...
std::string	getInstFluxDefinition () const
	Return the name of the field used for the InstFlux slot. More...
bool	hasInstFluxSlot () const
	Return true if the InstFlux slot corresponds to a valid field. More...
FluxSlotDefinition::MeasKey	getInstFluxKey () const
	Return the key used for the InstFlux slot measurement value. More...
FluxSlotDefinition::ErrKey	getInstFluxErrKey () const
	Return the key used for the InstFlux slot uncertainty. More...
Key< Flag >	getInstFluxFlagKey () const
	Return the key used for the InstFlux slot failure flag. More...
CentroidSlotDefinition const &	getCentroidSlot () const
void	defineCentroid (std::string const &name)
	Set the measurement used for the Centroid slot. More...
std::string	getCentroidDefinition () const
	Return the name of the field used for the Centroid slot. More...
bool	hasCentroidSlot () const
	Return true if the Centroid slot corresponds to a valid field. More...
CentroidSlotDefinition::MeasKey	getCentroidKey () const
	Return the key used for the Centroid slot measurement value. More...
CentroidSlotDefinition::ErrKey	getCentroidErrKey () const
	Return the key used for the Centroid slot uncertainty. More...
Key< Flag >	getCentroidFlagKey () const
	Return the key used for the Centroid slot failure flag. More...
ShapeSlotDefinition const &	getShapeSlot () const
void	defineShape (std::string const &name)
	Set the measurement used for the Shape slot. More...
std::string	getShapeDefinition () const
	Return the name of the field used for the Shape slot. More...
bool	hasShapeSlot () const
	Return true if the Shape slot corresponds to a valid field. More...
ShapeSlotDefinition::MeasKey	getShapeKey () const
	Return the key used for the Shape slot measurement value. More...
ShapeSlotDefinition::ErrKey	getShapeErrKey () const
	Return the key used for the Shape slot uncertainty. More...
Key< Flag >	getShapeFlagKey () const
	Return the key used for the Shape slot failure flag. More...
Public Member Functions inherited from lsst.afw.table::SimpleTable
boost::shared_ptr< IdFactory >	getIdFactory ()
	Return the object that generates IDs for the table (may be null). More...
boost::shared_ptr< IdFactory const >	getIdFactory () const
	Return the object that generates IDs for the table (may be null). More...
void	setIdFactory (boost::shared_ptr< IdFactory > f)
	Switch to a new IdFactory – object that generates IDs for the table (may be null). More...
boost::shared_ptr< SimpleTable >	clone () const
	Return a polymorphic deep copy of the table. More...
boost::shared_ptr< SimpleRecord >	makeRecord ()
	Default-construct an associated record. More...
boost::shared_ptr< SimpleRecord >	copyRecord (BaseRecord const &other)
	Deep-copy a record, requiring that it have the same schema as this table. More...
boost::shared_ptr< SimpleRecord >	copyRecord (BaseRecord const &other, SchemaMapper const &mapper)
	Deep-copy a record, requiring that it have the same schema as this table. More...
Public Member Functions inherited from lsst.afw.table::BaseTable
boost::shared_ptr < daf::base::PropertyList >	getMetadata () const
	Return the flexible metadata associated with the table. May be null. More...
void	setMetadata (boost::shared_ptr< daf::base::PropertyList > const &metadata)
	Set the flexible metadata associated with the table. May be null. More...
boost::shared_ptr < daf::base::PropertyList >	popMetadata ()
	Return the metadata and set the internal metadata to a null pointer. More...
boost::shared_ptr< BaseTable >	clone () const
	Return a polymorphic deep copy of the table. More...
boost::shared_ptr< BaseRecord >	makeRecord ()
	Default-construct an associated record. More...
boost::shared_ptr< BaseRecord >	copyRecord (BaseRecord const &input)
	Deep-copy a record, requiring that it have the same schema as this table. More...
boost::shared_ptr< BaseRecord >	copyRecord (BaseRecord const &input, SchemaMapper const &mapper)
	Deep-copy a record, using a mapper to relate two schemas. More...
int	getVersion () const
	Return the table's version. More...
Schema	getSchema () const
	Return the table's schema. More...
void	preallocate (std::size_t nRecords)
	Allocate contiguous space for new records in advance. More...
std::size_t	getBufferSize () const
	Return the number of additional records space has been already been allocated for. More...
virtual	~BaseTable ()
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...

Static Public Member Functions
static boost::shared_ptr < SourceTable >	make (Schema const &schema, boost::shared_ptr< IdFactory > const &idFactory)
	Construct a new table. More...
static boost::shared_ptr < SourceTable >	make (Schema const &schema)
	Construct a new table. More...
static Schema	makeMinimalSchema ()
	Return a minimal schema for Source tables and records. More...
static bool	checkSchema (Schema const &other)
	Return true if the given schema is a valid SourceTable schema. More...
static Key< RecordId >	getParentKey ()
	Key for the parent ID. More...
Static Public Member Functions inherited from lsst.afw.table::SimpleTable
static boost::shared_ptr < SimpleTable >	make (Schema const &schema, boost::shared_ptr< IdFactory > const &idFactory)
	Construct a new table. More...
static boost::shared_ptr < SimpleTable >	make (Schema const &schema)
	Construct a new table. More...
static Schema	makeMinimalSchema ()
	Return a minimal schema for Simple tables and records. More...
static bool	checkSchema (Schema const &other)
	Return true if the given schema is a valid SimpleTable schema. More...
static Key< RecordId >	getIdKey ()
	Key for the unique ID. More...
static Key< Coord >	getCoordKey ()
	Key for the celestial coordinates. More...
Static Public Member Functions inherited from lsst.afw.table::BaseTable
static boost::shared_ptr < BaseTable >	make (Schema const &schema)
	Construct a new table. More...
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...

Protected Member Functions
	SourceTable (Schema const &schema, boost::shared_ptr< IdFactory > const &idFactory)
	SourceTable (SourceTable const &other)
virtual void	handleAliasChange (std::string const &alias)
Protected Member Functions inherited from lsst.afw.table::SimpleTable
	SimpleTable (Schema const &schema, boost::shared_ptr< IdFactory > const &idFactory)
	SimpleTable (SimpleTable const &other)
Protected Member Functions inherited from lsst.afw.table::BaseTable
template<typename Derived >
boost::shared_ptr< Derived >	getSelf ()
	Convenience function for static-casting shared_from_this for use by derived classes. More...
template<typename Derived >
boost::shared_ptr< Derived const >	getSelf () const
	Convenience function for static-casting shared_from_this for use by derived classes. More...
virtual boost::shared_ptr < BaseTable >	_clone () const =0
	Clone implementation with noncovariant return types. More...
virtual boost::shared_ptr < BaseRecord >	_makeRecord ()=0
	Default-construct an associated record (protected implementation). More...
	BaseTable (Schema const &schema)
	Construct from a schema. More...
	BaseTable (BaseTable const &other)
	Copy construct. More...

Private Member Functions
virtual boost::shared_ptr < io::FitsWriter >	makeFitsWriter (fits::Fits *fitsfile, int flags) const

Static Private Member Functions
static MinimalSchema &	getMinimalSchema ()

Private Attributes
SlotSuite	_slots

Friends
class	io::FitsWriter
class	SourceRecord

Additional Inherited Members
Static Public Attributes inherited from lsst.afw.table::BaseTable
static int	nRecordsPerBlock
	Number of records in each memory block. More...

Detailed Description

Table class that contains measurements made on a single exposure.

Definition at line 194 of file Source.h.

Member Typedef Documentation

typedef SortedCatalogT<Record> lsst.afw.table::SourceTable::Catalog

Definition at line 199 of file Source.h.

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

Definition at line 198 of file Source.h.

typedef SortedCatalogT<Record const> lsst.afw.table::SourceTable::ConstCatalog

Definition at line 200 of file Source.h.

typedef SourceRecord lsst.afw.table::SourceTable::Record

Definition at line 197 of file Source.h.

Constructor & Destructor Documentation

lsst.afw.table::SourceTable::SourceTable ( Schema const &  schema, boost::shared_ptr< IdFactory > const &  idFactory  )

protected

lsst.afw.table::SourceTable::SourceTable ( SourceTable const &  other )

protected

Member Function Documentation

static bool lsst.afw.table::SourceTable::checkSchema ( Schema const &  other )

inlinestatic

Return true if the given schema is a valid SourceTable schema.

This will always be true if the given schema was originally constructed using makeMinimalSchema(), and will rarely be true otherwise.

Definition at line 245 of file Source.h.

                                                  {
        return other.contains(getMinimalSchema().schema);
    }

boost::shared_ptr< SourceTable > lsst.afw.table::SourceTable::clone ( void  ) const

inline

Return a polymorphic deep copy of the table.

Derived classes should reimplement by static-casting the output of _clone to a pointer-to-derived to simulate covariant return types.

Cloning a table does not clone its associated records; the new table produced by clone() does not have any associated records.

Definition at line 253 of file Source.h.

{ return boost::static_pointer_cast<SourceTable>(_clone()); }

boost::shared_ptr< SourceRecord > lsst.afw.table::SourceTable::copyRecord ( BaseRecord const &  other )

inline

Deep-copy a record, requiring that it have the same schema as this table.

Regardless of the type or associated table of the input record, the type of the output record will be the type associated with this table and the record instance will be associated with this table.

Allowing derived-class records to be constructed from base-class records could be considered a form of type-slicing, but because we already demand that all records be constructable from nothing but a table, this isn't anything new.

Derived classes should reimplement by static-casting the output of BaseTable::copyRecord to the appropriate BaseRecord subclass.

This is implemented using makeRecord and calling record.assign on the results; override those to change the behavior.

Definition at line 259 of file Source.h.

                                                           {
        return boost::static_pointer_cast<SourceRecord>(BaseTable::copyRecord(other));
    }

boost::shared_ptr< SourceRecord > lsst.afw.table::SourceTable::copyRecord ( BaseRecord const &  other, SchemaMapper const &  mapper  )

inline

Deep-copy a record, requiring that it have the same schema as this table.

Regardless of the type or associated table of the input record, the type of the output record will be the type associated with this table and the record instance will be associated with this table.

Allowing derived-class records to be constructed from base-class records could be considered a form of type-slicing, but because we already demand that all records be constructable from nothing but a table, this isn't anything new.

Derived classes should reimplement by static-casting the output of BaseTable::copyRecord to the appropriate BaseRecord subclass.

This is implemented using makeRecord and calling record.assign on the results; override those to change the behavior.

Definition at line 264 of file Source.h.

                                                                                        {
        return boost::static_pointer_cast<SourceRecord>(BaseTable::copyRecord(other, mapper));
    }

void lsst.afw.table::SourceTable::defineApFlux ( std::string const &  name )

inline

Set the measurement used for the ApFlux slot.

The definitions for slots are actually managed by the Schema object, and its associated AliasMap, so this simply sets the "slot_ApFlux" alias (or "slot.ApFlux" for version 0 tables) to point to the given field name prefix. See FluxSlotDefinition for more information.

Definition at line 406 of file Source.h.

                                              {
        getSchema().getAliasMap()->set(getApFluxSlot().getAlias(getSchema().getVersion()), name);
    }

void lsst.afw.table::SourceTable::defineCentroid ( std::string const &  name )

inline

Set the measurement used for the Centroid slot.

The definitions for slots are actually managed by the Schema object, and its associated AliasMap, so this simply sets the "slot_Centroid" alias (or "slot.Centroid" for version 0 tables) to point to the given field name prefix. See CentroidSlotDefinition for more information.

Definition at line 534 of file Source.h.

                                                {
        getSchema().getAliasMap()->set(getCentroidSlot().getAlias(getSchema().getVersion()), name);
    }

void lsst.afw.table::SourceTable::defineInstFlux ( std::string const &  name )

inline

Set the measurement used for the InstFlux slot.

The definitions for slots are actually managed by the Schema object, and its associated AliasMap, so this simply sets the "slot_InstFlux" alias (or "slot.InstFlux" for version 0 tables) to point to the given field name prefix. See FluxSlotDefinition for more information.

Definition at line 470 of file Source.h.

                                                {
        getSchema().getAliasMap()->set(getInstFluxSlot().getAlias(getSchema().getVersion()), name);
    }

void lsst.afw.table::SourceTable::defineModelFlux ( std::string const &  name )

inline

Set the measurement used for the ModelFlux slot.

The definitions for slots are actually managed by the Schema object, and its associated AliasMap, so this simply sets the "slot_ModelFlux" alias (or "slot.ModelFlux" for version 0 tables) to point to the given field name prefix. See FluxSlotDefinition for more information.

Definition at line 342 of file Source.h.

                                                 {
        getSchema().getAliasMap()->set(getModelFluxSlot().getAlias(getSchema().getVersion()), name);
    }

void lsst.afw.table::SourceTable::definePsfFlux ( std::string const &  name )

inline

Set the measurement used for the PsfFlux slot.

The definitions for slots are actually managed by the Schema object, and its associated AliasMap, so this simply sets the "slot_PsfFlux" alias (or "slot.PsfFlux" for version 0 tables) to point to the given field name prefix. See FluxSlotDefinition for more information.

Definition at line 278 of file Source.h.

                                               {
        getSchema().getAliasMap()->set(getPsfFluxSlot().getAlias(getSchema().getVersion()), name);
    }

void lsst.afw.table::SourceTable::defineShape ( std::string const &  name )

inline

Set the measurement used for the Shape slot.

The definitions for slots are actually managed by the Schema object, and its associated AliasMap, so this simply sets the "slot_Shape" alias (or "slot.Shape" for version 0 tables) to point to the given field name prefix. See ShapeSlotDefinition for more information.

Definition at line 598 of file Source.h.

                                             {
        getSchema().getAliasMap()->set(getShapeSlot().getAlias(getSchema().getVersion()), name);
    }

std::string lsst.afw.table::SourceTable::getApFluxDefinition ( ) const

inline

Return the name of the field used for the ApFlux slot.

Exceptions

NotFoundError

if the slot is not defined.

Deprecated:

in favor of

*  getSchema().getAliasMap()->get("slot_ApFlux")  # or "slot.ApFlux" for version 0 tables
*  

Definition at line 420 of file Source.h.

                                          {
        return getSchema().getAliasMap()->get(getApFluxSlot().getAlias(getSchema().getVersion()));
    }

FluxSlotDefinition::ErrKey lsst.afw.table::SourceTable::getApFluxErrKey ( ) const

inline

Return the key used for the ApFlux slot uncertainty.

Deprecated:

in favor of getApFluxSlot().getErrKey().

Definition at line 447 of file Source.h.

                                                     {
        return getApFluxSlot().getErrKey();
    }

Key<Flag> lsst.afw.table::SourceTable::getApFluxFlagKey ( ) const

inline

Return the key used for the ApFlux slot failure flag.

Deprecated:

in favor of getApFluxSlot().getFlagKey().

Definition at line 456 of file Source.h.

                                       {
        return getApFluxSlot().getFlagKey();
    }

FluxSlotDefinition::MeasKey lsst.afw.table::SourceTable::getApFluxKey ( ) const

inline

Return the key used for the ApFlux slot measurement value.

Deprecated:

in favor of getApFluxSlot().getMeasKey().

Definition at line 438 of file Source.h.

                                                   {
        return getApFluxSlot().getMeasKey();
    }

FluxSlotDefinition const& lsst.afw.table::SourceTable::getApFluxSlot ( ) const

inline

Definition at line 397 of file Source.h.

{ return _slots.defApFlux; }

std::string lsst.afw.table::SourceTable::getCentroidDefinition ( ) const

inline

Return the name of the field used for the Centroid slot.

Exceptions

NotFoundError

if the slot is not defined.

Deprecated:

in favor of

*  getSchema().getAliasMap()->get("slot_Centroid")  # or "slot.Centroid" for version 0 tables
*  

Definition at line 548 of file Source.h.

                                            {
        return getSchema().getAliasMap()->get(getCentroidSlot().getAlias(getSchema().getVersion()));
    }

CentroidSlotDefinition::ErrKey lsst.afw.table::SourceTable::getCentroidErrKey ( ) const

inline

Return the key used for the Centroid slot uncertainty.

Deprecated:

in favor of getCentroidSlot().getErrKey().

Definition at line 575 of file Source.h.

                                                           {
        return getCentroidSlot().getErrKey();
    }

Key<Flag> lsst.afw.table::SourceTable::getCentroidFlagKey ( ) const

inline

Return the key used for the Centroid slot failure flag.

Deprecated:

in favor of getCentroidSlot().getFlagKey().

Definition at line 584 of file Source.h.

                                         {
        return getCentroidSlot().getFlagKey();
    }

CentroidSlotDefinition::MeasKey lsst.afw.table::SourceTable::getCentroidKey ( ) const

inline

Return the key used for the Centroid slot measurement value.

Deprecated:

in favor of getCentroidSlot().getMeasKey().

Definition at line 566 of file Source.h.

                                                         {
        return getCentroidSlot().getMeasKey();
    }

CentroidSlotDefinition const& lsst.afw.table::SourceTable::getCentroidSlot ( ) const

inline

Definition at line 525 of file Source.h.

{ return _slots.defCentroid; }

std::string lsst.afw.table::SourceTable::getInstFluxDefinition ( ) const

inline

Return the name of the field used for the InstFlux slot.

Exceptions

NotFoundError

if the slot is not defined.

Deprecated:

in favor of

*  getSchema().getAliasMap()->get("slot_InstFlux")  # or "slot.InstFlux" for version 0 tables
*  

Definition at line 484 of file Source.h.

                                            {
        return getSchema().getAliasMap()->get(getInstFluxSlot().getAlias(getSchema().getVersion()));
    }

FluxSlotDefinition::ErrKey lsst.afw.table::SourceTable::getInstFluxErrKey ( ) const

inline

Return the key used for the InstFlux slot uncertainty.

Deprecated:

in favor of getInstFluxSlot().getErrKey().

Definition at line 511 of file Source.h.

                                                       {
        return getInstFluxSlot().getErrKey();
    }

Key<Flag> lsst.afw.table::SourceTable::getInstFluxFlagKey ( ) const

inline

Return the key used for the InstFlux slot failure flag.

Deprecated:

in favor of getInstFluxSlot().getFlagKey().

Definition at line 520 of file Source.h.

                                         {
        return getInstFluxSlot().getFlagKey();
    }

FluxSlotDefinition::MeasKey lsst.afw.table::SourceTable::getInstFluxKey ( ) const

inline

Return the key used for the InstFlux slot measurement value.

Deprecated:

in favor of getInstFluxSlot().getMeasKey().

Definition at line 502 of file Source.h.

                                                     {
        return getInstFluxSlot().getMeasKey();
    }

FluxSlotDefinition const& lsst.afw.table::SourceTable::getInstFluxSlot ( ) const

inline

Definition at line 461 of file Source.h.

{ return _slots.defInstFlux; }

static MinimalSchema& lsst.afw.table::SourceTable::getMinimalSchema ( )

staticprivate

std::string lsst.afw.table::SourceTable::getModelFluxDefinition ( ) const

inline

Return the name of the field used for the ModelFlux slot.

Exceptions

NotFoundError

if the slot is not defined.

Deprecated:

in favor of

*  getSchema().getAliasMap()->get("slot_ModelFlux")  # or "slot.ModelFlux" for version 0 tables
*  

Definition at line 356 of file Source.h.

                                             {
        return getSchema().getAliasMap()->get(getModelFluxSlot().getAlias(getSchema().getVersion()));
    }

FluxSlotDefinition::ErrKey lsst.afw.table::SourceTable::getModelFluxErrKey ( ) const

inline

Return the key used for the ModelFlux slot uncertainty.

Deprecated:

in favor of getModelFluxSlot().getErrKey().

Definition at line 383 of file Source.h.

                                                        {
        return getModelFluxSlot().getErrKey();
    }

Key<Flag> lsst.afw.table::SourceTable::getModelFluxFlagKey ( ) const

inline

Return the key used for the ModelFlux slot failure flag.

Deprecated:

in favor of getModelFluxSlot().getFlagKey().

Definition at line 392 of file Source.h.

                                          {
        return getModelFluxSlot().getFlagKey();
    }

FluxSlotDefinition::MeasKey lsst.afw.table::SourceTable::getModelFluxKey ( ) const

inline

Return the key used for the ModelFlux slot measurement value.

Deprecated:

in favor of getModelFluxSlot().getMeasKey().

Definition at line 374 of file Source.h.

                                                      {
        return getModelFluxSlot().getMeasKey();
    }

FluxSlotDefinition const& lsst.afw.table::SourceTable::getModelFluxSlot ( ) const

inline

Definition at line 333 of file Source.h.

{ return _slots.defModelFlux; }

static Key<RecordId> lsst.afw.table::SourceTable::getParentKey ( )

inlinestatic

Key for the parent ID.

Definition at line 250 of file Source.h.

{ return getMinimalSchema().parent; }

std::string lsst.afw.table::SourceTable::getPsfFluxDefinition ( ) const

inline

Return the name of the field used for the PsfFlux slot.

Exceptions

NotFoundError

if the slot is not defined.

Deprecated:

in favor of

*  getSchema().getAliasMap()->get("slot_PsfFlux")  # or "slot.PsfFlux" for version 0 tables
*  

Definition at line 292 of file Source.h.

                                           {
        return getSchema().getAliasMap()->get(getPsfFluxSlot().getAlias(getSchema().getVersion()));
    }

FluxSlotDefinition::ErrKey lsst.afw.table::SourceTable::getPsfFluxErrKey ( ) const

inline

Return the key used for the PsfFlux slot uncertainty.

Deprecated:

in favor of getPsfFluxSlot().getErrKey().

Definition at line 319 of file Source.h.

                                                      {
        return getPsfFluxSlot().getErrKey();
    }

Key<Flag> lsst.afw.table::SourceTable::getPsfFluxFlagKey ( ) const

inline

Return the key used for the PsfFlux slot failure flag.

Deprecated:

in favor of getPsfFluxSlot().getFlagKey().

Definition at line 328 of file Source.h.

                                        {
        return getPsfFluxSlot().getFlagKey();
    }

FluxSlotDefinition::MeasKey lsst.afw.table::SourceTable::getPsfFluxKey ( ) const

inline

Return the key used for the PsfFlux slot measurement value.

Deprecated:

in favor of getPsfFluxSlot().getMeasKey().

Definition at line 310 of file Source.h.

                                                    {
        return getPsfFluxSlot().getMeasKey();
    }

FluxSlotDefinition const& lsst.afw.table::SourceTable::getPsfFluxSlot ( ) const

inline

Definition at line 269 of file Source.h.

{ return _slots.defPsfFlux; }

std::string lsst.afw.table::SourceTable::getShapeDefinition ( ) const

inline

Return the name of the field used for the Shape slot.

Exceptions

NotFoundError

if the slot is not defined.

Deprecated:

in favor of

*  getSchema().getAliasMap()->get("slot_Shape")  # or "slot.Shape" for version 0 tables
*  

Definition at line 612 of file Source.h.

                                         {
        return getSchema().getAliasMap()->get(getShapeSlot().getAlias(getSchema().getVersion()));
    }

ShapeSlotDefinition::ErrKey lsst.afw.table::SourceTable::getShapeErrKey ( ) const

inline

Return the key used for the Shape slot uncertainty.

Deprecated:

in favor of getShapeSlot().getErrKey().

Definition at line 639 of file Source.h.

                                                     {
        return getShapeSlot().getErrKey();
    }

Key<Flag> lsst.afw.table::SourceTable::getShapeFlagKey ( ) const

inline

Return the key used for the Shape slot failure flag.

Deprecated:

in favor of getShapeSlot().getFlagKey().

Definition at line 648 of file Source.h.

                                      {
        return getShapeSlot().getFlagKey();
    }

ShapeSlotDefinition::MeasKey lsst.afw.table::SourceTable::getShapeKey ( ) const

inline

Return the key used for the Shape slot measurement value.

Deprecated:

in favor of getShapeSlot().getMeasKey().

Definition at line 630 of file Source.h.

                                                   {
        return getShapeSlot().getMeasKey();
    }

ShapeSlotDefinition const& lsst.afw.table::SourceTable::getShapeSlot ( ) const

inline

Definition at line 589 of file Source.h.

{ return _slots.defShape; }

virtual void lsst.afw.table::SourceTable::handleAliasChange ( std::string const &  alias )

protectedvirtual

Reimplemented from lsst.afw.table::BaseTable.

bool lsst.afw.table::SourceTable::hasApFluxSlot ( ) const

inline

Return true if the ApFlux slot corresponds to a valid field.

Deprecated:

in favor of getApFluxSlot().isValid().

Definition at line 429 of file Source.h.

                               {
        return getApFluxSlot().isValid();
    }

bool lsst.afw.table::SourceTable::hasCentroidSlot ( ) const

inline

Return true if the Centroid slot corresponds to a valid field.

Deprecated:

in favor of getCentroidSlot().isValid().

Definition at line 557 of file Source.h.

                                 {
        return getCentroidSlot().isValid();
    }

bool lsst.afw.table::SourceTable::hasInstFluxSlot ( ) const

inline

Return true if the InstFlux slot corresponds to a valid field.

Deprecated:

in favor of getInstFluxSlot().isValid().

Definition at line 493 of file Source.h.

                                 {
        return getInstFluxSlot().isValid();
    }

bool lsst.afw.table::SourceTable::hasModelFluxSlot ( ) const

inline

Return true if the ModelFlux slot corresponds to a valid field.

Deprecated:

in favor of getModelFluxSlot().isValid().

Definition at line 365 of file Source.h.

                                  {
        return getModelFluxSlot().isValid();
    }

bool lsst.afw.table::SourceTable::hasPsfFluxSlot ( ) const

inline

Return true if the PsfFlux slot corresponds to a valid field.

Deprecated:

in favor of getPsfFluxSlot().isValid().

Definition at line 301 of file Source.h.

                                {
        return getPsfFluxSlot().isValid();
    }

bool lsst.afw.table::SourceTable::hasShapeSlot ( ) const

inline

Return true if the Shape slot corresponds to a valid field.

Deprecated:

in favor of getShapeSlot().isValid().

Definition at line 621 of file Source.h.

                              {
        return getShapeSlot().isValid();
    }

static boost::shared_ptr< SourceTable > lsst.afw.table::SourceTable::make ( Schema const &  schema, boost::shared_ptr< IdFactory > const &  idFactory  )

static

Construct a new table.

Parameters

[in]	schema	Schema that defines the fields, offsets, and record size for the table.
[in]	idFactory	Factory class to generate record IDs when they are not explicitly given. If null, record IDs will default to zero.

Note that not passing an IdFactory at all will call the other override of make(), which will set the ID factory to IdFactory::makeSimple().

static boost::shared_ptr< SourceTable > lsst.afw.table::SourceTable::make ( Schema const &  schema )

inlinestatic

Construct a new table.

Parameters

[in]

schema

Schema that defines the fields, offsets, and record size for the table.

This overload sets the ID factory to IdFactory::makeSimple().

Definition at line 221 of file Source.h.

{ return make(schema, IdFactory::makeSimple()); }

virtual boost::shared_ptr< io::FitsWriter > lsst.afw.table::SourceTable::makeFitsWriter ( fits::Fits *  fitsfile, int  flags  ) const

privatevirtual

Reimplemented from lsst.afw.table::SimpleTable.

static Schema lsst.afw.table::SourceTable::makeMinimalSchema ( )

inlinestatic

Return a minimal schema for Source tables and records.

The returned schema can and generally should be modified further, but many operations on sources will assume that at least the fields provided by this routine are present.

Keys for the standard fields added by this routine can be obtained from other static member functions of the SourceTable class.

Definition at line 233 of file Source.h.

                                      {
        Schema r = getMinimalSchema().schema;
        r.disconnectAliases();
        return r;
    }

boost::shared_ptr< SourceRecord > lsst.afw.table::SourceTable::makeRecord ( )

inline

Default-construct an associated record.

Derived classes should reimplement by static-casting the output of _makeRecord to the appropriate BaseRecord subclass to simulate covariant return types.

Definition at line 256 of file Source.h.

{ return boost::static_pointer_cast<SourceRecord>(_makeRecord()); }

Friends And Related Function Documentation

friend class io::FitsWriter

friend

Definition at line 674 of file Source.h.

friend class SourceRecord

friend

Definition at line 675 of file Source.h.

Member Data Documentation

SlotSuite lsst.afw.table::SourceTable::_slots

private

Definition at line 680 of file Source.h.

---

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

• /home/lsstsw/stack/Linux64/afw/10.0-40-g4349866+2/include/lsst/afw/table/Source.h