An immutable collection of Detectors that can be accessed by name or ID.
More...
#include <DetectorCollection.h>
An immutable collection of Detectors that can be accessed by name or ID.
Definition at line 149 of file DetectorCollection.h.
◆ IdMap
◆ List
◆ NameMap
◆ OutputArchiveHandle
◆ DetectorCollection() [1/4]
lsst::afw::cameraGeom::DetectorCollection::DetectorCollection |
( |
List const & |
list | ) |
|
◆ ~DetectorCollection()
lsst::afw::cameraGeom::DetectorCollection::~DetectorCollection |
( |
| ) |
|
|
virtualdefaultnoexcept |
◆ DetectorCollection() [2/4]
lsst::afw::cameraGeom::DetectorCollection::DetectorCollection |
( |
DetectorCollection const & |
| ) |
|
|
delete |
◆ DetectorCollection() [3/4]
◆ DetectorCollection() [4/4]
◆ add()
Add a detector to the collection.
- Parameters
-
[in] | detector | New detector to add to the collection. |
- Exceptions
-
- Exception Safety
- Strong for pex::exceptions::RuntimeError, weak (collection is made empty) otherwise.
Definition at line 89 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
-
param[in] ptr The pointer to be cast.
- Returns
- The cast pointer.
- Exceptions
-
Definition at line 218 of file Persistable.cc.
◆ empty()
◆ get() [1/2]
Retrieve a detector by ID, or fall back to a default.
- Parameters
-
[in] | id | detector id |
[in] | def | default detector to return. This defaults to nullptr . |
- Returns
- pointer to detector entry if the entry exists, else return the default value
Definition at line 65 of file DetectorCollection.cc.
◆ get() [2/2]
Retrieve a detector by name, or fall back to a default.
- Parameters
-
[in] | name | detector name |
[in] | def | default detector to return. This defaults to nullptr . |
- Returns
- pointer to detector entry if the entry exists, else return the default value
Definition at line 56 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()
◆ getNameMap()
◆ getPersistenceName()
std::string lsst::afw::cameraGeom::DetectorCollection::getPersistenceName |
( |
| ) |
const |
|
overrideprotectedvirtual |
◆ 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 |
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ operator[]() [1/2]
Implement the [id] operator.
- Parameters
-
- Returns
- pointer to detector entry
Definition at line 46 of file DetectorCollection.cc.
◆ operator[]() [2/2]
Implement the [name] operator.
- Parameters
-
- Returns
- pointer to detector entry
Definition at line 36 of file DetectorCollection.cc.
◆ readFits() [1/3]
Read an object from an already open FITS object.
- Parameters
-
[in] | fitsfile | FITS object to read from, already positioned at the desired HDU. |
Definition at line 183 of file Persistable.h.
◆ readFits() [2/3]
Read an object from a FITS file in memory.
- Parameters
-
[in] | manager | Manager for the memory to read from. |
[in] | hdu | HDU 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]
Read an object from a regular FITS file.
- Parameters
-
[in] | fileName | Name of the file to read. |
[in] | hdu | HDU 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]
◆ remove() [2/2]
◆ size()
Get the number of detectors.
Renamed to __len__
in Python.
Definition at line 67 of file DetectorCollection.h.
◆ write()
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] | fitsfile | Open FITS object to write to. |
Definition at line 18 of file Persistable.cc.
◆ writeFits() [2/3]
Write the object to a FITS image in memory.
- Parameters
-
[in] | manager | Name of the file to write to. |
[in] | mode | If "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] | fileName | Name of the file to write to. |
[in] | mode | If "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: