LSST Applications g1cfbe01172+01aa18f939,g20cdd03214+31e6b93548,g28da252d5a+ea8665a95b,g2bbee38e9b+9ec6cc348d,g2bc492864f+9ec6cc348d,g347aa1857d+9ec6cc348d,g3a166c0a6a+9ec6cc348d,g4322eb9e3a+65eff1e020,g461a3dce89+b86e4b8053,g50ff169b8f+f991eae79d,g52b1c1532d+b86e4b8053,g607f77f49a+31e6b93548,g78056777b3+8ae2798781,g858d7b2824+31e6b93548,g8cd86fa7b1+4851e61ca4,g9ddcbc5298+f24b38b85a,ga1e77700b3+3309dba821,gae0086650b+b86e4b8053,gb0e22166c9+6076c0b52b,gbb886bcc26+dccb771098,gbd462c55f0+dc07f8e65d,gc0c51c7ec2+31e6b93548,gc120e1dc64+a417ce3171,gc28159a63d+9ec6cc348d,gc2a6998b7e+f95f64aeae,gcdd4ae20e8+507450c4cd,gcf0d15dbbd+507450c4cd,gd1535ee943+bcf88ba65f,gd598c5cd71+66126f91fb,gdaeeff99f8+006e14e809,gdbce86181e+39d5515b1a,ge3d4d395c2+b12d4d6a95,ge79ae78c31+9ec6cc348d,gf048a9a2f4+d9c36e6b63,gfbcc870c63+ea41c4420b,w.2024.27
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Friends | List of all members
lsst::afw::table::ExposureTable Class Reference

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

#include <Exposure.h>

Inheritance diagram for lsst::afw::table::ExposureTable:
lsst::afw::table::BaseTable std::enable_shared_from_this< BaseTable >

Public Types

using Record = ExposureRecord
 
using ColumnView = ColumnViewT<ExposureRecord>
 
using Catalog = ExposureCatalogT<Record>
 
using ConstCatalog = ExposureCatalogT<const Record>
 

Public Member Functions

std::shared_ptr< ExposureTableclone () const
 Return a polymorphic deep copy of the table.
 
std::shared_ptr< ExposureRecordmakeRecord ()
 Default-construct an associated record.
 
std::shared_ptr< ExposureRecordcopyRecord (BaseRecord const &other)
 Deep-copy a record, requiring that it have the same schema as this table.
 
std::shared_ptr< ExposureRecordcopyRecord (BaseRecord const &other, SchemaMapper const &mapper)
 Deep-copy a record, requiring that it have the same schema as this table.
 
ExposureTableoperator= (ExposureTable const &)=delete
 
ExposureTableoperator= (ExposureTable &&)=delete
 
 ~ExposureTable () override
 
std::shared_ptr< daf::base::PropertyListgetMetadata () const
 Return the flexible metadata associated with the table. May be null.
 
void setMetadata (std::shared_ptr< daf::base::PropertyList > const &metadata)
 Set the flexible metadata associated with the table. May be null.
 
std::shared_ptr< daf::base::PropertyListpopMetadata ()
 Return the metadata and set the internal metadata to a null pointer.
 
Schema getSchema () const
 Return the table's schema.
 
void preallocate (std::size_t nRecords)
 Allocate contiguous space for new records in advance.
 
std::size_t getBufferSize () const
 Return the number of additional records space has been already been allocated for.
 
shared_from_this (T... args)
 

Static Public Member Functions

static std::shared_ptr< ExposureTablemake (Schema const &schema)
 Construct a new table.
 
static Schema makeMinimalSchema ()
 Return a minimal schema for Exposure tables and records.
 
static bool checkSchema (Schema const &other)
 Return true if the given schema is a valid ExposureTable schema.
 
static Key< RecordIdgetIdKey ()
 Get keys for standard fields shared by all references.
 
static PointKey< int > getBBoxMinKey ()
 Key for the minimum point of the bbox.
 
static PointKey< int > getBBoxMaxKey ()
 Key for the maximum point of the bbox.
 
static Box2IKey getBBoxKey ()
 Key for the full bbox.
 

Static Public Attributes

static int nRecordsPerBlock = 100
 Number of records in each memory block.
 

Protected Member Functions

 ExposureTable (Schema const &schema)
 
 ExposureTable (ExposureTable const &other)
 
 ExposureTable (ExposureTable &&other)
 
std::shared_ptr< BaseTable_clone () const override
 Clone implementation with noncovariant return types.
 
std::shared_ptr< BaseRecord_makeRecord () override
 Default-construct an associated record (protected implementation).
 
template<typename RecordT , typename... Args>
std::shared_ptr< RecordTconstructRecord (Args &&... args)
 Helper function that must be used by all _makeRecord overrides to actually construct records.
 
virtual void handleAliasChange (std::string const &alias)
 

Private Member Functions

std::shared_ptr< io::FitsWritermakeFitsWriter (fits::Fits *fitsfile, int flags) const override
 

Friends

class io::FitsWriter
 
template<typename RecordT >
class ExposureCatalogT
 

Detailed Description

Table class used to store exposure metadata.

Definition at line 195 of file Exposure.h.

Member Typedef Documentation

◆ Catalog

Definition at line 199 of file Exposure.h.

◆ ColumnView

Definition at line 198 of file Exposure.h.

◆ ConstCatalog

Definition at line 200 of file Exposure.h.

◆ Record

Definition at line 197 of file Exposure.h.

Constructor & Destructor Documentation

◆ ~ExposureTable()

lsst::afw::table::ExposureTable::~ExposureTable ( )
overridedefault

◆ ExposureTable() [1/3]

lsst::afw::table::ExposureTable::ExposureTable ( Schema const & schema)
explicitprotected

Definition at line 403 of file Exposure.cc.

403: BaseTable(schema) {}
BaseTable(Schema const &schema, std::shared_ptr< daf::base::PropertyList > metadata=nullptr)
Construct from a schema.
Definition BaseTable.cc:148

◆ ExposureTable() [2/3]

lsst::afw::table::ExposureTable::ExposureTable ( ExposureTable const & other)
protecteddefault

◆ ExposureTable() [3/3]

lsst::afw::table::ExposureTable::ExposureTable ( ExposureTable && other)
protected

Definition at line 407 of file Exposure.cc.

407: ExposureTable(other) {}
ExposureTable(Schema const &schema)
Definition Exposure.cc:403

Member Function Documentation

◆ _clone()

std::shared_ptr< BaseTable > lsst::afw::table::ExposureTable::_clone ( ) const
overrideprotectedvirtual

Clone implementation with noncovariant return types.

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

Definition at line 431 of file Exposure.cc.

431 {
433}

◆ _makeRecord()

std::shared_ptr< BaseRecord > lsst::afw::table::ExposureTable::_makeRecord ( )
overrideprotectedvirtual

Default-construct an associated record (protected implementation).

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

Definition at line 435 of file Exposure.cc.

435 {
436 return constructRecord<ExposureRecord>();
437}

◆ checkSchema()

static bool lsst::afw::table::ExposureTable::checkSchema ( Schema const & other)
inlinestatic

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

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

Definition at line 228 of file Exposure.h.

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

◆ clone()

std::shared_ptr< ExposureTable > lsst::afw::table::ExposureTable::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 247 of file Exposure.h.

247{ return std::static_pointer_cast<ExposureTable>(_clone()); }
std::shared_ptr< BaseTable > _clone() const override
Clone implementation with noncovariant return types.
Definition Exposure.cc:431

◆ 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.

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

◆ copyRecord() [1/2]

std::shared_ptr< ExposureRecord > lsst::afw::table::ExposureTable::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 255 of file Exposure.h.

255 {
256 return std::static_pointer_cast<ExposureRecord>(BaseTable::copyRecord(other));
257 }
std::shared_ptr< BaseRecord > copyRecord(BaseRecord const &input)
Deep-copy a record, requiring that it have the same schema as this table.
Definition BaseTable.cc:126

◆ copyRecord() [2/2]

std::shared_ptr< ExposureRecord > lsst::afw::table::ExposureTable::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 260 of file Exposure.h.

260 {
261 return std::static_pointer_cast<ExposureRecord>(BaseTable::copyRecord(other, mapper));
262 }
SchemaMapper * mapper

◆ getBBoxKey()

static Box2IKey lsst::afw::table::ExposureTable::getBBoxKey ( )
inlinestatic

Key for the full bbox.

Definition at line 243 of file Exposure.h.

243{ return getMinimalSchema().bbox; }

◆ getBBoxMaxKey()

static PointKey< int > lsst::afw::table::ExposureTable::getBBoxMaxKey ( )
inlinestatic

Key for the maximum point of the bbox.

Definition at line 241 of file Exposure.h.

241{ return getMinimalSchema().bbox.getMax(); }

◆ getBBoxMinKey()

static PointKey< int > lsst::afw::table::ExposureTable::getBBoxMinKey ( )
inlinestatic

Key for the minimum point of the bbox.

Definition at line 239 of file Exposure.h.

239{ return getMinimalSchema().bbox.getMin(); }

◆ 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.

112 {
113 if (_manager) {
114 return Block::getBufferSize(_schema.getRecordSize(), _manager);
115 } else {
116 return 0;
117 }
118}
std::size_t getRecordSize() const
Return the raw size of a record in bytes.
Definition Schema.h:149

◆ getIdKey()

static Key< RecordId > lsst::afw::table::ExposureTable::getIdKey ( )
inlinestatic

Get keys for standard fields shared by all references.

These keys are used to implement getters and setters on ExposureRecord. Key for the unique ID.

Definition at line 237 of file Exposure.h.

237{ return getMinimalSchema().id; }

◆ 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.

79{ return _metadata; }

◆ getSchema()

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

Return the table's schema.

Definition at line 137 of file BaseTable.h.

137{ return _schema; }

◆ handleAliasChange()

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

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

Definition at line 207 of file BaseTable.h.

207{}

◆ make()

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

Construct a new table.

Parameters
[in]schemaSchema that defines the fields, offsets, and record size for the table.

Definition at line 394 of file Exposure.cc.

394 {
395 if (!checkSchema(schema)) {
396 throw LSST_EXCEPT(
398 "Schema for Exposure must contain at least the keys defined by makeMinimalSchema().");
399 }
401}
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition Exception.h:48
static bool checkSchema(Schema const &other)
Return true if the given schema is a valid ExposureTable schema.
Definition Exposure.h:228
Reports invalid arguments.
Definition Runtime.h:66

◆ makeFitsWriter()

std::shared_ptr< io::FitsWriter > lsst::afw::table::ExposureTable::makeFitsWriter ( fits::Fits * fitsfile,
int flags ) const
overrideprivatevirtual

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

Definition at line 421 of file Exposure.cc.

421 {
422 return std::make_shared<ExposureFitsWriter>(fitsfile, std::shared_ptr<io::OutputArchive>(), flags);
423}

◆ makeMinimalSchema()

static Schema lsst::afw::table::ExposureTable::makeMinimalSchema ( )
inlinestatic

Return a minimal schema for Exposure tables and records.

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

Definition at line 216 of file Exposure.h.

216 {
217 Schema r = getMinimalSchema().schema;
218 r.disconnectAliases();
219 return r;
220 }

◆ makeRecord()

std::shared_ptr< ExposureRecord > lsst::afw::table::ExposureTable::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 250 of file Exposure.h.

250 {
251 return std::static_pointer_cast<ExposureRecord>(_makeRecord());
252 }
std::shared_ptr< BaseRecord > _makeRecord() override
Default-construct an associated record (protected implementation).
Definition Exposure.cc:435

◆ operator=() [1/2]

ExposureTable & lsst::afw::table::ExposureTable::operator= ( ExposureTable && )
delete

◆ operator=() [2/2]

ExposureTable & lsst::afw::table::ExposureTable::operator= ( ExposureTable 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.

85 {
87 _metadata.swap(tmp);
88 return tmp;
89 }

◆ 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.

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

◆ 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.

82{ _metadata = metadata; }

Friends And Related Symbol Documentation

◆ ExposureCatalogT

template<typename RecordT >
friend class ExposureCatalogT
friend

Definition at line 294 of file Exposure.h.

◆ io::FitsWriter

Definition at line 291 of file Exposure.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: