LSST Applications
21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
|
Table class that contains measurements made on a single exposure. More...
#include <Source.h>
Public Types | |
using | Record = SourceRecord |
using | ColumnView = SourceColumnViewT< SourceRecord > |
using | Catalog = SortedCatalogT< Record > |
using | ConstCatalog = SortedCatalogT< const Record > |
Public Member Functions | |
std::shared_ptr< SourceTable > | clone () const |
Return a polymorphic deep copy of the table. More... | |
std::shared_ptr< SourceRecord > | makeRecord () |
Default-construct an associated record. More... | |
std::shared_ptr< SourceRecord > | copyRecord (BaseRecord const &other) |
Deep-copy a record, requiring that it have the same schema as this table. More... | |
std::shared_ptr< SourceRecord > | copyRecord (BaseRecord const &other, SchemaMapper const &mapper) |
Deep-copy a record, requiring that it have the same schema as this table. More... | |
FluxSlotDefinition const & | getPsfFluxSlot () const |
void | definePsfFlux (std::string const &name) |
Set the measurement used for the PsfFlux slot. More... | |
FluxSlotDefinition const & | getModelFluxSlot () const |
void | defineModelFlux (std::string const &name) |
Set the measurement used for the ModelFlux slot. More... | |
FluxSlotDefinition const & | getApFluxSlot () const |
void | defineApFlux (std::string const &name) |
Set the measurement used for the ApFlux slot. More... | |
FluxSlotDefinition const & | getGaussianFluxSlot () const |
void | defineGaussianFlux (std::string const &name) |
Set the measurement used for the GaussianFlux slot. More... | |
FluxSlotDefinition const & | getCalibFluxSlot () const |
void | defineCalibFlux (std::string const &name) |
Set the measurement used for the CalibFlux slot. More... | |
CentroidSlotDefinition const & | getCentroidSlot () const |
void | defineCentroid (std::string const &name) |
Set the measurement used for the Centroid slot. More... | |
ShapeSlotDefinition const & | getShapeSlot () const |
void | defineShape (std::string const &name) |
Set the measurement used for the Shape slot. More... | |
SourceTable & | operator= (SourceTable const &)=delete |
SourceTable & | operator= (SourceTable &&)=delete |
std::shared_ptr< IdFactory > | getIdFactory () |
Return the object that generates IDs for the table (may be null). More... | |
std::shared_ptr< IdFactory const > | getIdFactory () const |
Return the object that generates IDs for the table (may be null). More... | |
void | setIdFactory (std::shared_ptr< IdFactory > f) |
Switch to a new IdFactory – object that generates IDs for the table (may be null). 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< SourceTable > | make (Schema const &schema, std::shared_ptr< IdFactory > const &idFactory) |
Construct a new table. More... | |
static std::shared_ptr< SourceTable > | make (Schema const &schema) |
Construct a new table. More... | |
static Schema | makeMinimalSchema () |
Return a minimal schema for Source tables and records. More... | |
static bool | checkSchema (Schema const &other) |
Return true if the given schema is a valid SourceTable schema. More... | |
static Key< RecordId > | getParentKey () |
Key for the parent ID. More... | |
static Key< RecordId > | getIdKey () |
Get keys for standard fields shared by all references. More... | |
static CoordKey | getCoordKey () |
Key for the celestial coordinates. More... | |
Static Public Attributes | |
static int | nRecordsPerBlock = 100 |
Number of records in each memory block. More... | |
Protected Member Functions | |
SourceTable (Schema const &schema, std::shared_ptr< IdFactory > const &idFactory) | |
SourceTable (SourceTable const &other) | |
SourceTable (SourceTable &&other) | |
void | handleAliasChange (std::string const &alias) override |
std::shared_ptr< BaseTable > | _clone () const override |
Clone implementation with noncovariant return types. More... | |
std::shared_ptr< 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... | |
Friends | |
class | io::FitsWriter |
class | SourceRecord |
Table class that contains measurements made on a single exposure.
using lsst::afw::table::SourceTable::ConstCatalog = SortedCatalogT<const Record> |
|
protected |
Definition at line 391 of file Source.cc.
|
protecteddefault |
|
protected |
Definition at line 396 of file Source.cc.
|
overrideprotectedvirtual |
Clone implementation with noncovariant return types.
Reimplemented from lsst::afw::table::SimpleTable.
|
overrideprotectedvirtual |
Default-construct an associated record (protected implementation).
Reimplemented from lsst::afw::table::SimpleTable.
Definition at line 423 of file Source.cc.
|
inlinestatic |
Return true if the given schema is a valid SourceTable schema.
This will always be true if the given schema was originally constructed using makeMinimalSchema(), and will rarely be true otherwise.
Definition at line 270 of file Source.h.
|
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 276 of file Source.h.
|
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.
|
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 284 of file Source.h.
|
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 289 of file Source.h.
|
inline |
Set the measurement used for the ApFlux slot.
The definitions for slots are actually managed by the Schema object, and its associated AliasMap, so this simply sets the "slot_ApFlux" alias to point to the given field name prefix. See FluxSlotDefinition for more information.
Definition at line 328 of file Source.h.
|
inline |
Set the measurement used for the CalibFlux slot.
The definitions for slots are actually managed by the Schema object, and its associated AliasMap, so this simply sets the "slot_CalibFlux" alias to point to the given field name prefix. See FluxSlotDefinition for more information.
Definition at line 354 of file Source.h.
|
inline |
Set the measurement used for the Centroid slot.
The definitions for slots are actually managed by the Schema object, and its associated AliasMap, so this simply sets the "slot_Centroid" alias to point to the given field name prefix. See CentroidSlotDefinition for more information.
Definition at line 367 of file Source.h.
|
inline |
Set the measurement used for the GaussianFlux slot.
The definitions for slots are actually managed by the Schema object, and its associated AliasMap, so this simply sets the "slot_GaussianFlux" alias to point to the given field name prefix. See FluxSlotDefinition for more information.
Definition at line 341 of file Source.h.
|
inline |
Set the measurement used for the ModelFlux slot.
The definitions for slots are actually managed by the Schema object, and its associated AliasMap, so this simply sets the "slot_ModelFlux" alias to point to the given field name prefix. See FluxSlotDefinition for more information.
Definition at line 315 of file Source.h.
|
inline |
Set the measurement used for the PsfFlux slot.
The definitions for slots are actually managed by the Schema object, and its associated AliasMap, so this simply sets the "slot_PsfFlux" alias to point to the given field name prefix. See FluxSlotDefinition for more information.
Definition at line 302 of file Source.h.
|
inline |
Set the measurement used for the Shape slot.
The definitions for slots are actually managed by the Schema object, and its associated AliasMap, so this simply sets the "slot_Shape" alias to point to the given field name prefix. See ShapeSlotDefinition for more information.
Definition at line 380 of file Source.h.
|
inline |
|
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.
|
inline |
|
inline |
|
inlinestaticinherited |
|
inline |
Definition at line 332 of file Source.h.
|
inlineinherited |
|
inlineinherited |
Get keys for standard fields shared by all references.
These keys are used to implement getters and setters on SimpleRecord. Key for the unique ID.
|
inlineinherited |
Return the flexible metadata associated with the table. May be null.
Definition at line 79 of file BaseTable.h.
|
inline |
|
inline |
|
inlineinherited |
|
inline |
|
overrideprotectedvirtual |
Reimplemented from lsst::afw::table::BaseTable.
Definition at line 398 of file Source.cc.
|
inlinestatic |
Construct a new table.
[in] | schema | Schema that defines the fields, offsets, and record size for the table. |
This overload sets the ID factory to IdFactory::makeSimple().
Definition at line 244 of file Source.h.
|
static |
Construct a new table.
[in] | schema | Schema that defines the fields, offsets, and record size for the table. |
[in] | idFactory | Factory class to generate record IDs when they are not explicitly given. If null, record IDs will default to zero. |
Note that not passing an IdFactory at all will call the other override of make(), which will set the ID factory to IdFactory::makeSimple().
Definition at line 382 of file Source.cc.
|
inlinestatic |
Return a minimal schema for Source tables and records.
The returned schema can and generally should be modified further, but many operations on sources will assume that at least the fields provided by this routine are present.
Keys for the standard fields added by this routine can be obtained from other static member functions of the SourceTable class.
|
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 279 of file Source.h.
|
delete |
|
delete |
|
inlineinherited |
Return the metadata and set the internal metadata to a null pointer.
Definition at line 85 of file BaseTable.h.
|
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.
|
inlineinherited |
|
inlineinherited |
Set the flexible metadata associated with the table. May be null.
Definition at line 82 of file BaseTable.h.
|
friend |
|
friend |
|
staticinherited |
Number of records in each memory block.
Definition at line 76 of file BaseTable.h.