LSST Applications  21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
Camera.h
Go to the documentation of this file.
1 /*
2  * Developed for the LSST Data Management System.
3  * This product includes software developed by the LSST Project
4  * (https://www.lsst.org).
5  * See the COPYRIGHT file at the top-level directory of this distribution
6  * for details of code ownership.
7  *
8  * This program is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program. If not, see <https://www.gnu.org/licenses/>.
20  */
21 
22 #ifndef LSST_AFW_CAMERAGEOM_CAMERA_H
23 #define LSST_AFW_CAMERAGEOM_CAMERA_H
24 
25 #include <string>
26 #include <memory>
27 
31 
32 namespace lsst {
33 namespace afw {
34 namespace cameraGeom {
35 
36 
43 class Camera : public DetectorCollection, public table::io::PersistableFacade<Camera> {
44 public:
45 
46  class Builder;
47 
49 
50  // Camera is immutable, so it cannot be moveable. It is also always held
51  // by shared_ptr, so there is no good reason to copy it.
52  Camera(Camera const &) = delete;
53  Camera(Camera &&) = delete;
54 
55  // Camera is immutable, so it cannot be assignable.
56  Camera & operator=(Camera const &) = delete;
57  Camera & operator=(Camera &&) = delete;
58 
59  virtual ~Camera() noexcept;
60 
66  Camera::Builder rebuild() const;
67 
71  std::string getName() const { return _name; }
72 
76  std::string getPupilFactoryName() const { return _pupilFactoryName; }
77 
85  DetectorList findDetectors(lsst::geom::Point2D const &point, CameraSys const &cameraSys) const;
86 
96  CameraSys const &cameraSys) const;
97 
111  CameraSys const &toSys) const;
112 
120  std::shared_ptr<TransformMap const> getTransformMap() const noexcept { return _transformMap; }
121 
130  lsst::geom::Point2D transform(lsst::geom::Point2D const &point, CameraSys const &fromSys,
131  CameraSys const &toSys) const;
132 
142  CameraSys const &fromSys,
143  CameraSys const &toSys) const;
144 
148  bool isPersistable() const noexcept override { return true; }
149 
150 protected:
151 
152  void write(OutputArchiveHandle& handle) const override;
153 
154 private:
155 
156  // static methods below provide access to private methods of
157  // Detector::InCameraBuilder for use by Camera::Builder, because
158  // Detector::InCameraBuilder can only friend Camera.
159 
160  /*
161  * Create a new Detector::InCameraBuilder for a completely new Detector.
162  */
163  static std::shared_ptr<Detector::InCameraBuilder> makeDetectorBuilder(std::string const & name, int id);
164 
165  /*
166  * Create a new Detector::InCameraBuilder with the state of the given
167  * Detector.
168  */
169  static std::shared_ptr<Detector::InCameraBuilder> makeDetectorBuilder(Detector const & detector);
170 
171  /*
172  * Extract the sequence of TransformMap::Connections from a
173  * Detector::InCameraBuilder.
174  */
175  static std::vector<TransformMap::Connection> const & getDetectorBuilderConnections(
177  );
178 
179  // Deserialization factory.
180  class Factory;
181 
182  // Constructor used by Camera::Builder.
183  // Some arguments passed by value to make moves possible.
184  Camera(std::string const & name, DetectorList detectors,
186 
187  // Constructor used by persistence.
188  Camera(table::io::InputArchive const & archive, table::io::CatalogVector const & catalogs);
189 
190  std::string getPersistenceName() const override;
191 
192  // getPythonModule implementation inherited from DetectorCollection.
193 
194  std::string _name;
195  std::string _pupilFactoryName;
197 };
198 
199 
208 class Camera::Builder : public DetectorCollectionBase<Detector::InCameraBuilder> {
210 public:
211 
212  virtual ~Builder() noexcept;
213 
217  explicit Builder(std::string const &name);
218 
222  explicit Builder(Camera const & camera);
223 
227  std::shared_ptr<Camera const> finish() const;
228 
230  std::string getName() const { return _name; }
231 
233  void setName(std::string const & name) { _name = name; }
234 
236  std::string getPupilFactoryName() const { return _pupilFactoryName; }
237 
239  void setPupilFactoryName(std::string const & pupilFactoryName) { _pupilFactoryName = pupilFactoryName; }
240 
250  void setTransformFromFocalPlaneTo(CameraSys const & toSys,
252 
259  bool discardTransformFromFocalPlaneTo(CameraSys const & toSys);
260 
274 
276 
283  void remove(std::string const & name) { return BaseCollection::remove(name); }
284  void remove(int id) { return BaseCollection::remove(id); }
286 
287 private:
288  std::string _name;
289  std::string _pupilFactoryName;
291 };
292 
293 
294 } // namespace cameraGeom
295 } // namespace afw
296 } // namespace lsst
297 
298 #endif // LSST_AFW_CAMERAGEOM_CAMERA_H
table::Key< std::string > name
Definition: Amplifier.cc:116
table::Key< std::string > pupilFactoryName
Definition: Camera.cc:124
table::Key< int > transformMap
Definition: Camera.cc:125
table::Key< int > detector
A helper class for creating and modifying cameras.
Definition: Camera.h:208
void setPupilFactoryName(std::string const &pupilFactoryName)
Set the fully-qualified name of the Python class that provides this Camera's PupilFactory.
Definition: Camera.h:239
void setTransformFromFocalPlaneTo(CameraSys const &toSys, std::shared_ptr< afw::geom::TransformPoint2ToPoint2 const > transform)
Set the transformation from FOCAL_PLANE to the given coordinate system.
Definition: Camera.cc:299
std::string getName() const
Return the name of the camera.
Definition: Camera.h:230
std::string getPupilFactoryName() const
Return the fully-qualified name of the Python class that provides this Camera's PupilFactory.
Definition: Camera.h:236
std::shared_ptr< Detector::InCameraBuilder > add(std::string const &name, int id)
Add a new Detector with the given name and ID.
Definition: Camera.cc:329
void remove(std::string const &name)
Remove the detector with the given name or ID.
Definition: Camera.h:283
std::shared_ptr< Camera const > finish() const
Construct a new Camera from the state of the Builder.
Definition: Camera.cc:246
bool discardTransformFromFocalPlaneTo(CameraSys const &toSys)
Remove any transformation from FOCAL_PLANE to the given coordinate system.
Definition: Camera.cc:320
void setName(std::string const &name)
Set the name of the camera.
Definition: Camera.h:233
An immutable representation of a camera.
Definition: Camera.h:43
Camera(Camera const &)=delete
DetectorCollection::List DetectorList
Definition: Camera.h:48
Camera::Builder rebuild() const
Create a Camera::Builder object initialized with this camera's state.
Definition: Camera.cc:41
std::string getPupilFactoryName() const
Return the fully-qualified name of the Python class that provides this Camera's PupilFactory.
Definition: Camera.h:76
std::shared_ptr< TransformMap const > getTransformMap() const noexcept
Obtain the transform registry.
Definition: Camera.h:120
std::string getName() const
Return the name of the camera.
Definition: Camera.h:71
DetectorList findDetectors(lsst::geom::Point2D const &point, CameraSys const &cameraSys) const
Find the detectors that cover a point in any camera system.
Definition: Camera.cc:45
virtual ~Camera() noexcept
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.
Definition: Camera.cc:60
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.
Definition: Camera.cc:83
void write(OutputArchiveHandle &handle) const override
Write the object to one or more catalogs.
Definition: Camera.cc:149
Camera & operator=(Camera &&)=delete
Camera & operator=(Camera const &)=delete
bool isPersistable() const noexcept override
Cameras are always persistable.
Definition: Camera.h: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:78
Camera coordinate system; used as a key in in TransformMap.
Definition: CameraSys.h:83
A helper class that allows the properties of a detector to be modified in the course of modifying a f...
Definition: Detector.h:555
An abstract base class for collections of Detectors and specific subclasses thereof.
std::vector< std::shared_ptr< Detector const > > List
An immutable collection of Detectors that can be accessed by name or ID.
A representation of a detector in a mosaic camera.
Definition: Detector.h:185
A vector of catalogs used by Persistable.
Definition: CatalogVector.h:29
A multi-catalog archive object used to load table::io::Persistable objects.
Definition: InputArchive.h:31
A CRTP facade class for subclasses of Persistable.
Definition: Persistable.h:176
io::OutputArchiveHandle OutputArchiveHandle
Definition: Persistable.h:108
std::string getPersistenceName() const override
A base class for image defects.
STL namespace.