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

A collection of Detectors plus additional coordinate system support. More...

#include <Camera.h>

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

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
 
Cameraoperator= (Camera const &)=delete
 
Cameraoperator= (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< 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...
 
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< Detectoroperator[] (std::string const &name) const
 Implement the [name] operator. More...
 
std::shared_ptr< Detectoroperator[] (int id) const
 Implement the [id] operator. More...
 
std::shared_ptr< Detectorget (std::string const &name, std::shared_ptr< Detector > def=nullptr) const
 Support the "in" operator. More...
 
std::shared_ptr< Detectorget (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< 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...
 
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

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

Detailed Description

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.

Definition at line 43 of file Camera.h.

Member Typedef Documentation

◆ DetectorList

Definition at line 45 of file Camera.h.

◆ IdMap

Definition at line 44 of file DetectorCollection.h.

◆ List

Definition at line 45 of file DetectorCollection.h.

◆ NameMap

Definition at line 43 of file DetectorCollection.h.

◆ OutputArchiveHandle

typedef io::OutputArchiveHandle lsst::afw::table::io::Persistable::OutputArchiveHandle
protectedinherited

Definition at line 108 of file Persistable.h.

Constructor & Destructor Documentation

◆ Camera() [1/4]

lsst::afw::cameraGeom::Camera::Camera ( std::string const &  name,
DetectorList const &  detectorList,
std::shared_ptr< TransformMap transformMap,
std::string const &  pupilFactoryName 
)

Construct a camera.

Parameters
[in]namename of camera
[in]detectorLista DetectorList in index order
[in]transformMapa TransformMap that at least supports FOCAL_PLANE and FIELD_ANGLE coordinates
[in]pupilFactoryNamename of a PupilFactory class for this camera

Definition at line 68 of file Camera.cc.

69  :
70  DetectorCollection(detectorList),
71  _name(name), _transformMap(std::move(transformMap)), _pupilFactoryName(pupilFactoryName)
72  {}
table::Key< std::string > name
Definition: Camera.cc:162
T move(T... args)
table::Key< std::string > pupilFactoryName
Definition: Camera.cc:163

◆ Camera() [2/4]

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

◆ Camera() [3/4]

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

◆ ~Camera()

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

◆ Camera() [4/4]

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

Definition at line 208 of file Camera.cc.

208  :
209  DetectorCollection(archive, catalogs)
210  // deferred initalization for data members is not ideal, but better than
211  // trying to initialize them before validating the archive
212 {
213  auto const & keys = PersistenceHelper::get();
214  LSST_ARCHIVE_ASSERT(catalogs.size() >= 2u);
215  auto const & cat = catalogs[1];
216  LSST_ARCHIVE_ASSERT(cat.getSchema() == keys.schema);
217  LSST_ARCHIVE_ASSERT(cat.size() == 1u);
218  auto const & record = cat.front();
219  _name = record.get(keys.name);
220  _pupilFactoryName = record.get(keys.pupilFactoryName);
221  _transformMap = archive.get<TransformMap>(record.get(keys.transformMap));
222 }
#define LSST_ARCHIVE_ASSERT(EXPR)
An assertion macro used to validate the structure of an InputArchive.
Definition: Persistable.h:48

Member Function Documentation

◆ dynamicCast() [1/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 18 of file Persistable.cc.

18  {
20  if (!result) {
21  throw LSST_EXCEPT(pex::exceptions::TypeError, "Dynamic pointer cast failed");
22  }
23  return result;
24 }
uint64_t * ptr
Definition: RangeSet.cc:88
py::object result
Definition: schema.cc:284
T dynamic_pointer_cast(T... args)
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48

◆ 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 18 of file Persistable.cc.

18  {
20  if (!result) {
21  throw LSST_EXCEPT(pex::exceptions::TypeError, "Dynamic pointer cast failed");
22  }
23  return result;
24 }
uint64_t * ptr
Definition: RangeSet.cc:88
py::object result
Definition: schema.cc:284
T dynamic_pointer_cast(T... args)
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48

◆ empty()

bool lsst::afw::cameraGeom::DetectorCollection::empty ( ) const
inlinenoexceptinherited

Determine if the DetectorCollection contains any Detectors.

Definition at line 77 of file DetectorCollection.h.

77 { return _idDict.empty(); }
T empty(T... args)

◆ 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 76 of file Camera.cc.

77  {
78  auto transform = getTransformFromOneTransformMap(*this, cameraSys, getNativeCameraSys());
79  auto nativePoint = transform->applyForward(point);
80 
81  DetectorList detectorList;
82  for (auto const &item : getIdMap()) {
83  auto detector = item.second;
84  auto nativeToPixels = detector->getTransform(getNativeCameraSys(), PIXELS);
85  auto pointPixels = nativeToPixels->applyForward(nativePoint);
86  if (lsst::geom::Box2D(detector->getBBox()).contains(pointPixels)) {
87  detectorList.push_back(std::move(detector));
88  }
89  }
90  return detectorList;
91 }
bool contains(VertexIterator const begin, VertexIterator const end, UnitVector3d const &v)
A floating-point coordinate rectangle geometry.
Definition: Box.h:294
CameraSysPrefix const PIXELS
Nominal pixels on the detector (unbinned) This ignores manufacturing imperfections, "tree ring" distortions and all other such effects.
Definition: CameraSys.cc:34
DetectorCollection::List DetectorList
Definition: Camera.h:45
table::Key< int > detector
T move(T... args)
IdMap const & getIdMap() const noexcept
Get an unordered map over detector IDs.

◆ 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 93 of file Camera.cc.

94  {
95  auto transform = getTransformFromOneTransformMap(*this, cameraSys, getNativeCameraSys());
96  std::vector<DetectorList> detectorListList(pointList.size());
97 
98  auto nativePointList = transform->applyForward(pointList);
99 
100  for (auto const &item: getIdMap()) {
101  auto const &detector = item.second;
102  auto nativeToPixels = detector->getTransform(getNativeCameraSys(), PIXELS);
103  auto pointPixelsList = nativeToPixels->applyForward(nativePointList);
104  for (std::size_t i = 0; i < pointPixelsList.size(); ++i) {
105  auto const &pointPixels = pointPixelsList[i];
106  if (lsst::geom::Box2D(detector->getBBox()).contains(pointPixels)) {
107  detectorListList[i].push_back(detector);
108  }
109  }
110  }
111  return detectorListList;
112 }
bool contains(VertexIterator const begin, VertexIterator const end, UnitVector3d const &v)
A floating-point coordinate rectangle geometry.
Definition: Box.h:294
CameraSysPrefix const PIXELS
Nominal pixels on the detector (unbinned) This ignores manufacturing imperfections, "tree ring" distortions and all other such effects.
Definition: CameraSys.cc:34
table::Key< int > detector
T size(T... args)
STL class.
IdMap const & getIdMap() const noexcept
Get an unordered map over detector IDs.

◆ get() [1/2]

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

Support the "in" operator.

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

Definition at line 67 of file DetectorCollection.cc.

68  {
69  auto i = _nameDict.find(name);
70  if (i == _nameDict.end()) {
71  return def;
72  }
73  return i->second;
74 }
T end(T... args)
T find(T... args)

◆ get() [2/2]

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

Support the "in" operator.

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

Definition at line 76 of file DetectorCollection.cc.

76  {
77  auto i = _idDict.find(id);
78  if (i == _idDict.end()) {
79  return def;
80  }
81  return i->second;
82 }
T end(T... args)
T find(T... args)

◆ 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 67 of file DetectorCollection.h.

67 { return _fpBBox; }

◆ getIdMap()

IdMap const& lsst::afw::cameraGeom::DetectorCollection::getIdMap ( ) const
inlinenoexceptinherited

Get an unordered map over detector IDs.

Definition at line 64 of file DetectorCollection.h.

64 { return _idDict; }

◆ getName()

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

Return the name of the camera.

Definition at line 72 of file Camera.h.

72 { return _name; }

◆ getNameMap()

NameMap const& lsst::afw::cameraGeom::DetectorCollection::getNameMap ( ) const
inlinenoexceptinherited

Get an unordered map over detector names.

Definition at line 61 of file DetectorCollection.h.

61 { return _nameDict; }

◆ 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 77 of file Camera.h.

77 { return _pupilFactoryName; }

◆ 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 159 of file DetectorCollection.cc.

159  {
160  return "lsst.afw.cameraGeom";
161 }

◆ 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. This includes the case that fromSys specifies a known detector and toSys specifies any other detector (known or unknown)
KeyErrorif an unknown detector is specified

Definition at line 114 of file Camera.cc.

115  {
116  try {
117  return getTransformMap()->getTransform(fromSys, toSys);
118  } catch (pex::exceptions::InvalidParameterError &) {}
119 
120  // If the Camera was constructed after DM-14980 using the makeCamera*
121  // methods in cameraFactory.py, the Camera and all Detectors share a
122  // single TransformMap that knows about all of the coordinate systems. In
123  // that case the above call should succeed (unless the requested
124  // coordinate systems are totally bogus).
125  //
126  // But if someone built this Camera by hand, the Detectors will know about
127  // only the coordinate systems associated with them, while the Camera
128  // itself only knows about coordinate systems that aren't associated with
129  // any particular Detector. In that case we need to (in general) look up
130  // transforms in multiple places and connect them using the "native camera
131  // sys" that's known to everything (at least usually FOCAL_PLANE).
132  auto fromSysToNative = getTransformFromOneTransformMap(*this, fromSys, getNativeCameraSys());
133  auto nativeToToSys = getTransformFromOneTransformMap(*this, getNativeCameraSys(), toSys);
134  return fromSysToNative->then(*nativeToToSys);
135 }
std::shared_ptr< TransformMap const > getTransformMap() const noexcept
Obtain the transform registry.
Definition: Camera.h:122

◆ 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 122 of file Camera.h.

122 { return _transformMap; }

◆ isPersistable()

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

Cameras are always persistable.

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

Definition at line 150 of file Camera.h.

150  {
151  return true;
152  }

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ operator[]() [1/2]

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

Implement the [name] operator.

Parameters
[in]namedetector name
Returns
pointer to detector entry

Definition at line 51 of file DetectorCollection.cc.

51  {
52  auto det = get(name);
53  if (det == nullptr) {
54  throw LSST_EXCEPT(pex::exceptions::NotFoundError, "Detector name not found");
55  }
56  return det;
57 }
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48

◆ operator[]() [2/2]

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

Implement the [id] operator.

Parameters
[in]iddetector name
Returns
pointer to detector entry

Definition at line 59 of file DetectorCollection.cc.

59  {
60  auto det = get(id);
61  if (det == nullptr) {
62  throw LSST_EXCEPT(pex::exceptions::NotFoundError, "Detector id not found");
63  }
64  return det;
65 }
table::Key< int > id
Definition: Detector.cc:163
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48

◆ readFits() [1/6]

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.

183  {
184  return dynamicCast(Persistable::_readFits(fitsfile));
185  }
static std::shared_ptr< DetectorCollection > dynamicCast(std::shared_ptr< Persistable > const &ptr)
Dynamically cast a shared_ptr.
Definition: Persistable.cc:18

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

183  {
184  return dynamicCast(Persistable::_readFits(fitsfile));
185  }
static std::shared_ptr< Camera > dynamicCast(std::shared_ptr< Persistable > const &ptr)
Dynamically cast a shared_ptr.
Definition: Persistable.cc:18

◆ readFits() [3/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.

194  {
195  return dynamicCast(Persistable::_readFits(fileName, hdu));
196  }
static std::shared_ptr< DetectorCollection > dynamicCast(std::shared_ptr< Persistable > const &ptr)
Dynamically cast a shared_ptr.
Definition: Persistable.cc:18

◆ readFits() [4/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.

194  {
195  return dynamicCast(Persistable::_readFits(fileName, hdu));
196  }
static std::shared_ptr< Camera > dynamicCast(std::shared_ptr< Persistable > const &ptr)
Dynamically cast a shared_ptr.
Definition: Persistable.cc:18

◆ readFits() [5/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.

205  {
206  return dynamicCast(Persistable::_readFits(manager, hdu));
207  }
static std::shared_ptr< Camera > dynamicCast(std::shared_ptr< Persistable > const &ptr)
Dynamically cast a shared_ptr.
Definition: Persistable.cc:18

◆ readFits() [6/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.

205  {
206  return dynamicCast(Persistable::_readFits(manager, hdu));
207  }
static std::shared_ptr< DetectorCollection > dynamicCast(std::shared_ptr< Persistable > const &ptr)
Dynamically cast a shared_ptr.
Definition: Persistable.cc:18

◆ size()

std::size_t lsst::afw::cameraGeom::DetectorCollection::size ( ) const
inlinenoexceptinherited

Get the number of detectors.

Renamed to __len__ in Python.

Definition at line 72 of file DetectorCollection.h.

72 { return _idDict.size(); }
T size(T... args)

◆ 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 137 of file Camera.cc.

138  {
139  auto transform = getTransform(fromSys, toSys);
140  return transform->applyForward(point);
141 }
std::shared_ptr< afw::geom::TransformPoint2ToPoint2 > getTransform(CameraSys const &fromSys, CameraSys const &toSys) const
Get a transform from one CameraSys to another.
Definition: Camera.cc:114

◆ 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 143 of file Camera.cc.

145  {
146  auto transform = getTransform(fromSys, toSys);
147  return transform->applyForward(points);
148 }
std::shared_ptr< afw::geom::TransformPoint2ToPoint2 > getTransform(CameraSys const &fromSys, CameraSys const &toSys) const
Get a transform from one CameraSys to another.
Definition: Camera.cc:114

◆ 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 227 of file Camera.cc.

227  {
229  auto const & keys = PersistenceHelper::get();
230  auto cat = handle.makeCatalog(keys.schema);
231  auto record = cat.addNew();
232  record->set(keys.name, getName());
233  record->set(keys.pupilFactoryName, getPupilFactoryName());
234  record->set(keys.transformMap, handle.put(getTransformMap()));
235  handle.saveCatalog(cat);
236 }
std::shared_ptr< TransformMap const > getTransformMap() const noexcept
Obtain the transform registry.
Definition: Camera.h:122
std::string getName() const
Return the name of the camera.
Definition: Camera.h:72
void write(OutputArchiveHandle &handle) const override
Write the object to one or more catalogs.
std::string getPupilFactoryName() const
Return the fully-qualified name of the Python class that provides this Camera&#39;s PupilFactory.
Definition: Camera.h:77

◆ writeFits() [1/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.

24  {
25  fits::Fits fitsfile(fileName, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
26  writeFits(fitsfile);
27 }
void writeFits(std::string const &fileName, std::string const &mode="w") const
Write the object to a regular FITS file.
Definition: Persistable.cc:24

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

29  {
30  fits::Fits fitsfile(manager, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
31  writeFits(fitsfile);
32 }
void writeFits(std::string const &fileName, std::string const &mode="w") const
Write the object to a regular FITS file.
Definition: Persistable.cc:24

◆ writeFits() [3/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.

18  {
19  OutputArchive archive;
20  archive.put(this);
21  archive.writeFits(fitsfile);
22 }

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