LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
|
A helper class for creating and modifying cameras. More...
#include <Camera.h>
Public Types | |
using | NameMap |
using | IdMap |
using | List |
Public Member Functions | |
virtual | ~Builder () noexcept |
Builder (std::string const &name) | |
Construct a Builder for a completely new Camera with the given name. | |
Builder (Camera const &camera) | |
Construct a Builder with the state of an existing Camera. | |
std::shared_ptr< Camera const > | finish () const |
Construct a new Camera from the state of the Builder. | |
std::string | getName () const |
Return the name of the camera. | |
void | setName (std::string const &name) |
Set the name of the camera. | |
std::string | getPupilFactoryName () const |
Return the fully-qualified name of the Python class that provides this Camera's PupilFactory. | |
void | setPupilFactoryName (std::string const &pupilFactoryName) |
Set the fully-qualified name of the Python class that provides this Camera's PupilFactory. | |
void | setTransformFromFocalPlaneTo (CameraSys const &toSys, std::shared_ptr< afw::geom::TransformPoint2ToPoint2 const > transform) |
Set the transformation from FOCAL_PLANE to the given coordinate system. | |
bool | discardTransformFromFocalPlaneTo (CameraSys const &toSys) |
Remove any transformation from FOCAL_PLANE to the given coordinate system. | |
std::shared_ptr< Detector::InCameraBuilder > | add (std::string const &name, int id) |
Add a new Detector with the given name and ID. | |
void | remove (std::string const &name) |
Remove the detector with the given name or ID. | |
void | remove (int id) |
NameMap const & | getNameMap () const noexcept |
Get a map keyed and ordered by name. | |
IdMap const & | getIdMap () const noexcept |
Get a map keyed and ordered by ID. | |
std::size_t | size () const noexcept |
Get the number of detectors. | |
bool | empty () const noexcept |
Determine if the collection contains any detectors. | |
std::shared_ptr< Detector::InCameraBuilder > | operator[] (std::string const &name) const |
Implement the [name] operator. | |
std::shared_ptr< Detector::InCameraBuilder > | operator[] (int id) const |
Implement the [id] operator. | |
std::shared_ptr< Detector::InCameraBuilder > | get (std::string const &name, std::shared_ptr< Detector::InCameraBuilder > def=nullptr) const |
Retrieve a detector by name, or fall back to a default. | |
std::shared_ptr< Detector::InCameraBuilder > | get (int id, std::shared_ptr< Detector::InCameraBuilder > def=nullptr) const |
Retrieve a detector by ID, or fall back to a default. | |
Protected Member Functions | |
void | add (std::shared_ptr< Detector::InCameraBuilder > detector) |
Add a detector to the collection. | |
A helper class for creating and modifying cameras.
Camera and Camera::Builder have no direct inheritance relationship, but both inherit from different specializations of DetectorCollectionBase, so their container-of-detectors interfaces can generally be used the same way in both Python and templated C++.
|
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.
|
virtualdefaultnoexcept |
|
explicit |
|
explicit |
Construct a Builder with the state of an existing Camera.
Definition at line 206 of file Camera.cc.
|
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.
std::shared_ptr< Detector::InCameraBuilder > lsst::afw::cameraGeom::Camera::Builder::add | ( | std::string const & | name, |
int | id ) |
Add a new Detector with the given name and ID.
This is the only way to create a completely new detector (as opposed to a copy of an existing one), and it permanently sets that Detector's name and ID.
pex::exceptions::RuntimeError | Thrown if the ID and/or name conflict with those of detectors already in the collection. |
bool lsst::afw::cameraGeom::Camera::Builder::discardTransformFromFocalPlaneTo | ( | CameraSys const & | toSys | ) |
Remove any transformation from FOCAL_PLANE to the given coordinate system.
toSys | Coordinate system this transform returns points in. |
Definition at line 320 of file Camera.cc.
|
inlinenoexceptinherited |
Determine if the collection contains any detectors.
Definition at line 72 of file DetectorCollection.h.
std::shared_ptr< Camera const > lsst::afw::cameraGeom::Camera::Builder::finish | ( | ) | const |
Construct a new Camera from the state of the Builder.
Definition at line 246 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 |
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 |
|
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.
|
inline |
Definition at line 284 of file Camera.h.
|
inline |
Remove the detector with the given name or ID.
Wrapped as __delitem__
in Python.
pex::exceptions::NotFoundError | if no such detector exists. |
Definition at line 283 of file Camera.h.
|
inline |
|
inline |
Set the fully-qualified name of the Python class that provides this Camera's PupilFactory.
Definition at line 239 of file Camera.h.
void lsst::afw::cameraGeom::Camera::Builder::setTransformFromFocalPlaneTo | ( | CameraSys const & | toSys, |
std::shared_ptr< afw::geom::TransformPoint2ToPoint2 const > | transform ) |
Set the transformation from FOCAL_PLANE to the given coordinate system.
toSys | Coordinate system this transform returns points in. |
transform | Transform from FOCAL_PLANE to toSys . |
If a transform already exists from FOCAL_PLANE to toSys
, it is overwritten.
Definition at line 299 of file Camera.cc.
|
inlinenoexceptinherited |
Get the number of detectors.
Renamed to __len__
in Python.
Definition at line 67 of file DetectorCollection.h.