Record class used to store exposure metadata. More...

#include <Exposure.h>

Inheritance diagram for lsst::afw::table::ExposureRecord:

Public Types
typedef ExposureTable	Table

typedef ColumnViewT < ExposureRecord >	ColumnView

typedef ExposureCatalogT < ExposureRecord >	Catalog

typedef ExposureCatalogT < ExposureRecord 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 < ExposureTable const >	getTable () const

RecordId	getId () const

void	setId (RecordId id)

geom::Box2I	getBBox () const

void	setBBox (geom::Box2I const &bbox)

bool	contains (Coord const &coord, bool includeValidPolygon=false) const
	Return true if the bounding box contains the given celestial coordinate point, taking into account the Wcs of the ExposureRecord. If includeValidPolygon is true it will also check that the point is within the validPolygon of this ExpoureRecord if it has one; otherwise, this argument is ignored. More...

bool	contains (geom::Point2D const &point, image::Wcs const &wcs, bool includeValidPolygon=false) const
	Return true if the bounding box contains the given point, taking into account its Wcs (given) and the Wcs of the ExposureRecord. If includeValidPolygon is true it will also check that the point is within the validPolygon of this ExposureRecord if present if it has one; otherwise, this argument is ignored. More...


boost::shared_ptr< image::Wcs const >	getWcs () const
	Get/Set the the attached Wcs, Psf, Calib, or ApCorrMap. No copies are made. More...

void	setWcs (boost::shared_ptr< image::Wcs const > wcs)
	Get/Set the the attached Wcs, Psf, Calib, or ApCorrMap. No copies are made. More...

boost::shared_ptr < detection::Psf const >	getPsf () const
	Get/Set the the attached Wcs, Psf, Calib, or ApCorrMap. No copies are made. More...

void	setPsf (boost::shared_ptr< detection::Psf const > psf)
	Get/Set the the attached Wcs, Psf, Calib, or ApCorrMap. No copies are made. More...

boost::shared_ptr < image::Calib const >	getCalib () const
	Get/Set the the attached Wcs, Psf, Calib, or ApCorrMap. No copies are made. More...

void	setCalib (boost::shared_ptr< image::Calib const > calib)
	Get/Set the the attached Wcs, Psf, Calib, or ApCorrMap. No copies are made. More...

boost::shared_ptr < image::ApCorrMap const >	getApCorrMap () const
	Get/Set the the attached Wcs, Psf, Calib, or ApCorrMap. No copies are made. More...

void	setApCorrMap (boost::shared_ptr< image::ApCorrMap const > apCorrMap)
	Get/Set the the attached Wcs, Psf, Calib, or ApCorrMap. No copies are made. More...

boost::shared_ptr < geom::polygon::Polygon const >	getValidPolygon () const
	Get/Set the the attached Wcs, Psf, Calib, or ApCorrMap. No copies are made. More...

void	setValidPolygon (boost::shared_ptr< geom::polygon::Polygon const > polygon)
	Get/Set the the attached Wcs, Psf, Calib, or ApCorrMap. No copies are made. 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
	ExposureRecord (boost::shared_ptr< ExposureTable > 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::BaseRecord
	BaseRecord (boost::shared_ptr< BaseTable > const &table)
	Construct a record with uninitialized data. More...

Private Attributes
boost::shared_ptr< image::Wcs const >	_wcs

boost::shared_ptr < detection::Psf const >	_psf

boost::shared_ptr < image::Calib const >	_calib

boost::shared_ptr < image::ApCorrMap const >	_apCorrMap

boost::shared_ptr < geom::polygon::Polygon const >	_validPolygon

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 used to store exposure metadata.

Definition at line 67 of file Exposure.h.

Member Typedef Documentation

typedef ExposureCatalogT<ExposureRecord> lsst::afw::table::ExposureRecord::Catalog

Definition at line 72 of file Exposure.h.

typedef ColumnViewT<ExposureRecord> lsst::afw::table::ExposureRecord::ColumnView

Definition at line 71 of file Exposure.h.

typedef ExposureCatalogT<ExposureRecord const> lsst::afw::table::ExposureRecord::ConstCatalog

Definition at line 73 of file Exposure.h.

typedef ExposureTable lsst::afw::table::ExposureRecord::Table

Definition at line 70 of file Exposure.h.

Constructor & Destructor Documentation

lsst::afw::table::ExposureRecord::ExposureRecord ( boost::shared_ptr< ExposureTable > const & table )

protected

Member Function Documentation

virtual void lsst::afw::table::ExposureRecord::_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.

bool lsst::afw::table::ExposureRecord::contains	(	Coord const &	coord,
		bool	includeValidPolygon = `false`
	)		const

Return true if the bounding box contains the given celestial coordinate point, taking into account the Wcs of the ExposureRecord. If includeValidPolygon is true it will also check that the point is within the validPolygon of this ExpoureRecord if it has one; otherwise, this argument is ignored.

Exceptions

LogicError if the ExposureRecord has no Wcs.

bool lsst::afw::table::ExposureRecord::contains	(	geom::Point2D const &	point,
		image::Wcs const &	wcs,
		bool	includeValidPolygon = `false`
	)		const

Return true if the bounding box contains the given point, taking into account its Wcs (given) and the Wcs of the ExposureRecord. If includeValidPolygon is true it will also check that the point is within the validPolygon of this ExposureRecord if present if it has one; otherwise, this argument is ignored.

Exceptions

LogicError if the ExposureRecord has no Wcs.

boost::shared_ptr< image::ApCorrMap const> lsst::afw::table::ExposureRecord::getApCorrMap ( ) const

inline

Get/Set the the attached Wcs, Psf, Calib, or ApCorrMap. No copies are made.

Definition at line 116 of file Exposure.h.

116 { return _apCorrMap; }

lsst::afw::table::ExposureRecord::_apCorrMap

boost::shared_ptr< image::ApCorrMap const > _apCorrMap

Definition: Exposure.h:133

geom::Box2I lsst::afw::table::ExposureRecord::getBBox ( ) const

boost::shared_ptr< image::Calib const> lsst::afw::table::ExposureRecord::getCalib ( ) const

inline

Get/Set the the attached Wcs, Psf, Calib, or ApCorrMap. No copies are made.

Definition at line 113 of file Exposure.h.

113 { return _calib; }

lsst::afw::table::ExposureRecord::_calib

boost::shared_ptr< image::Calib const > _calib

Definition: Exposure.h:132

RecordId lsst::afw::table::ExposureRecord::getId ( ) const

inline

Definition at line 418 of file Exposure.h.

418 { return get(ExposureTable::getIdKey()); }

lsst::afw::table::ExposureTable::getIdKey

static Key< RecordId > getIdKey()

Key for the unique ID.

Definition: Exposure.h:187

boost::shared_ptr< detection::Psf const> lsst::afw::table::ExposureRecord::getPsf ( ) const

inline

Get/Set the the attached Wcs, Psf, Calib, or ApCorrMap. No copies are made.

Definition at line 110 of file Exposure.h.

110 { return _psf; }

lsst::afw::table::ExposureRecord::_psf

boost::shared_ptr< detection::Psf const > _psf

Definition: Exposure.h:131

boost::shared_ptr< ExposureTable const> lsst::afw::table::ExposureRecord::getTable ( ) const

inline

Definition at line 75 of file Exposure.h.

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

boost::shared_ptr< geom::polygon::Polygon const> lsst::afw::table::ExposureRecord::getValidPolygon ( ) const

inline

Get/Set the the attached Wcs, Psf, Calib, or ApCorrMap. No copies are made.

Definition at line 119 of file Exposure.h.

119 { return _validPolygon; }

lsst::afw::table::ExposureRecord::_validPolygon

boost::shared_ptr< geom::polygon::Polygon const > _validPolygon

Definition: Exposure.h:134

boost::shared_ptr< image::Wcs const> lsst::afw::table::ExposureRecord::getWcs ( ) const

inline

Get/Set the the attached Wcs, Psf, Calib, or ApCorrMap. No copies are made.

Definition at line 107 of file Exposure.h.

107 { return _wcs; }

lsst::afw::table::ExposureRecord::_wcs

boost::shared_ptr< image::Wcs const > _wcs

Definition: Exposure.h:130

void lsst::afw::table::ExposureRecord::setApCorrMap ( boost::shared_ptr< image::ApCorrMap const > apCorrMap )

inline

Get/Set the the attached Wcs, Psf, Calib, or ApCorrMap. No copies are made.

Definition at line 117 of file Exposure.h.

117 { _apCorrMap = apCorrMap; }

lsst::afw::table::ExposureRecord::_apCorrMap

boost::shared_ptr< image::ApCorrMap const > _apCorrMap

Definition: Exposure.h:133

void lsst::afw::table::ExposureRecord::setBBox ( geom::Box2I const & bbox )

void lsst::afw::table::ExposureRecord::setCalib ( boost::shared_ptr< image::Calib const > calib )

inline

Get/Set the the attached Wcs, Psf, Calib, or ApCorrMap. No copies are made.

Definition at line 114 of file Exposure.h.

114 { _calib = calib; }

lsst::afw::table::ExposureRecord::_calib

boost::shared_ptr< image::Calib const > _calib

Definition: Exposure.h:132

void lsst::afw::table::ExposureRecord::setId ( RecordId id )

inline

Definition at line 419 of file Exposure.h.

419 { set(ExposureTable::getIdKey(), id); }

lsst::afw::table::ExposureTable::getIdKey

static Key< RecordId > getIdKey()

Key for the unique ID.

Definition: Exposure.h:187

lsst::afw::table::BaseRecord::set

void set(Key< T > const &key, U const &value)

Set value of a field for the given key.

Definition: BaseRecord.h:136

void lsst::afw::table::ExposureRecord::setPsf ( boost::shared_ptr< detection::Psf const > psf )

inline

Get/Set the the attached Wcs, Psf, Calib, or ApCorrMap. No copies are made.

Definition at line 111 of file Exposure.h.

111 { _psf = psf; }

lsst::afw::table::ExposureRecord::_psf

boost::shared_ptr< detection::Psf const > _psf

Definition: Exposure.h:131

void lsst::afw::table::ExposureRecord::setValidPolygon ( boost::shared_ptr< geom::polygon::Polygon const > polygon )

inline

Get/Set the the attached Wcs, Psf, Calib, or ApCorrMap. No copies are made.

Definition at line 120 of file Exposure.h.

120 { _validPolygon = polygon; }

lsst::afw::table::ExposureRecord::_validPolygon

boost::shared_ptr< geom::polygon::Polygon const > _validPolygon

Definition: Exposure.h:134

void lsst::afw::table::ExposureRecord::setWcs ( boost::shared_ptr< image::Wcs const > wcs )

inline

Get/Set the the attached Wcs, Psf, Calib, or ApCorrMap. No copies are made.

Definition at line 108 of file Exposure.h.

108 { _wcs = wcs; }

wcs

tbl::Key< int > wcs

Definition: CoaddBoundedField.cc:131

lsst::afw::table::ExposureRecord::_wcs

boost::shared_ptr< image::Wcs const > _wcs

Definition: Exposure.h:130

Member Data Documentation

boost::shared_ptr< image::ApCorrMap const> lsst::afw::table::ExposureRecord::_apCorrMap

private

Definition at line 133 of file Exposure.h.

boost::shared_ptr< image::Calib const> lsst::afw::table::ExposureRecord::_calib

private

Definition at line 132 of file Exposure.h.

boost::shared_ptr< detection::Psf const> lsst::afw::table::ExposureRecord::_psf

private

Definition at line 131 of file Exposure.h.

boost::shared_ptr< geom::polygon::Polygon const> lsst::afw::table::ExposureRecord::_validPolygon

private

Definition at line 134 of file Exposure.h.

boost::shared_ptr< image::Wcs const> lsst::afw::table::ExposureRecord::_wcs

private

Definition at line 130 of file Exposure.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/Exposure.h

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation