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
|
An immutable representation of a camera. More...
#include <Camera.h>
Classes | |
class | Builder |
A helper class for creating and modifying cameras. More... | |
class | Factory |
Public Types | |
using | DetectorList = DetectorCollection::List |
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 | |
Camera (Camera const &)=delete | |
Camera (Camera &&)=delete | |
Camera & | operator= (Camera const &)=delete |
Camera & | operator= (Camera &&)=delete |
virtual | ~Camera () noexcept |
Camera::Builder | rebuild () const |
Create a Camera::Builder object initialized with this camera's state. More... | |
std::string | getName () const |
Return the name of the camera. More... | |
std::string | getPupilFactoryName () const |
Return the fully-qualified name of the Python class that provides this Camera's PupilFactory. More... | |
DetectorList | findDetectors (lsst::geom::Point2D const &point, CameraSys const &cameraSys) const |
Find the detectors that cover a point in any camera system. More... | |
std::vector< DetectorList > | findDetectorsList (std::vector< lsst::geom::Point2D > const &pointList, CameraSys const &cameraSys) const |
Find the detectors that cover a list of points in any camera system. More... | |
std::shared_ptr< afw::geom::TransformPoint2ToPoint2 > | getTransform (CameraSys const &fromSys, CameraSys const &toSys) const |
Get a transform from one CameraSys to another. More... | |
std::shared_ptr< TransformMap const > | getTransformMap () const noexcept |
Obtain the transform registry. More... | |
lsst::geom::Point2D | transform (lsst::geom::Point2D const &point, CameraSys const &fromSys, CameraSys const &toSys) const |
Transform a point from one camera coordinate system to another. More... | |
std::vector< lsst::geom::Point2D > | transform (std::vector< lsst::geom::Point2D > const &points, CameraSys const &fromSys, CameraSys const &toSys) const |
Transform a vector of points from one camera coordinate system to another. More... | |
bool | isPersistable () const noexcept override |
Cameras are always persistable. More... | |
lsst::geom::Box2D const & | getFpBBox () const noexcept |
Return a focal plane bounding box that encompasses all detectors. 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< DetectorCollection > | readFits (fits::Fits &fitsfile) |
Read an object from an already open FITS object. More... | |
static std::shared_ptr< DetectorCollection > | readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU) |
Read an object from a regular FITS file. More... | |
static std::shared_ptr< DetectorCollection > | readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU) |
Read an object from a FITS file in memory. More... | |
static std::shared_ptr< DetectorCollection > | dynamicCast (std::shared_ptr< Persistable > const &ptr) |
Dynamically cast a shared_ptr. More... | |
static std::shared_ptr< Camera > | readFits (fits::Fits &fitsfile) |
Read an object from an already open FITS object. More... | |
static std::shared_ptr< Camera > | readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU) |
Read an object from a regular FITS file. More... | |
static std::shared_ptr< Camera > | readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU) |
Read an object from a FITS file in memory. More... | |
static std::shared_ptr< Camera > | dynamicCast (std::shared_ptr< Persistable > const &ptr) |
Dynamically cast a shared_ptr. More... | |
Protected Types | |
using | OutputArchiveHandle = io::OutputArchiveHandle |
Protected Member Functions | |
void | write (OutputArchiveHandle &handle) const override |
Write the object to one or more catalogs. 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 | add (std::shared_ptr< Detector const > detector) |
Add a detector to the collection. More... | |
void | remove (std::string const &name) |
void | remove (int id) |
An immutable representation of a camera.
Cameras are created (and modified, when necessary) via the Camera::Builder helper class.
|
inherited |
Definition at line 53 of file DetectorCollection.h.
|
inherited |
Definition at line 54 of file DetectorCollection.h.
|
inherited |
Definition at line 52 of file DetectorCollection.h.
|
protectedinherited |
Definition at line 108 of file Persistable.h.
|
delete |
|
delete |
|
virtualdefaultnoexcept |
|
protectedinherited |
Add a detector to the collection.
[in] | detector | New detector to add to the collection. |
pex::exceptions::RuntimeError | Thrown if the ID and/or name conflict with those of detectors already in the collection. |
Definition at line 135 of file DetectorCollection.cc.
|
staticinherited |
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;
lsst::pex::exceptions::LogicError | if the cast fails |
param[in] ptr The pointer to be cast.
lsst::pex::exceptions::TypeError | If the dynamic cast fails. |
Definition at line 218 of file Persistable.cc.
|
staticinherited |
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;
lsst::pex::exceptions::LogicError | if the cast fails |
param[in] ptr The pointer to be cast.
lsst::pex::exceptions::TypeError | If the dynamic cast fails. |
Definition at line 218 of file Persistable.cc.
|
inlinenoexceptinherited |
Determine if the collection contains any detectors.
Definition at line 72 of file DetectorCollection.h.
Camera::DetectorList lsst::afw::cameraGeom::Camera::findDetectors | ( | lsst::geom::Point2D const & | point, |
CameraSys const & | cameraSys | ||
) | const |
Find the detectors that cover a point in any camera system.
[in] | point | position to use in lookup (lsst::geom::Point2D) |
[in] | cameraSys | camera coordinate system of point |
Definition at line 45 of file Camera.cc.
std::vector< Camera::DetectorList > lsst::afw::cameraGeom::Camera::findDetectorsList | ( | std::vector< lsst::geom::Point2D > const & | pointList, |
CameraSys const & | cameraSys | ||
) | const |
Find the detectors that cover a list of points in any camera system.
[in] | pointList | a list of points (lsst::geom::Point2D) |
[in] | cameraSys | the camera coordinate system of the points in pointList |
Definition at line 60 of file Camera.cc.
|
inherited |
Retrieve a detector by ID, or fall back to a default.
[in] | id | detector id |
[in] | def | default detector to return. This defaults to nullptr . |
Definition at line 110 of file DetectorCollection.cc.
|
inherited |
Retrieve a detector by name, or fall back to a default.
[in] | name | detector name |
[in] | def | default detector to return. This defaults to nullptr . |
Definition at line 99 of file DetectorCollection.cc.
|
inlinenoexceptinherited |
Return a focal plane bounding box that encompasses all detectors.
Definition at line 159 of file DetectorCollection.h.
|
inlinenoexceptinherited |
Get a map keyed and ordered by ID.
Definition at line 62 of file DetectorCollection.h.
|
inline |
|
inlinenoexceptinherited |
Get a map keyed and ordered by name.
Definition at line 59 of file DetectorCollection.h.
|
inline |
|
overrideprotectedvirtualinherited |
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.
std::shared_ptr< afw::geom::TransformPoint2ToPoint2 > lsst::afw::cameraGeom::Camera::getTransform | ( | CameraSys const & | fromSys, |
CameraSys const & | toSys | ||
) | const |
Get a transform from one CameraSys to another.
fromSys
to toSys
in the forward directionlsst::pex::exceptions::InvalidParameterError | if no transform is available. |
KeyError | if an unknown detector is specified |
Definition at line 78 of file Camera.cc.
|
inlinenoexcept |
Obtain the transform registry.
|
inlineoverridevirtualnoexcept |
Cameras are always persistable.
Reimplemented from lsst::afw::table::io::Persistable.
|
inherited |
Implement the [id] operator.
[in] | id | detector name |
Definition at line 88 of file DetectorCollection.cc.
|
inherited |
Implement the [name] operator.
[in] | name | detector name |
Definition at line 80 of file DetectorCollection.cc.
|
inlinestaticinherited |
Read an object from an already open FITS object.
[in] | fitsfile | FITS object to read from, already positioned at the desired HDU. |
Definition at line 183 of file Persistable.h.
|
inlinestaticinherited |
Read an object from an already open FITS object.
[in] | fitsfile | FITS object to read from, already positioned at the desired HDU. |
Definition at line 183 of file Persistable.h.
|
inlinestaticinherited |
Read an object from a FITS file in memory.
[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.
|
inlinestaticinherited |
Read an object from a FITS file in memory.
[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.
|
inlinestaticinherited |
Read an object from a regular FITS file.
[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.
|
inlinestaticinherited |
Read an object from a regular FITS file.
[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.
Camera::Builder lsst::afw::cameraGeom::Camera::rebuild | ( | ) | const |
Create a Camera::Builder object initialized with this camera's state.
This is simply a shortcut for Camera::Builder(*this)
.
|
protectedinherited |
Definition at line 138 of file DetectorCollection.cc.
|
protectedinherited |
Definition at line 137 of file DetectorCollection.cc.
|
inlinenoexceptinherited |
Get the number of detectors.
Renamed to __len__
in Python.
Definition at line 67 of file DetectorCollection.h.
lsst::geom::Point2D lsst::afw::cameraGeom::Camera::transform | ( | lsst::geom::Point2D const & | point, |
CameraSys const & | fromSys, | ||
CameraSys const & | toSys | ||
) | const |
Transform a point from one camera coordinate system to another.
[in] | point | an lsst::geom::Point2d |
[in] | fromSys | transform from this CameraSys |
[in] | toSys | transform to this CameraSys |
toSys
(an lsst::geom::Point2D) Definition at line 83 of file Camera.cc.
std::vector< lsst::geom::Point2D > lsst::afw::cameraGeom::Camera::transform | ( | std::vector< lsst::geom::Point2D > const & | points, |
CameraSys const & | fromSys, | ||
CameraSys const & | toSys | ||
) | const |
Transform a vector of points from one camera coordinate system to another.
[in] | points | an vector of lsst::geom::Point2d |
[in] | fromSys | transform from this CameraSys |
[in] | toSys | transform to this CameraSys |
toSys
(a vector of lsst::geom::Point2D) Definition at line 89 of file Camera.cc.
|
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 149 of file Camera.cc.
|
inherited |
Write the object to an already-open FITS object.
[in] | fitsfile | Open FITS object to write to. |
Definition at line 18 of file Persistable.cc.
|
inherited |
Write the object to a FITS image in memory.
[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.
|
inherited |
Write the object to a regular FITS file.
[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.