lsst.afw g093c4c12c6+20210d9dd1
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | List of all members
lsst::afw::cameraGeom::Camera Class Reference

An immutable representation of a camera. More...

#include <Camera.h>

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

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< T > >
 
using IdMap = std::map< int, std::shared_ptr< T > >
 
using List = std::vector< std::shared_ptr< T > >
 

Public Member Functions

 Camera (Camera const &)=delete
 
 Camera (Camera &&)=delete
 
Cameraoperator= (Camera const &)=delete
 
Cameraoperator= (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< DetectorListfindDetectorsList (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::TransformPoint2ToPoint2getTransform (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::Point2Dtransform (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< T > operator[] (std::string const &name) const
 Implement the [name] operator. More...
 
std::shared_ptr< T > operator[] (int id) const
 Implement the [id] operator. More...
 
std::shared_ptr< T > get (std::string const &name, std::shared_ptr< T > def=nullptr) const
 Retrieve a detector by name, or fall back to a default. More...
 
std::shared_ptr< T > get (int id, std::shared_ptr< T > 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...
 
static std::shared_ptr< CamerareadFits (fits::Fits &fitsfile)
 Read an object from an already open FITS object. More...
 
static std::shared_ptr< CamerareadFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 Read an object from a regular FITS file. More...
 
static std::shared_ptr< CamerareadFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 Read an object from a FITS file in memory. More...
 
static std::shared_ptr< CameradynamicCast (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< T > detector)
 Add a detector to the collection. More...
 
void remove (std::string const &name)
 
void remove (int id)
 

Detailed Description

An immutable representation of a camera.

Cameras are created (and modified, when necessary) via the Camera::Builder helper class.

Definition at line 43 of file Camera.h.

Member Typedef Documentation

◆ DetectorList

Definition at line 48 of file Camera.h.

◆ IdMap

template<typename T >
using lsst::afw::cameraGeom::DetectorCollectionBase< T >::IdMap = std::map<int, std::shared_ptr<T> >
inherited

Definition at line 53 of file DetectorCollection.h.

◆ List

template<typename T >
using lsst::afw::cameraGeom::DetectorCollectionBase< T >::List = std::vector<std::shared_ptr<T> >
inherited

Definition at line 54 of file DetectorCollection.h.

◆ NameMap

template<typename T >
using lsst::afw::cameraGeom::DetectorCollectionBase< T >::NameMap = std::unordered_map<std::string, std::shared_ptr<T> >
inherited

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

◆ Camera() [1/2]

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

◆ Camera() [2/2]

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

◆ ~Camera()

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

Member Function Documentation

◆ add()

template<typename T >
void lsst::afw::cameraGeom::DetectorCollectionBase< T >::add ( std::shared_ptr< T >  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 89 of file DetectorCollection.cc.

◆ dynamicCast() [1/2]

template std::shared_ptr< math::WarpingControl > lsst::afw::table::io::PersistableFacade< Camera >::dynamicCast ( std::shared_ptr< Persistable > const &  ptr)
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;

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.

◆ dynamicCast() [2/2]

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()

template<typename T >
bool lsst::afw::cameraGeom::DetectorCollectionBase< T >::empty ( ) const
inlinenoexceptinherited

Determine if the collection contains any detectors.

Definition at line 72 of file DetectorCollection.h.

◆ findDetectors()

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.

Parameters
[in]pointposition to use in lookup (lsst::geom::Point2D)
[in]cameraSyscamera coordinate system of point
Returns
a list of zero or more Detectors that overlap the specified point

Definition at line 45 of file Camera.cc.

◆ findDetectorsList()

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.

Parameters
[in]pointLista list of points (lsst::geom::Point2D)
[in]cameraSysthe camera coordinate system of the points in pointList
Returns
a list of lists; each list contains the names of all detectors which contain the corresponding point

Definition at line 60 of file Camera.cc.

◆ get() [1/2]

template<typename T >
std::shared_ptr< T > lsst::afw::cameraGeom::DetectorCollectionBase< T >::get ( int  id,
std::shared_ptr< T >  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 65 of file DetectorCollection.cc.

◆ get() [2/2]

template<typename T >
std::shared_ptr< T > lsst::afw::cameraGeom::DetectorCollectionBase< T >::get ( std::string const &  name,
std::shared_ptr< T >  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 56 of file DetectorCollection.cc.

◆ getFpBBox()

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

Return a focal plane bounding box that encompasses all detectors.

Definition at line 159 of file DetectorCollection.h.

◆ getIdMap()

template<typename T >
IdMap const & lsst::afw::cameraGeom::DetectorCollectionBase< T >::getIdMap ( ) const
inlinenoexceptinherited

Get a map keyed and ordered by ID.

Definition at line 62 of file DetectorCollection.h.

◆ getName()

std::string lsst::afw::cameraGeom::Camera::getName ( ) const
inline

Return the name of the camera.

Definition at line 71 of file Camera.h.

◆ getNameMap()

template<typename T >
NameMap const & lsst::afw::cameraGeom::DetectorCollectionBase< T >::getNameMap ( ) const
inlinenoexceptinherited

Get a map keyed and ordered by name.

Definition at line 59 of file DetectorCollection.h.

◆ getPupilFactoryName()

std::string lsst::afw::cameraGeom::Camera::getPupilFactoryName ( ) const
inline

Return the fully-qualified name of the Python class that provides this Camera's PupilFactory.

Definition at line 76 of file Camera.h.

◆ getPythonModule()

std::string lsst::afw::cameraGeom::DetectorCollection::getPythonModule ( ) const
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.

◆ getTransform()

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.

Parameters
[in]fromSysFrom CameraSys
[in]toSysTo CameraSys
Returns
an afw::geom::TransformPoint2ToPoint2 that transforms from fromSys to toSys in the forward direction
Exceptions
lsst::pex::exceptions::InvalidParameterErrorif no transform is available.
KeyErrorif an unknown detector is specified

Definition at line 78 of file Camera.cc.

◆ getTransformMap()

std::shared_ptr< TransformMap const > lsst::afw::cameraGeom::Camera::getTransformMap ( ) const
inlinenoexcept

Obtain the transform registry.

Returns
_transformMap a TransformMap
Note
_transformMap is immutable, so this should be safe.

Definition at line 120 of file Camera.h.

◆ isPersistable()

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

Cameras are always persistable.

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

Definition at line 148 of file Camera.h.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ operator[]() [1/2]

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

Implement the [id] operator.

Parameters
[in]iddetector name
Returns
pointer to detector entry

Definition at line 46 of file DetectorCollection.cc.

◆ operator[]() [2/2]

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

Implement the [name] operator.

Parameters
[in]namedetector name
Returns
pointer to detector entry

Definition at line 36 of file DetectorCollection.cc.

◆ readFits() [1/6]

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/6]

static std::shared_ptr< Camera > lsst::afw::table::io::PersistableFacade< Camera >::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() [3/6]

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() [4/6]

static std::shared_ptr< Camera > lsst::afw::table::io::PersistableFacade< Camera >::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() [5/6]

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.

◆ readFits() [6/6]

static std::shared_ptr< Camera > lsst::afw::table::io::PersistableFacade< Camera >::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.

◆ rebuild()

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).

Definition at line 41 of file Camera.cc.

◆ remove() [1/2]

template<typename T >
void lsst::afw::cameraGeom::DetectorCollectionBase< T >::remove ( int  id)
protectedinherited

Definition at line 144 of file DetectorCollection.cc.

◆ remove() [2/2]

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

Definition at line 129 of file DetectorCollection.cc.

◆ size()

template<typename T >
std::size_t lsst::afw::cameraGeom::DetectorCollectionBase< T >::size ( ) const
inlinenoexceptinherited

Get the number of detectors.

Renamed to __len__ in Python.

Definition at line 67 of file DetectorCollection.h.

◆ transform() [1/2]

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.

Parameters
[in]pointan lsst::geom::Point2d
[in]fromSystransform from this CameraSys
[in]toSystransform to this CameraSys
Returns
point transformed to toSys (an lsst::geom::Point2D)

Definition at line 83 of file Camera.cc.

◆ transform() [2/2]

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.

Parameters
[in]pointsan vector of lsst::geom::Point2d
[in]fromSystransform from this CameraSys
[in]toSystransform to this CameraSys
Returns
points transformed to toSys (a vector of lsst::geom::Point2D)

Definition at line 89 of file Camera.cc.

◆ write()

void lsst::afw::cameraGeom::Camera::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 149 of file Camera.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: