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
using	Table = PeakTable
using	ColumnView = afw::table::ColumnViewT<PeakRecord>
using	Catalog = afw::table::CatalogT<PeakRecord>
using	ConstCatalog = afw::table::CatalogT<const PeakRecord>

Public Member Functions
	PeakRecord (ConstructionToken const &token, table::detail::RecordData &&data)
	Constructor used by PeakTable.
	~PeakRecord () override=default
	PeakRecord (PeakRecord const &)=delete
	PeakRecord (PeakRecord &&)=delete
PeakRecord &	operator= (PeakRecord const &)=delete
PeakRecord &	operator= (PeakRecord &&)=delete
std::shared_ptr< PeakTable const >	getTable () const
afw::table::RecordId	getId () const
	Convenience accessors for the keys in the minimal schema.
void	setId (afw::table::RecordId id)
int	getIx () const
int	getIy () const
void	setIx (int ix)
void	setIy (int iy)
lsst::geom::Point2I	getI () const
lsst::geom::Point2I	getCentroid (bool) const
float	getFx () const
float	getFy () const
void	setFx (float fx)
void	setFy (float fy)
lsst::geom::Point2D	getF () const
lsst::geom::Point2D	getCentroid () const
float	getPeakValue () const
void	setPeakValue (float peakValue)
Schema	getSchema () const
	Return the Schema that holds this record's fields and keys.
template<typename T >
Field< T >::Element *	getElement (Key< T > const &key)
	Return a pointer to the underlying elements of a field (non-const).
template<typename T >
Field< T >::Element const *	getElement (Key< T > const &key) const
	Return a pointer to the underlying elements of a field (const).
template<typename T >
Field< T >::Reference	operator[] (Key< T > const &key)
	Return a reference (or reference-like type) to the field's value.
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.
template<typename Ref >
Ref	operator[] (ReferenceFunctorKey< Ref > const &key)
template<typename ConstRef >
ConstRef	operator[] (ConstReferenceFunctorKey< ConstRef > const &key) const
template<typename T >
Field< T >::Value	get (Key< T > const &key) const
	Return the value of a field for the given key.
template<typename T >
T	get (OutputFunctorKey< T > const &key) const
	Compute a calculated or aggregate field.
template<typename T , typename U >
void	set (Key< T > const &key, U const &value)
	Set value of a field for the given key.
template<typename T , typename U >
void	set (InputFunctorKey< T > const &key, U const &value)
	Set a calculated or aggregate field.
void	assign (BaseRecord const &other)
	Copy all field values from other to this, requiring that they have equal schemas.
void	assign (BaseRecord const &other, SchemaMapper const &mapper)
	Copy field values from other to this, using a mapper.
ndarray::Manager::Ptr	getManager () const

Protected Member Functions
virtual void	_assign (BaseRecord const &other)
	Called by assign() after transferring fields to allow subclass data members to be copied.
virtual void	_stream (std::ostream &os) const
	Called by operator<<.

Friends
class	PeakTable

Detailed Description

Record class that represents a peak in a Footprint.

Definition at line 42 of file Peak.h.

Member Typedef Documentation

Catalog

using lsst::afw::detection::PeakRecord::Catalog = afw::table::CatalogT<PeakRecord>

Definition at line 46 of file Peak.h.

ColumnView

using lsst::afw::detection::PeakRecord::ColumnView = afw::table::ColumnViewT<PeakRecord>

Definition at line 45 of file Peak.h.

ConstCatalog

using lsst::afw::detection::PeakRecord::ConstCatalog = afw::table::CatalogT<const PeakRecord>

Definition at line 47 of file Peak.h.

Table

using lsst::afw::detection::PeakRecord::Table = PeakTable

Definition at line 44 of file Peak.h.

Constructor & Destructor Documentation

PeakRecord() [1/3]

lsst::afw::detection::PeakRecord::PeakRecord ( ConstructionToken const & token, table::detail::RecordData && data )

inline

Constructor used by PeakTable.

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.

Definition at line 58 of file Peak.h.

                                                                               :
        BaseRecord(token, std::move(data))
    {}

~PeakRecord()

lsst::afw::detection::PeakRecord::~PeakRecord ( )

overridedefault

PeakRecord() [2/3]

lsst::afw::detection::PeakRecord::PeakRecord ( PeakRecord const & )

delete

PeakRecord() [3/3]

lsst::afw::detection::PeakRecord::PeakRecord ( PeakRecord && )

delete

Member Function Documentation

_assign()

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

inlineprotectedvirtualinherited

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

Reimplemented in lsst::afw::table::SourceRecord, and lsst::afw::table::ExposureRecord.

Definition at line 209 of file BaseRecord.h.

{}

_stream()

void lsst::afw::table::BaseRecord::_stream ( std::ostream & os ) const

protectedvirtualinherited

Called by operator<<.

Overrides should call the base class implementation and append additional fields on new lines, with the syntax "%(name)s: %(value)s".

Definition at line 152 of file BaseRecord.cc.

                                             {
    getSchema().forEach([&os, this](auto const& item) {
        os << item.field.getName() << ": " << this->get(item.key) << std::endl;
    });
}

assign() [1/2]

void lsst::afw::table::BaseRecord::assign ( BaseRecord const & other )

inherited

Copy all field values from other to this, requiring that they have equal schemas.

Definition at line 122 of file BaseRecord.cc.

                                               {
    if (this->getSchema() != other.getSchema()) {
        throw LSST_EXCEPT(lsst::pex::exceptions::LogicError, "Unequal schemas in record assignment.");
    }
    this->getSchema().forEach(CopyValue(&other, this));
    this->_assign(other);  // let derived classes assign their own stuff
}

assign() [2/2]

void lsst::afw::table::BaseRecord::assign ( BaseRecord const & other, SchemaMapper const & mapper )

inherited

Copy field values from other to this, using a mapper.

Definition at line 130 of file BaseRecord.cc.

                                                                           {
    if (!other.getSchema().contains(mapper.getInputSchema())) {
        throw LSST_EXCEPT(lsst::pex::exceptions::LogicError,
                          "Unequal schemas between input record and mapper.");
    }
    if (!this->getSchema().contains(mapper.getOutputSchema())) {
        throw LSST_EXCEPT(lsst::pex::exceptions::LogicError,
                          "Unequal schemas between output record and mapper.");
    }
    mapper.forEach(CopyValue(&other, this));  // use the functor we defined above
    this->_assign(other);                     // let derived classes assign their own stuff
}

get() [1/2]

template<typename T >

Field< T >::Value lsst::afw::table::BaseRecord::get ( Key< T > const & key ) const

inlineinherited

Return the value of a field for the given key.

No checking is done to ensure the Key belongs to the correct schema.

Definition at line 151 of file BaseRecord.h.

                                                        {
        return key.getValue(getElement(key), _manager);
    }

get() [2/2]

template<typename T >

T lsst::afw::table::BaseRecord::get ( OutputFunctorKey< T > const & key ) const

inlineinherited

Compute a calculated or aggregate field.

Definition at line 172 of file BaseRecord.h.

                                                {
        return key.get(*this);
    }

getCentroid() [1/2]

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

inline

Definition at line 89 of file Peak.h.

{ return getF(); }

getCentroid() [2/2]

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

inline

Definition at line 82 of file Peak.h.

{ return getI(); }

getElement() [1/2]

template<typename T >

Field< T >::Element * lsst::afw::table::BaseRecord::getElement ( Key< T > const & key )

inlineinherited

Return a pointer to the underlying elements of a field (non-const).

This low-level access is intended mostly for use with serialization; users should generally prefer the safer get(), set() and operator[] member functions.

Definition at line 93 of file BaseRecord.h.

                                                            {
        if (!key.isValid()) {
            throw LSST_EXCEPT(
                    pex::exceptions::LogicError,
                    "Key is not valid (if this is a SourceRecord, make sure slot aliases have been set up).");
        }
        return reinterpret_cast<typename Field<T>::Element*>(reinterpret_cast<char*>(_data) +
                                                             key.getOffset());
    }

getElement() [2/2]

template<typename T >

Field< T >::Element const * lsst::afw::table::BaseRecord::getElement ( Key< T > const & key ) const

inlineinherited

Return a pointer to the underlying elements of a field (const).

This low-level access is intended mostly for use with serialization; users should generally prefer the safer get(), set() and operator[] member functions.

Definition at line 111 of file BaseRecord.h.

                                                                        {
        if (!key.isValid()) {
            throw LSST_EXCEPT(
                    pex::exceptions::LogicError,
                    "Key is not valid (if this is a SourceRecord, make sure slot aliases have been set up).");
        }
        return reinterpret_cast<typename Field<T>::Element const*>(reinterpret_cast<char const*>(_data) +
                                                                   key.getOffset());
    }

getF()

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

inline

Definition at line 88 of file Peak.h.

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

getFx()

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

inline

Definition at line 235 of file Peak.h.

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

getFy()

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

inline

Definition at line 236 of file Peak.h.

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

getI()

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

inline

Definition at line 81 of file Peak.h.

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

getId()

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

inline

Convenience accessors for the keys in the minimal schema.

Definition at line 227 of file Peak.h.

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

getIx()

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

inline

Definition at line 230 of file Peak.h.

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

getIy()

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

inline

Definition at line 231 of file Peak.h.

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

getManager()

ndarray::Manager::Ptr lsst::afw::table::BaseRecord::getManager ( ) const

inlineinherited

Definition at line 200 of file BaseRecord.h.

{ return _manager; }

getPeakValue()

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

inline

Definition at line 240 of file Peak.h.

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

getSchema()

Schema lsst::afw::table::BaseRecord::getSchema ( ) const

inlineinherited

Return the Schema that holds this record's fields and keys.

Definition at line 80 of file BaseRecord.h.

{ return _table->getSchema(); }

getTable()

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

inline

Definition at line 68 of file Peak.h.

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

operator=() [1/2]

PeakRecord & lsst::afw::detection::PeakRecord::operator= ( PeakRecord && )

delete

operator=() [2/2]

PeakRecord & lsst::afw::detection::PeakRecord::operator= ( PeakRecord const & )

delete

operator[]() [1/4]

template<typename ConstRef >

ConstRef lsst::afw::table::BaseRecord::operator[] ( ConstReferenceFunctorKey< ConstRef > const & key ) const

inlineinherited

Definition at line 190 of file BaseRecord.h.

                                                                             {
        return key.getConstReference(*this);
    }

operator[]() [2/4]

template<typename T >

Field< T >::Reference lsst::afw::table::BaseRecord::operator[] ( Key< T > const & key )

inlineinherited

Return a reference (or reference-like type) to the field's value.

Some field types (Point, Moments, Flag, Covariance, and SpherePoint) do not support reference access.

No checking is done to ensure the Key belongs to the correct schema.

Definition at line 129 of file BaseRecord.h.

                                                             {
        return key.getReference(getElement(key), _manager);
    }

operator[]() [3/4]

template<typename T >

Field< T >::ConstReference lsst::afw::table::BaseRecord::operator[] ( Key< T > const & key ) const

inlineinherited

Return a const reference (or const-reference-like type) to the field's value.

Some field types (Point, Moments, Flag, Covariance, and SpherePoint) do not support reference access.

No checking is done to ensure the Key belongs to the correct schema.

Definition at line 141 of file BaseRecord.h.

                                                                        {
        return key.getConstReference(getElement(key), _manager);
    }

operator[]() [4/4]

template<typename Ref >

Ref lsst::afw::table::BaseRecord::operator[] ( ReferenceFunctorKey< Ref > const & key )

inlineinherited

Definition at line 185 of file BaseRecord.h.

                                                        {
        return key.getReference(*this);
    }

set() [1/2]

template<typename T , typename U >

void lsst::afw::table::BaseRecord::set ( InputFunctorKey< T > const & key, U const & value )

inlineinherited

Set a calculated or aggregate field.

Definition at line 180 of file BaseRecord.h.

                                                            {
        return key.set(*this, value);
    }

set() [2/2]

template<typename T , typename U >

void lsst::afw::table::BaseRecord::set ( Key< T > const & key, U const & value )

inlineinherited

Set value of a field for the given key.

This method has an additional template parameter because some fields accept and convert different types to the stored field type.

No checking is done to ensure the Key belongs to the correct schema.

Definition at line 164 of file BaseRecord.h.

                                                {
        key.setValue(getElement(key), _manager, value);
    }

setFx()

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

inline

Definition at line 237 of file Peak.h.

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

setFy()

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

inline

Definition at line 238 of file Peak.h.

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

setId()

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

inline

Definition at line 228 of file Peak.h.

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

setIx()

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

inline

Definition at line 232 of file Peak.h.

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

setIy()

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

inline

Definition at line 233 of file Peak.h.

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

setPeakValue()

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

inline

Definition at line 241 of file Peak.h.

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

Friends And Related Symbol Documentation

PeakTable

friend class PeakTable

friend

Definition at line 96 of file Peak.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/gef2f8181fd+3031e3cf99/include/lsst/afw/detection/Peak.h