LSSTApplications
16.0-10-g0ee56ad+5,16.0-11-ga33d1f2+5,16.0-12-g3ef5c14+3,16.0-12-g71e5ef5+18,16.0-12-gbdf3636+3,16.0-13-g118c103+3,16.0-13-g8f68b0a+3,16.0-15-gbf5c1cb+4,16.0-16-gfd17674+3,16.0-17-g7c01f5c+3,16.0-18-g0a50484+1,16.0-20-ga20f992+8,16.0-21-g0e05fd4+6,16.0-21-g15e2d33+4,16.0-22-g62d8060+4,16.0-22-g847a80f+4,16.0-25-gf00d9b8+1,16.0-28-g3990c221+4,16.0-3-gf928089+3,16.0-32-g88a4f23+5,16.0-34-gd7987ad+3,16.0-37-gc7333cb+2,16.0-4-g10fc685+2,16.0-4-g18f3627+26,16.0-4-g5f3a788+26,16.0-5-gaf5c3d7+4,16.0-5-gcc1f4bb+1,16.0-6-g3b92700+4,16.0-6-g4412fcd+3,16.0-6-g7235603+4,16.0-69-g2562ce1b+2,16.0-8-g14ebd58+4,16.0-8-g2df868b+1,16.0-8-g4cec79c+6,16.0-8-gadf6c7a+1,16.0-8-gfc7ad86,16.0-82-g59ec2a54a+1,16.0-9-g5400cdc+2,16.0-9-ge6233d7+5,master-g2880f2d8cf+3,v17.0.rc1
LSSTDataManagementBasePackage
|
A collection of Detectors plus additional coordinate system support. More...
#include <Camera.h>
Classes | |
class | Factory |
Public Types | |
using | DetectorList = DetectorCollection::List |
using | NameMap = std::unordered_map< std::string, std::shared_ptr< Detector > > |
using | IdMap = std::map< int, std::shared_ptr< Detector > > |
using | List = std::vector< std::shared_ptr< Detector > > |
Public Member Functions | |
Camera (std::string const &name, DetectorList const &detectorList, std::shared_ptr< TransformMap > transformMap, std::string const &pupilFactoryName) | |
Construct a camera. More... | |
Camera (Camera const &)=delete | |
Camera (Camera &&)=delete | |
Camera & | operator= (Camera const &)=delete |
Camera & | operator= (Camera &&)=delete |
virtual | ~Camera () noexcept |
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... | |
NameMap const & | getNameMap () const noexcept |
Get an unordered map over detector names. More... | |
IdMap const & | getIdMap () const noexcept |
Get an unordered map over detector IDs. More... | |
lsst::geom::Box2D const & | getFpBBox () const noexcept |
Return a focal plane bounding box that encompasses all detectors. More... | |
std::size_t | size () const noexcept |
Get the number of detectors. More... | |
bool | empty () const noexcept |
Determine if the DetectorCollection contains any Detectors. More... | |
std::shared_ptr< Detector > | operator[] (std::string const &name) const |
Implement the [name] operator. More... | |
std::shared_ptr< Detector > | operator[] (int id) const |
Implement the [id] operator. More... | |
std::shared_ptr< Detector > | get (std::string const &name, std::shared_ptr< Detector > def=nullptr) const |
Support the "in" operator. More... | |
std::shared_ptr< Detector > | get (int id, std::shared_ptr< Detector > def=nullptr) const |
Support the "in" operator. 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< 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... | |
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... | |
Protected Types | |
typedef io::OutputArchiveHandle | OutputArchiveHandle |
Protected Member Functions | |
Camera (table::io::InputArchive const &archive, table::io::CatalogVector const &catalogs) | |
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... | |
A collection of Detectors plus additional coordinate system support.
Camera.transform transforms points from one camera coordinate system to another. Camera.getTransform returns a transform between camera coordinate systems. Camera.findDetectors finds all detectors overlapping a specified point.
|
inherited |
Definition at line 44 of file DetectorCollection.h.
|
inherited |
Definition at line 45 of file DetectorCollection.h.
|
inherited |
Definition at line 43 of file DetectorCollection.h.
|
protectedinherited |
Definition at line 108 of file Persistable.h.
lsst::afw::cameraGeom::Camera::Camera | ( | std::string const & | name, |
DetectorList const & | detectorList, | ||
std::shared_ptr< TransformMap > | transformMap, | ||
std::string const & | pupilFactoryName | ||
) |
Construct a camera.
[in] | name | name of camera |
[in] | detectorList | a DetectorList in index order |
[in] | transformMap | a TransformMap that at least supports FOCAL_PLANE and FIELD_ANGLE coordinates |
[in] | pupilFactoryName | name of a PupilFactory class for this camera |
Definition at line 68 of file Camera.cc.
|
delete |
|
delete |
|
virtualdefaultnoexcept |
|
protected |
Definition at line 208 of file Camera.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 18 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 18 of file Persistable.cc.
|
inlinenoexceptinherited |
Determine if the DetectorCollection contains any Detectors.
Definition at line 77 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 76 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 93 of file Camera.cc.
|
inherited |
Support the "in" operator.
[in] | name | detector name |
[in] | def | default detector to return. This defaults to the NULL pointer |
Definition at line 67 of file DetectorCollection.cc.
|
inherited |
Support the "in" operator.
[in] | id | detector id |
[in] | def | default detector to return. This defaults to the NULL pointer |
Definition at line 76 of file DetectorCollection.cc.
|
inlinenoexceptinherited |
Return a focal plane bounding box that encompasses all detectors.
Definition at line 67 of file DetectorCollection.h.
|
inlinenoexceptinherited |
Get an unordered map over detector IDs.
Definition at line 64 of file DetectorCollection.h.
|
inline |
|
inlinenoexceptinherited |
Get an unordered map over detector names.
Definition at line 61 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 159 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. This includes the case that fromSys specifies a known detector and toSys specifies any other detector (known or unknown) |
KeyError | if an unknown detector is specified |
Definition at line 114 of file Camera.cc.
|
inlinenoexcept |
Obtain the transform registry.
|
inlineoverridevirtualnoexcept |
Cameras are always persistable.
Reimplemented from lsst::afw::table::io::Persistable.
|
inherited |
Implement the [name] operator.
[in] | name | detector name |
Definition at line 51 of file DetectorCollection.cc.
|
inherited |
Implement the [id] operator.
[in] | id | detector name |
Definition at line 59 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 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.
|
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.
|
inlinenoexceptinherited |
Get the number of detectors.
Renamed to __len__
in Python.
Definition at line 72 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 137 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 143 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 227 of file Camera.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.
|
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 an already-open FITS object.
[in] | fitsfile | Open FITS object to write to. |
Definition at line 18 of file Persistable.cc.