LSSTApplications  10.0-2-g4f67435,11.0.rc2+1,11.0.rc2+12,11.0.rc2+3,11.0.rc2+4,11.0.rc2+5,11.0.rc2+6,11.0.rc2+7,11.0.rc2+8
LSSTDataManagementBasePackage
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Static 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 lsst::daf::base::Citizen

Classes

struct  MinimalSchema
 

Public Types

typedef ExposureRecord Record
 
typedef ColumnViewT
< ExposureRecord
ColumnView
 
typedef ExposureCatalogT< RecordCatalog
 
typedef ExposureCatalogT
< Record const > 
ConstCatalog
 
- Public Types inherited from lsst.afw.table::BaseTable
typedef BaseRecord Record
 The associated record class. More...
 
typedef BaseColumnView ColumnView
 The associated ColumnView class. More...
 
typedef CatalogT< RecordCatalog
 Template of CatalogT used to hold records of the associated type. More...
 
typedef CatalogT< Record const > ConstCatalog
 Template of CatalogT used to hold const records of the associated 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< ExposureTableclone () const
 Return a polymorphic deep copy of the table. More...
 
boost::shared_ptr< ExposureRecordmakeRecord ()
 Default-construct an associated record. More...
 
boost::shared_ptr< ExposureRecordcopyRecord (BaseRecord const &other)
 Deep-copy a record, requiring that it have the same schema as this table. More...
 
boost::shared_ptr< ExposureRecordcopyRecord (BaseRecord const &other, SchemaMapper const &mapper)
 Deep-copy a record, requiring that it have the same schema as this table. More...
 
- Public Member Functions inherited from lsst.afw.table::BaseTable
boost::shared_ptr
< daf::base::PropertyList
getMetadata () const
 Return the flexible metadata associated with the table. May be null. More...
 
void setMetadata (boost::shared_ptr< daf::base::PropertyList > const &metadata)
 Set the flexible metadata associated with the table. May be null. More...
 
boost::shared_ptr
< daf::base::PropertyList
popMetadata ()
 Return the metadata and set the internal metadata to a null pointer. More...
 
boost::shared_ptr< BaseTableclone () const
 Return a polymorphic deep copy of the table. More...
 
boost::shared_ptr< BaseRecordmakeRecord ()
 Default-construct an associated record. More...
 
boost::shared_ptr< BaseRecordcopyRecord (BaseRecord const &input)
 Deep-copy a record, requiring that it have the same schema as this table. More...
 
boost::shared_ptr< BaseRecordcopyRecord (BaseRecord const &input, SchemaMapper const &mapper)
 Deep-copy a record, using a mapper to relate two schemas. 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...
 
virtual ~BaseTable ()
 
- Public Member Functions inherited from lsst::daf::base::Citizen
 Citizen (const std::type_info &)
 
 Citizen (Citizen const &)
 
 ~Citizen ()
 
Citizenoperator= (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...
 

Static Public Member Functions

static boost::shared_ptr
< ExposureTable
make (Schema const &schema)
 Construct a new table. More...
 
static Schema makeMinimalSchema ()
 Return a minimal schema for Exposure tables and records. More...
 
static bool checkSchema (Schema const &other)
 Return true if the given schema is a valid ExposureTable schema. More...
 
static Key< RecordIdgetIdKey ()
 Key for the unique ID. More...
 
static PointKey< int > getBBoxMinKey ()
 Key for the minimum point of the bbox. More...
 
static PointKey< int > getBBoxMaxKey ()
 Key for the maximum point of the bbox. More...
 
- Static Public Member Functions inherited from lsst.afw.table::BaseTable
static boost::shared_ptr
< BaseTable
make (Schema const &schema)
 Construct a new table. More...
 
- 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...
 

Protected Member Functions

 ExposureTable (Schema const &schema)
 
 ExposureTable (ExposureTable const &other)
 
- Protected Member Functions inherited from lsst.afw.table::BaseTable
template<typename Derived >
boost::shared_ptr< Derived > getSelf ()
 Convenience function for static-casting shared_from_this for use by derived classes. More...
 
template<typename Derived >
boost::shared_ptr< Derived const > getSelf () const
 Convenience function for static-casting shared_from_this for use by derived classes. More...
 
virtual void handleAliasChange (std::string const &alias)
 
virtual boost::shared_ptr
< BaseTable
_clone () const =0
 Clone implementation with noncovariant return types. More...
 
virtual boost::shared_ptr
< BaseRecord
_makeRecord ()=0
 Default-construct an associated record (protected implementation). More...
 
 BaseTable (Schema const &schema)
 Construct from a schema. More...
 
 BaseTable (BaseTable const &other)
 Copy construct. More...
 

Private Member Functions

virtual boost::shared_ptr
< io::FitsWriter
makeFitsWriter (fits::Fits *fitsfile, int flags) const
 
boost::shared_ptr< io::FitsWritermakeFitsWriter (fits::Fits *fitsfile, boost::shared_ptr< io::OutputArchive > archive, int flags) const
 

Static Private Member Functions

static MinimalSchemagetMinimalSchema ()
 

Friends

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

Additional Inherited Members

- Static Public Attributes inherited from lsst.afw.table::BaseTable
static int nRecordsPerBlock
 Number of records in each memory block. More...
 

Detailed Description

Table class used to store exposure metadata.

Definition at line 142 of file Exposure.h.

Member Typedef Documentation

Definition at line 147 of file Exposure.h.

Definition at line 146 of file Exposure.h.

Definition at line 148 of file Exposure.h.

Definition at line 145 of file Exposure.h.

Constructor & Destructor Documentation

lsst.afw.table::ExposureTable::ExposureTable ( Schema const &  schema)
protected
lsst.afw.table::ExposureTable::ExposureTable ( ExposureTable const &  other)
protected

Member Function Documentation

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 176 of file Exposure.h.

176  {
177  return other.contains(getMinimalSchema().schema);
178  }
tbl::Schema schema
static MinimalSchema & getMinimalSchema()
boost::shared_ptr< ExposureTable > lsst.afw.table::ExposureTable::clone ( void  ) 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 195 of file Exposure.h.

195 { return boost::static_pointer_cast<ExposureTable>(_clone()); }
virtual boost::shared_ptr< BaseTable > _clone() const =0
Clone implementation with noncovariant return types.
ExposureTable(Schema const &schema)
boost::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 201 of file Exposure.h.

201  {
202  return boost::static_pointer_cast<ExposureRecord>(BaseTable::copyRecord(other));
203  }
boost::shared_ptr< BaseRecord > copyRecord(BaseRecord const &input)
Deep-copy a record, requiring that it have the same schema as this table.
boost::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 206 of file Exposure.h.

206  {
207  return boost::static_pointer_cast<ExposureRecord>(BaseTable::copyRecord(other, mapper));
208  }
boost::shared_ptr< BaseRecord > copyRecord(BaseRecord const &input)
Deep-copy a record, requiring that it have the same schema as this table.
static PointKey<int> lsst.afw.table::ExposureTable::getBBoxMaxKey ( )
inlinestatic

Key for the maximum point of the bbox.

Definition at line 191 of file Exposure.h.

191 { return getMinimalSchema().bboxMax; }
static MinimalSchema & getMinimalSchema()
static PointKey<int> lsst.afw.table::ExposureTable::getBBoxMinKey ( )
inlinestatic

Key for the minimum point of the bbox.

Definition at line 189 of file Exposure.h.

189 { return getMinimalSchema().bboxMin; }
static MinimalSchema & getMinimalSchema()
static Key<RecordId> lsst.afw.table::ExposureTable::getIdKey ( )
inlinestatic

Key for the unique ID.

Get keys for standard fields shared by all references.

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

Definition at line 187 of file Exposure.h.

187 { return getMinimalSchema().id; }
static MinimalSchema & getMinimalSchema()
static MinimalSchema& lsst.afw.table::ExposureTable::getMinimalSchema ( )
staticprivate
static boost::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.
virtual boost::shared_ptr< io::FitsWriter > lsst.afw.table::ExposureTable::makeFitsWriter ( fits::Fits fitsfile,
int  flags 
) const
privatevirtual

Reimplemented from lsst.afw.table::BaseTable.

boost::shared_ptr< io::FitsWriter > lsst.afw.table::ExposureTable::makeFitsWriter ( fits::Fits fitsfile,
boost::shared_ptr< io::OutputArchive archive,
int  flags 
) const
private
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 164 of file Exposure.h.

164  {
165  Schema r = getMinimalSchema().schema;
166  r.disconnectAliases();
167  return r;
168  }
void disconnectAliases()
Sever the connection between this schema and any others with which it shares aliases.
static MinimalSchema & getMinimalSchema()
boost::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 198 of file Exposure.h.

198 { return boost::static_pointer_cast<ExposureRecord>(_makeRecord()); }
virtual boost::shared_ptr< BaseRecord > _makeRecord()=0
Default-construct an associated record (protected implementation).

Friends And Related Function Documentation

template<typename RecordT >
friend class ExposureCatalogT
friend

Definition at line 233 of file Exposure.h.

friend class io::FitsWriter
friend

Definition at line 231 of file Exposure.h.


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