lsst::afw::detection::PeakRecord Class Reference

Record class that represents a peak in a Footprint. More...

#include <Peak.h>

Inheritance diagram for lsst::afw::detection::PeakRecord:

Public Types
typedef PeakTable	Table
typedef afw::table::ColumnViewT < PeakRecord >	ColumnView
typedef afw::table::CatalogT < PeakRecord >	Catalog
typedef afw::table::CatalogT < PeakRecord 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< PeakTable const >	getTable () const
afw::table::RecordId	getId () const
	Convenience accessors for the keys in the minimal schema. More...
void	setId (afw::table::RecordId id)
	Convenience accessors for the keys in the minimal schema. More...
int	getIx () const
	Convenience accessors for the keys in the minimal schema. More...
int	getIy () const
	Convenience accessors for the keys in the minimal schema. More...
void	setIx (int ix)
	Convenience accessors for the keys in the minimal schema. More...
void	setIy (int iy)
	Convenience accessors for the keys in the minimal schema. More...
afw::geom::Point2I	getI () const
	Convenience accessors for the keys in the minimal schema. More...
afw::geom::Point2I	getCentroid (bool) const
	Convenience accessors for the keys in the minimal schema. More...
float	getFx () const
	Convenience accessors for the keys in the minimal schema. More...
float	getFy () const
	Convenience accessors for the keys in the minimal schema. More...
void	setFx (float fx)
	Convenience accessors for the keys in the minimal schema. More...
void	setFy (float fy)
	Convenience accessors for the keys in the minimal schema. More...
afw::geom::Point2D	getF () const
	Convenience accessors for the keys in the minimal schema. More...
afw::geom::Point2D	getCentroid () const
	Convenience accessors for the keys in the minimal schema. More...
float	getPeakValue () const
	Convenience accessors for the keys in the minimal schema. More...
void	setPeakValue (float peakValue)
	Convenience accessors for the keys in the minimal 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
	PeakRecord (boost::shared_ptr< PeakTable > const &table)
Protected Member Functions inherited from lsst::afw::table::BaseRecord
virtual void	_assign (BaseRecord const &other)
	Called by assign() after transferring fields to allow subclass data members to be copied. More...
	BaseRecord (boost::shared_ptr< BaseTable > const &table)
	Construct a record with uninitialized data. More...

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 represents a peak in a Footprint.

Definition at line 40 of file Peak.h.

Member Typedef Documentation

typedef afw::table::CatalogT<PeakRecord> lsst::afw::detection::PeakRecord::Catalog

Definition at line 45 of file Peak.h.

typedef afw::table::ColumnViewT<PeakRecord> lsst::afw::detection::PeakRecord::ColumnView

Definition at line 44 of file Peak.h.

typedef afw::table::CatalogT<PeakRecord const> lsst::afw::detection::PeakRecord::ConstCatalog

Definition at line 46 of file Peak.h.

typedef PeakTable lsst::afw::detection::PeakRecord::Table

Definition at line 43 of file Peak.h.

Constructor & Destructor Documentation

lsst::afw::detection::PeakRecord::PeakRecord ( boost::shared_ptr< PeakTable > const &  table )

protected

Definition at line 145 of file Peak.cc.

: BaseRecord(table) {}

Member Function Documentation

afw::geom::Point2I lsst::afw::detection::PeakRecord::getCentroid ( bool  ) const

inline

Convenience accessors for the keys in the minimal schema.

Definition at line 62 of file Peak.h.

{ return getI(); }

afw::geom::Point2D lsst::afw::detection::PeakRecord::getCentroid ( ) const

inline

Convenience accessors for the keys in the minimal schema.

Definition at line 69 of file Peak.h.

{ return getF(); }

afw::geom::Point2D lsst::afw::detection::PeakRecord::getF ( ) const

inline

Convenience accessors for the keys in the minimal schema.

Definition at line 68 of file Peak.h.

{ return afw::geom::Point2D(getFx(), getFy()); }

float lsst::afw::detection::PeakRecord::getFx ( ) const

inline

Convenience accessors for the keys in the minimal schema.

Definition at line 214 of file Peak.h.

{ return get(PeakTable::getFxKey()); }

float lsst::afw::detection::PeakRecord::getFy ( ) const

inline

Convenience accessors for the keys in the minimal schema.

Definition at line 215 of file Peak.h.

{ return get(PeakTable::getFyKey()); }

afw::geom::Point2I lsst::afw::detection::PeakRecord::getI ( ) const

inline

Convenience accessors for the keys in the minimal schema.

Definition at line 61 of file Peak.h.

{ return afw::geom::Point2I(getIx(), getIy()); }

afw::table::RecordId lsst::afw::detection::PeakRecord::getId ( ) const

inline

Convenience accessors for the keys in the minimal schema.

Definition at line 206 of file Peak.h.

{ return get(PeakTable::getIdKey()); }

int lsst::afw::detection::PeakRecord::getIx ( ) const

inline

Convenience accessors for the keys in the minimal schema.

Definition at line 209 of file Peak.h.

{ return get(PeakTable::getIxKey()); }

int lsst::afw::detection::PeakRecord::getIy ( ) const

inline

Convenience accessors for the keys in the minimal schema.

Definition at line 210 of file Peak.h.

{ return get(PeakTable::getIyKey()); }

float lsst::afw::detection::PeakRecord::getPeakValue ( ) const

inline

Convenience accessors for the keys in the minimal schema.

Definition at line 219 of file Peak.h.

{ return get(PeakTable::getPeakValueKey()); }

boost::shared_ptr< PeakTable const> lsst::afw::detection::PeakRecord::getTable ( ) const

inline

Definition at line 48 of file Peak.h.

                                          {
        return boost::static_pointer_cast<PeakTable const>(afw::table::BaseRecord::getTable());
    }

void lsst::afw::detection::PeakRecord::setFx ( float  fx )

inline

Convenience accessors for the keys in the minimal schema.

Definition at line 216 of file Peak.h.

{ set(PeakTable::getFxKey(), fx); }

void lsst::afw::detection::PeakRecord::setFy ( float  fy )

inline

Convenience accessors for the keys in the minimal schema.

Definition at line 217 of file Peak.h.

{ set(PeakTable::getFyKey(), fy); }

void lsst::afw::detection::PeakRecord::setId ( afw::table::RecordId  id )

inline

Convenience accessors for the keys in the minimal schema.

Definition at line 207 of file Peak.h.

{ set(PeakTable::getIdKey(), id); }

void lsst::afw::detection::PeakRecord::setIx ( int  ix )

inline

Convenience accessors for the keys in the minimal schema.

Definition at line 211 of file Peak.h.

{ set(PeakTable::getIxKey(), ix); }

void lsst::afw::detection::PeakRecord::setIy ( int  iy )

inline

Convenience accessors for the keys in the minimal schema.

Definition at line 212 of file Peak.h.

{ set(PeakTable::getIyKey(), iy); }

void lsst::afw::detection::PeakRecord::setPeakValue ( float  peakValue )

inline

Convenience accessors for the keys in the minimal schema.

Definition at line 220 of file Peak.h.

{ set(PeakTable::getPeakValueKey(), peakValue); }

---

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

• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/detection/Peak.h
• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/src/detection/Peak.cc