lsst::afw::detection::PeakTable Class Reference

Table class for Peaks in Footprints. More...

#include <Peak.h>

Inheritance diagram for lsst::afw::detection::PeakTable:

Public Types
using	Record = PeakRecord
using	ColumnView = afw::table::ColumnViewT< PeakRecord >
using	Catalog = afw::table::CatalogT< Record >
using	ConstCatalog = afw::table::CatalogT< const Record >

Public Member Functions
	~PeakTable () override
PeakTable &	operator= (PeakTable const &)=delete
PeakTable &	operator= (PeakTable &&)=delete
std::shared_ptr< afw::table::IdFactory >	getIdFactory ()
	Return the object that generates IDs for the table (may be null). More...
std::shared_ptr< afw::table::IdFactory const >	getIdFactory () const
	Return the object that generates IDs for the table (may be null). More...
void	setIdFactory (std::shared_ptr< afw::table::IdFactory > f)
	Switch to a new IdFactory – object that generates IDs for the table (may be null). More...
std::shared_ptr< PeakTable >	clone () const
	Return a polymorphic deep copy of the table. More...
std::shared_ptr< PeakRecord >	makeRecord ()
	Default-construct an associated record. More...
std::shared_ptr< PeakRecord >	copyRecord (afw::table::BaseRecord const &other)
	Deep-copy a record, requiring that it have the same schema as this table. More...
std::shared_ptr< PeakRecord >	copyRecord (afw::table::BaseRecord const &other, afw::table::SchemaMapper const &mapper)
	Deep-copy a record, requiring that it have the same schema as this table. More...
std::shared_ptr< daf::base::PropertyList >	getMetadata () const
	Return the flexible metadata associated with the table. May be null. More...
void	setMetadata (std::shared_ptr< daf::base::PropertyList > const &metadata)
	Set the flexible metadata associated with the table. May be null. More...
std::shared_ptr< daf::base::PropertyList >	popMetadata ()
	Return the metadata and set the internal metadata to a null pointer. 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...
T	shared_from_this (T... args)

Static Public Member Functions
static std::shared_ptr< PeakTable >	make (afw::table::Schema const &schema, bool forceNew=false)
	Obtain a table that can be used to create records with given schema. More...
static afw::table::Schema	makeMinimalSchema ()
	Return a minimal schema for Peak tables and records. More...
static bool	checkSchema (afw::table::Schema const &other)
	Return true if the given schema is a valid PeakTable schema. More...
static afw::table::Key< afw::table::RecordId >	getIdKey ()
	Get keys for standard fields shared by all peaks. More...
static afw::table::Key< int >	getIxKey ()
static afw::table::Key< int >	getIyKey ()
static afw::table::Key< float >	getFxKey ()
static afw::table::Key< float >	getFyKey ()
static afw::table::Key< float >	getPeakValueKey ()
static std::shared_ptr< BaseTable >	make (Schema const &schema)
	Construct a new table. More...

Static Public Attributes
static int	nRecordsPerBlock = 100
	Number of records in each memory block. More...

Protected Member Functions
	PeakTable (afw::table::Schema const &schema, std::shared_ptr< afw::table::IdFactory > const &idFactory)
	PeakTable (PeakTable const &other)
	PeakTable (PeakTable &&other)
std::shared_ptr< afw::table::BaseTable >	_clone () const override
	Clone implementation with noncovariant return types. More...
std::shared_ptr< afw::table::BaseRecord >	_makeRecord () override
	Default-construct an associated record (protected implementation). More...
template<typename RecordT , typename ... Args>
std::shared_ptr< RecordT >	constructRecord (Args &&...args)
	Helper function that must be used by all _makeRecord overrides to actually construct records. More...
virtual void	handleAliasChange (std::string const &alias)

Friends
class	afw::table::io::FitsWriter

Detailed Description

Table class for Peaks in Footprints.

Definition at line 102 of file Peak.h.

Member Typedef Documentation

Catalog

using lsst::afw::detection::PeakTable::Catalog = afw::table::CatalogT<Record>

Definition at line 106 of file Peak.h.

ColumnView

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

Definition at line 105 of file Peak.h.

ConstCatalog

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

Definition at line 107 of file Peak.h.

Record

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

Definition at line 104 of file Peak.h.

Constructor & Destructor Documentation

~PeakTable()

lsst::afw::detection::PeakTable::~PeakTable ( )

overridedefault

PeakTable() [1/3]

lsst::afw::detection::PeakTable::PeakTable ( afw::table::Schema const &  schema, std::shared_ptr< afw::table::IdFactory > const &  idFactory  )

protected

Definition at line 130 of file Peak.cc.

        : afw::table::BaseTable(schema), _idFactory(idFactory) {}

PeakTable() [2/3]

lsst::afw::detection::PeakTable::PeakTable ( PeakTable const &  other )

protected

Definition at line 134 of file Peak.cc.

        : afw::table::BaseTable(other),
          _idFactory(other._idFactory ? other._idFactory->clone() : other._idFactory) {}

PeakTable() [3/3]

lsst::afw::detection::PeakTable::PeakTable ( PeakTable &&  other )

protected

Definition at line 138 of file Peak.cc.

: PeakTable(other) {}

Member Function Documentation

_clone()

std::shared_ptr< afw::table::BaseTable > lsst::afw::detection::PeakTable::_clone ( ) const

overrideprotectedvirtual

Clone implementation with noncovariant return types.

Reimplemented from lsst::afw::table::BaseTable.

Definition at line 160 of file Peak.cc.

                                                         {
    return std::shared_ptr<PeakTable>(new PeakTable(*this));
}

_makeRecord()

std::shared_ptr< afw::table::BaseRecord > lsst::afw::detection::PeakTable::_makeRecord ( )

overrideprotectedvirtual

Default-construct an associated record (protected implementation).

Reimplemented from lsst::afw::table::BaseTable.

Definition at line 164 of file Peak.cc.

                                                         {
    auto record = constructRecord<PeakRecord>();
    if (getIdFactory()) record->setId((*getIdFactory())());
    return record;
}

checkSchema()

static bool lsst::afw::detection::PeakTable::checkSchema ( afw::table::Schema const &  other )

inlinestatic

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

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

Definition at line 145 of file Peak.h.

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

clone()

std::shared_ptr<PeakTable> lsst::afw::detection::PeakTable::clone ( ) 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 173 of file Peak.h.

{ return std::static_pointer_cast<PeakTable>(_clone()); }

constructRecord()

template<typename RecordT , typename ... Args>

std::shared_ptr< RecordT > lsst::afw::table::BaseTable::constructRecord ( Args &&...  args )

protectedinherited

Helper function that must be used by all _makeRecord overrides to actually construct records.

Use of this function is enforced by the fact that Record::ConstructionToken can only be created by BaseTable, and is only ever constructed inside this method.

This function expects Record subclasses to have a constructor signature of the form

Record(ConstructionToken const &, detail::RecordData &&, Args && ...);

Definition at line 227 of file BaseRecord.h.

                                                                 {
    return std::make_shared<RecordT>(BaseRecord::ConstructionToken(0), _makeNewRecordData(),
                                     std::forward<Args>(args)...);
}

copyRecord() [1/2]

std::shared_ptr<PeakRecord> lsst::afw::detection::PeakTable::copyRecord ( afw::table::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 179 of file Peak.h.

                                                                          {
        return std::static_pointer_cast<PeakRecord>(afw::table::BaseTable::copyRecord(other));
    }

copyRecord() [2/2]

std::shared_ptr<PeakRecord> lsst::afw::detection::PeakTable::copyRecord ( afw::table::BaseRecord const &  other, afw::table::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 184 of file Peak.h.

                                                                               {
        return std::static_pointer_cast<PeakRecord>(afw::table::BaseTable::copyRecord(other, mapper));
    }

getBufferSize()

std::size_t lsst::afw::table::BaseTable::getBufferSize ( ) const

inherited

Return the number of additional records space has been already been allocated for.

Unlike std::vector::capacity, this does not factor in existing records in any way.

Definition at line 112 of file BaseTable.cc.

                                         {
    if (_manager) {
        return Block::getBufferSize(_schema.getRecordSize(), _manager);
    } else {
        return 0;
    }
}

getFxKey()

static afw::table::Key<float> lsst::afw::detection::PeakTable::getFxKey ( )

inlinestatic

Definition at line 167 of file Peak.h.

{ return getMinimalSchema().fx; }

getFyKey()

static afw::table::Key<float> lsst::afw::detection::PeakTable::getFyKey ( )

inlinestatic

Definition at line 168 of file Peak.h.

{ return getMinimalSchema().fy; }

getIdFactory() [1/2]

std::shared_ptr<afw::table::IdFactory> lsst::afw::detection::PeakTable::getIdFactory ( )

inline

Return the object that generates IDs for the table (may be null).

Definition at line 150 of file Peak.h.

{ return _idFactory; }

getIdFactory() [2/2]

std::shared_ptr<afw::table::IdFactory const> lsst::afw::detection::PeakTable::getIdFactory ( ) const

inline

Return the object that generates IDs for the table (may be null).

Definition at line 153 of file Peak.h.

{ return _idFactory; }

getIdKey()

static afw::table::Key<afw::table::RecordId> lsst::afw::detection::PeakTable::getIdKey ( )

inlinestatic

Get keys for standard fields shared by all peaks.

These keys are used to implement getters and setters on PeakRecord.

Definition at line 164 of file Peak.h.

{ return getMinimalSchema().id; }

getIxKey()

static afw::table::Key<int> lsst::afw::detection::PeakTable::getIxKey ( )

inlinestatic

Definition at line 165 of file Peak.h.

{ return getMinimalSchema().ix; }

getIyKey()

static afw::table::Key<int> lsst::afw::detection::PeakTable::getIyKey ( )

inlinestatic

Definition at line 166 of file Peak.h.

{ return getMinimalSchema().iy; }

getMetadata()

std::shared_ptr<daf::base::PropertyList> lsst::afw::table::BaseTable::getMetadata ( ) const

inlineinherited

Return the flexible metadata associated with the table. May be null.

Definition at line 79 of file BaseTable.h.

{ return _metadata; }

getPeakValueKey()

static afw::table::Key<float> lsst::afw::detection::PeakTable::getPeakValueKey ( )

inlinestatic

Definition at line 169 of file Peak.h.

{ return getMinimalSchema().peakValue; }

getSchema()

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

inlineinherited

Return the table's schema.

Definition at line 137 of file BaseTable.h.

{ return _schema; }

handleAliasChange()

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

inlineprotectedvirtualinherited

Reimplemented in lsst::afw::table::SourceTable.

Definition at line 208 of file BaseTable.h.

{}

make() [1/2]

std::shared_ptr< PeakTable > lsst::afw::detection::PeakTable::make ( afw::table::Schema const &  schema, bool  forceNew = false  )

static

Obtain a table that can be used to create records with given schema.

Parameters

[in]	schema	Schema that defines the fields, offsets, and record size for the table.
[in]	forceNew	If true, guarantee that the returned PeakTable will be a new one, rather than attempting to reuse an existing PeakTable with the same Schema.

If a PeakTable already exists that uses this Schema, that PeakTable will be returned instead of creating a new one. This is different from how most Record/Table classes work, but it is an important memory optimization for Peaks, for which we expect to have very few distinct Schemas as well as many catalogs (one per Footprint) with a small number of Peaks; we don't want to have a different PeakTable for each one of those catalogs if they all share the same Schema. This behavior can be disabled by setting forceNewTable=true or by cloning an existing table (in both of these cases, the new table will not be reused in the future, either)

Definition at line 96 of file Peak.cc.

                                                                                         {
    using CachedTableList = std::list<std::weak_ptr<PeakTable>>;
    static CachedTableList cache;
    if (!checkSchema(schema)) {
        throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
                          "Schema for Peak must contain at least the keys defined by makeMinimalSchema().");
    }
    if (forceNewTable) {
        return std::shared_ptr<PeakTable>(new PeakTable(schema, afw::table::IdFactory::makeSimple()));
    }
    CachedTableList::iterator iter = cache.begin();
    while (iter != cache.end()) {
        std::shared_ptr<PeakTable> p = iter->lock();
        if (!p) {
            iter = cache.erase(iter);
        } else {
            if (p->getSchema().compare(schema, afw::table::Schema::IDENTICAL) ==
                afw::table::Schema::IDENTICAL) {
                // Move the one we found to the front of the list, so it's easier to find
                // the same thing repeatedly
                if (iter != cache.begin()) {
                    cache.splice(cache.begin(), cache, iter);
                }
                return p;
            }
            ++iter;
        }
    }
    // No match: we create a new table and put it in the cache
    std::shared_ptr<PeakTable> newTable(new PeakTable(schema, afw::table::IdFactory::makeSimple()));
    cache.push_front(newTable);
    return newTable;
}

make() [2/2]

std::shared_ptr< BaseTable > lsst::afw::table::BaseTable::make ( Schema const &  schema )

staticinherited

Construct a new table.

Because BaseTable is an abstract class, this actually returns a hidden trivial subclass (which is associated with a hidden trivial subclass of BaseRecord).

Hiding concrete table and record classes in anonymous namespaces is not required, but it makes it easier to ensure instances are always created within shared_ptrs, and it eliminates some multilateral friending that would otherwise be necessary. In some cases it may also serve as a form of pimpl, keeping class implementation details out of header files.

Definition at line 120 of file BaseTable.cc.

                                                             {
    return std::shared_ptr<BaseTable>(new BaseTable(schema));
}

makeMinimalSchema()

static afw::table::Schema lsst::afw::detection::PeakTable::makeMinimalSchema ( )

inlinestatic

Return a minimal schema for Peak tables and records.

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

Definition at line 137 of file Peak.h.

{ return getMinimalSchema().schema; }

makeRecord()

std::shared_ptr<PeakRecord> lsst::afw::detection::PeakTable::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 176 of file Peak.h.

{ return std::static_pointer_cast<PeakRecord>(_makeRecord()); }

operator=() [1/2]

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

delete

operator=() [2/2]

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

delete

popMetadata()

std::shared_ptr<daf::base::PropertyList> lsst::afw::table::BaseTable::popMetadata ( )

inlineinherited

Return the metadata and set the internal metadata to a null pointer.

Definition at line 85 of file BaseTable.h.

                                                     {
        std::shared_ptr<daf::base::PropertyList> tmp;
        _metadata.swap(tmp);
        return tmp;
    }

preallocate()

void lsst::afw::table::BaseTable::preallocate ( std::size_t  nRecords )

inherited

Allocate contiguous space for new records in advance.

If a contiguous memory block for at least n additional records has already been allocated, this is a no-op. If not, a new block will be allocated, and any remaining space on the old block will go to waste; this ensures the new records will be allocated contiguously. Note that "wasted" memory is not leaked; it will be deallocated along with any records created from that block when those records go out of scope.

Note that unlike std::vector::reserve, this does not factor in existing records in any way; nRecords refers to a number of new records to reserve space for.

Definition at line 110 of file BaseTable.cc.

{ Block::preallocate(_schema.getRecordSize(), n, _manager); }

setIdFactory()

void lsst::afw::detection::PeakTable::setIdFactory ( std::shared_ptr< afw::table::IdFactory >  f )

inline

Switch to a new IdFactory – object that generates IDs for the table (may be null).

Definition at line 156 of file Peak.h.

{ _idFactory = f; }

setMetadata()

void lsst::afw::table::BaseTable::setMetadata ( std::shared_ptr< daf::base::PropertyList > const &  metadata )

inlineinherited

Set the flexible metadata associated with the table. May be null.

Definition at line 82 of file BaseTable.h.

{ _metadata = metadata; }

Friends And Related Function Documentation

afw::table::io::FitsWriter

friend class afw::table::io::FitsWriter

friend

Definition at line 216 of file Peak.h.

Member Data Documentation

nRecordsPerBlock

int lsst::afw::table::BaseTable::nRecordsPerBlock = 100

staticinherited

Number of records in each memory block.

Definition at line 76 of file BaseTable.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/include/lsst/afw/detection/Peak.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/src/detection/Peak.cc