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
Loading...
Searching...
No Matches
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
32namespace lsst {
33namespace afw {
34namespace cameraGeom {
35
36
44public:
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
150protected:
151
152 void write(OutputArchiveHandle& handle) const override;
153
154private:
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(
176 Detector::InCameraBuilder const & detector
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
208class Camera::Builder : public DetectorCollectionBase<Detector::InCameraBuilder> {
210public:
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
240
250 void setTransformFromFocalPlaneTo(CameraSys const & toSys,
252
260
274
276
283 void remove(std::string const & name) { return BaseCollection::remove(name); }
284 void remove(int id) { return BaseCollection::remove(id); }
286
287private:
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 > transform
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
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
std::shared_ptr< Camera const > finish() const
Construct a new Camera from the state of the Builder.
Definition Camera.cc:246
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::shared_ptr< TransformMap const > getTransformMap() const noexcept
Obtain the transform registry.
Definition Camera.h:120
std::string getPupilFactoryName() const
Return the fully-qualified name of the Python class that provides this Camera's PupilFactory.
Definition Camera.h:76
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
std::string getPersistenceName() const override
Return the unique name used to persist this object and look up its factory.
Definition Camera.cc:201
Camera & operator=(Camera &&)=delete
Camera & operator=(Camera const &)=delete
void write(OutputArchiveHandle &handle) const override
Write the object to one or more catalogs.
Definition Camera.cc:149
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< T > > 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.
A multi-catalog archive object used to load table::io::Persistable objects.
A CRTP facade class for subclasses of Persistable.
io::OutputArchiveHandle OutputArchiveHandle
STL namespace.