lsst.afw 23.0.0+60ce4897b0
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | List of all members
lsst::afw::cameraGeom::DetectorCollection Class Reference

An immutable collection of Detectors that can be accessed by name or ID. More...

#include <DetectorCollection.h>

Inheritance diagram for lsst::afw::cameraGeom::DetectorCollection:
lsst::afw::cameraGeom::DetectorCollectionBase< Detector const > lsst::afw::table::io::PersistableFacade< DetectorCollection > lsst::afw::table::io::Persistable lsst::afw::cameraGeom::Camera

Classes

class  Factory
 

Public Types

using NameMap = std::unordered_map< std::string, std::shared_ptr< Detector const > >
 
using IdMap = std::map< int, std::shared_ptr< Detector const > >
 
using List = std::vector< std::shared_ptr< Detector const > >
 

Public Member Functions

 DetectorCollection (List const &list)
 
virtual ~DetectorCollection () noexcept
 
lsst::geom::Box2D const & getFpBBox () const noexcept
 Return a focal plane bounding box that encompasses all detectors. More...
 
 DetectorCollection (DetectorCollection const &)=delete
 
 DetectorCollection (DetectorCollection &&)=delete
 
DetectorCollectionoperator= (DetectorCollection const &)=delete
 
DetectorCollectionoperator= (DetectorCollection &&)=delete
 
bool isPersistable () const noexcept override
 DetectorCollections are always persistable. More...
 
NameMap const & getNameMap () const noexcept
 Get a map keyed and ordered by name. More...
 
IdMap const & getIdMap () const noexcept
 Get a map keyed and ordered by ID. More...
 
std::size_t size () const noexcept
 Get the number of detectors. More...
 
bool empty () const noexcept
 Determine if the collection contains any detectors. More...
 
std::shared_ptr< Detector const > operator[] (std::string const &name) const
 Implement the [name] operator. More...
 
std::shared_ptr< Detector const > operator[] (int id) const
 Implement the [id] operator. More...
 
std::shared_ptr< Detector const > get (std::string const &name, std::shared_ptr< Detector const > def=nullptr) const
 Retrieve a detector by name, or fall back to a default. More...
 
std::shared_ptr< Detector const > get (int id, std::shared_ptr< Detector const > def=nullptr) const
 Retrieve a detector by ID, or fall back to a default. More...
 
void writeFits (std::string const &fileName, std::string const &mode="w") const
 Write the object to a regular FITS file. More...
 
void writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
 Write the object to a FITS image in memory. More...
 
void writeFits (fits::Fits &fitsfile) const
 Write the object to an already-open FITS object. More...
 

Static Public Member Functions

static std::shared_ptr< DetectorCollectionreadFits (fits::Fits &fitsfile)
 Read an object from an already open FITS object. More...
 
static std::shared_ptr< DetectorCollectionreadFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 Read an object from a regular FITS file. More...
 
static std::shared_ptr< DetectorCollectionreadFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 Read an object from a FITS file in memory. More...
 
static std::shared_ptr< DetectorCollectiondynamicCast (std::shared_ptr< Persistable > const &ptr)
 Dynamically cast a shared_ptr. More...
 

Protected Types

using OutputArchiveHandle = io::OutputArchiveHandle
 

Protected Member Functions

 DetectorCollection (table::io::InputArchive const &archive, table::io::CatalogVector const &catalogs)
 
std::string getPersistenceName () const override
 Return the unique name used to persist this object and look up its factory. More...
 
std::string getPythonModule () const override
 Return the fully-qualified Python module that should be imported to guarantee that its factory is registered. More...
 
void write (OutputArchiveHandle &handle) const override
 Write the object to one or more catalogs. More...
 
void add (std::shared_ptr< Detector const > detector)
 Add a detector to the collection. More...
 
void remove (std::string const &name)
 
void remove (int id)
 

Detailed Description

An immutable collection of Detectors that can be accessed by name or ID.

Definition at line 149 of file DetectorCollection.h.

Member Typedef Documentation

◆ IdMap

Definition at line 53 of file DetectorCollection.h.

◆ List

Definition at line 54 of file DetectorCollection.h.

◆ NameMap

Definition at line 52 of file DetectorCollection.h.

◆ OutputArchiveHandle

using lsst::afw::table::io::Persistable::OutputArchiveHandle = io::OutputArchiveHandle
protectedinherited

Definition at line 108 of file Persistable.h.

Constructor & Destructor Documentation

◆ DetectorCollection() [1/4]

lsst::afw::cameraGeom::DetectorCollection::DetectorCollection ( List const &  list)

Definition at line 207 of file DetectorCollection.cc.

◆ ~DetectorCollection()

lsst::afw::cameraGeom::DetectorCollection::~DetectorCollection ( )
virtualdefaultnoexcept

◆ DetectorCollection() [2/4]

lsst::afw::cameraGeom::DetectorCollection::DetectorCollection ( DetectorCollection const &  )
delete

◆ DetectorCollection() [3/4]

lsst::afw::cameraGeom::DetectorCollection::DetectorCollection ( DetectorCollection &&  )
delete

◆ DetectorCollection() [4/4]

lsst::afw::cameraGeom::DetectorCollection::DetectorCollection ( table::io::InputArchive const &  archive,
table::io::CatalogVector const &  catalogs 
)
protected

Definition at line 234 of file DetectorCollection.cc.

Member Function Documentation

◆ add()

void lsst::afw::cameraGeom::DetectorCollectionBase< Detector const >::add ( std::shared_ptr< Detector const >  detector)
protectedinherited

Add a detector to the collection.

Parameters
[in]detectorNew detector to add to the collection.
Exceptions
pex::exceptions::RuntimeErrorThrown if the ID and/or name conflict with those of detectors already in the collection.
Exception Safety
Strong for pex::exceptions::RuntimeError, weak (collection is made empty) otherwise.

Definition at line 135 of file DetectorCollection.cc.

◆ dynamicCast()

Dynamically cast a shared_ptr.

Dynamically cast a shared pointer and raise on failure.

You must provide an explicit template instantiation in the .cc file for each class that inherits from PersistableFacade. Designed to work around RTTI issues on macOS with hidden symbols;

Exceptions
lsst::pex::exceptions::LogicErrorif the cast fails

param[in] ptr The pointer to be cast.

Returns
The cast pointer.
Exceptions
lsst::pex::exceptions::TypeErrorIf the dynamic cast fails.

Definition at line 218 of file Persistable.cc.

◆ empty()

bool lsst::afw::cameraGeom::DetectorCollectionBase< Detector const >::empty ( ) const
inlinenoexceptinherited

Determine if the collection contains any detectors.

Definition at line 72 of file DetectorCollection.h.

◆ get() [1/2]

std::shared_ptr< Detector const > lsst::afw::cameraGeom::DetectorCollectionBase< Detector const >::get ( int  id,
std::shared_ptr< Detector const >  def = nullptr 
) const
inherited

Retrieve a detector by ID, or fall back to a default.

Parameters
[in]iddetector id
[in]defdefault detector to return. This defaults to nullptr.
Returns
pointer to detector entry if the entry exists, else return the default value

Definition at line 110 of file DetectorCollection.cc.

◆ get() [2/2]

std::shared_ptr< Detector const > lsst::afw::cameraGeom::DetectorCollectionBase< Detector const >::get ( std::string const &  name,
std::shared_ptr< Detector const >  def = nullptr 
) const
inherited

Retrieve a detector by name, or fall back to a default.

Parameters
[in]namedetector name
[in]defdefault detector to return. This defaults to nullptr.
Returns
pointer to detector entry if the entry exists, else return the default value

Definition at line 99 of file DetectorCollection.cc.

◆ getFpBBox()

lsst::geom::Box2D const & lsst::afw::cameraGeom::DetectorCollection::getFpBBox ( ) const
inlinenoexcept

Return a focal plane bounding box that encompasses all detectors.

Definition at line 159 of file DetectorCollection.h.

◆ getIdMap()

IdMap const & lsst::afw::cameraGeom::DetectorCollectionBase< Detector const >::getIdMap ( ) const
inlinenoexceptinherited

Get a map keyed and ordered by ID.

Definition at line 62 of file DetectorCollection.h.

◆ getNameMap()

NameMap const & lsst::afw::cameraGeom::DetectorCollectionBase< Detector const >::getNameMap ( ) const
inlinenoexceptinherited

Get a map keyed and ordered by name.

Definition at line 59 of file DetectorCollection.h.

◆ getPersistenceName()

std::string lsst::afw::cameraGeom::DetectorCollection::getPersistenceName ( ) const
overrideprotectedvirtual

Return the unique name used to persist this object and look up its factory.

Must be less than ArchiveIndexSchema::MAX_NAME_LENGTH characters.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 242 of file DetectorCollection.cc.

◆ getPythonModule()

std::string lsst::afw::cameraGeom::DetectorCollection::getPythonModule ( ) const
overrideprotectedvirtual

Return the fully-qualified Python module that should be imported to guarantee that its factory is registered.

Must be less than ArchiveIndexSchema::MAX_MODULE_LENGTH characters.

Will be ignored if empty.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 246 of file DetectorCollection.cc.

◆ isPersistable()

bool lsst::afw::cameraGeom::DetectorCollection::isPersistable ( ) const
inlineoverridevirtualnoexcept

DetectorCollections are always persistable.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 171 of file DetectorCollection.h.

◆ operator=() [1/2]

DetectorCollection & lsst::afw::cameraGeom::DetectorCollection::operator= ( DetectorCollection &&  )
delete

◆ operator=() [2/2]

DetectorCollection & lsst::afw::cameraGeom::DetectorCollection::operator= ( DetectorCollection const &  )
delete

◆ operator[]() [1/2]

std::shared_ptr< Detector const > lsst::afw::cameraGeom::DetectorCollectionBase< Detector const >::operator[] ( int  id) const
inherited

Implement the [id] operator.

Parameters
[in]iddetector name
Returns
pointer to detector entry

Definition at line 88 of file DetectorCollection.cc.

◆ operator[]() [2/2]

std::shared_ptr< Detector const > lsst::afw::cameraGeom::DetectorCollectionBase< Detector const >::operator[] ( std::string const &  name) const
inherited

Implement the [name] operator.

Parameters
[in]namedetector name
Returns
pointer to detector entry

Definition at line 80 of file DetectorCollection.cc.

◆ readFits() [1/3]

static std::shared_ptr< DetectorCollection > lsst::afw::table::io::PersistableFacade< DetectorCollection >::readFits ( fits::Fits fitsfile)
inlinestaticinherited

Read an object from an already open FITS object.

Parameters
[in]fitsfileFITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

◆ readFits() [2/3]

static std::shared_ptr< DetectorCollection > lsst::afw::table::io::PersistableFacade< DetectorCollection >::readFits ( fits::MemFileManager manager,
int  hdu = fits::DEFAULT_HDU 
)
inlinestaticinherited

Read an object from a FITS file in memory.

Parameters
[in]managerManager for the memory to read from.
[in]hduHDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 205 of file Persistable.h.

◆ readFits() [3/3]

static std::shared_ptr< DetectorCollection > lsst::afw::table::io::PersistableFacade< DetectorCollection >::readFits ( std::string const &  fileName,
int  hdu = fits::DEFAULT_HDU 
)
inlinestaticinherited

Read an object from a regular FITS file.

Parameters
[in]fileNameName of the file to read.
[in]hduHDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 194 of file Persistable.h.

◆ remove() [1/2]

void lsst::afw::cameraGeom::DetectorCollectionBase< Detector const >::remove ( int  id)
protectedinherited

Definition at line 138 of file DetectorCollection.cc.

◆ remove() [2/2]

void lsst::afw::cameraGeom::DetectorCollectionBase< Detector const >::remove ( std::string const &  name)
protectedinherited

Definition at line 137 of file DetectorCollection.cc.

◆ size()

std::size_t lsst::afw::cameraGeom::DetectorCollectionBase< Detector const >::size ( ) const
inlinenoexceptinherited

Get the number of detectors.

Renamed to __len__ in Python.

Definition at line 67 of file DetectorCollection.h.

◆ write()

void lsst::afw::cameraGeom::DetectorCollection::write ( OutputArchiveHandle handle) const
overrideprotectedvirtual

Write the object to one or more catalogs.

The handle object passed to this function provides an interface for adding new catalogs and adding nested objects to the same archive (while checking for duplicates). See OutputArchiveHandle for more information.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 250 of file DetectorCollection.cc.

◆ writeFits() [1/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::Fits fitsfile) const
inherited

Write the object to an already-open FITS object.

Parameters
[in]fitsfileOpen FITS object to write to.

Definition at line 18 of file Persistable.cc.

◆ writeFits() [2/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::MemFileManager manager,
std::string const &  mode = "w" 
) const
inherited

Write the object to a FITS image in memory.

Parameters
[in]managerName of the file to write to.
[in]modeIf "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 29 of file Persistable.cc.

◆ writeFits() [3/3]

void lsst::afw::table::io::Persistable::writeFits ( std::string const &  fileName,
std::string const &  mode = "w" 
) const
inherited

Write the object to a regular FITS file.

Parameters
[in]fileNameName of the file to write to.
[in]modeIf "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 24 of file Persistable.cc.


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