LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
TransformMap.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 /*
3  * Developed for the LSST Data Management System.
4  * This product includes software developed by the LSST Project
5  * (https://www.lsst.org).
6  * See the COPYRIGHT file at the top-level directory of this distribution
7  * for details of code ownership.
8  *
9  * This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program. If not, see <https://www.gnu.org/licenses/>.
21  */
22 #if !defined(LSST_AFW_CAMERAGEOM_TRANSFORMMAP_H)
23 #define LSST_AFW_CAMERAGEOM_TRANSFORMMAP_H
24 
25 #include <vector>
26 #include <unordered_map>
27 #include <memory>
28 
29 #include "boost/iterator/transform_iterator.hpp"
30 #include "astshim/FrameSet.h"
31 
34 #include "lsst/geom/Point.h"
36 
37 namespace lsst {
38 namespace afw {
39 namespace cameraGeom {
40 
63 private:
64 
65  // Functor for boost::transform_iterator: given an entry in a std::map or unordered_map, return the key
66  struct GetKey {
67  CameraSys const &operator()(std::pair<const CameraSys, int> const &p) const { return p.first; };
68  };
69 
71 
72 public:
73 
75  using CameraSysIterator = boost::transform_iterator<GetKey, CameraSysFrameIdMap::const_iterator>;
76 
80  struct Connection final {
84 
89  void reverse();
90  };
91 
106  CameraSys const &reference,
107  Transforms const &transforms
108  );
109 
126  CameraSys const &reference,
127  std::vector<Connection> const & connections
128  );
129 
134  TransformMap(TransformMap const &other) = delete;
135  TransformMap(TransformMap &&other) = delete;
136  TransformMap &operator=(TransformMap const &) = delete;
139 
140  ~TransformMap() noexcept;
141 
153  lsst::geom::Point2D transform(lsst::geom::Point2D const &point, CameraSys const &fromSys,
154  CameraSys const &toSys) const;
155 
161  std::vector<lsst::geom::Point2D> transform(std::vector<lsst::geom::Point2D> const &pointList,
162  CameraSys const &fromSys, CameraSys const &toSys) const;
163 
164  CameraSysIterator begin() const { return boost::make_transform_iterator(_frameIds.begin(), GetKey()); }
165 
166  CameraSysIterator end() const { return boost::make_transform_iterator(_frameIds.end(), GetKey()); }
167 
176  bool contains(CameraSys const &system) const noexcept;
177 
189  CameraSys const &toSys) const;
190 
196  size_t size() const noexcept;
197 
205  std::vector<Connection> getConnections() const;
206 
210  bool isPersistable() const noexcept override { return true; }
211 
212 private:
213 
214  // Helper class used in persistence.
215  class Factory;
216 
217  // Private ctor, only called by `make` static methods and `Factory`.
218  explicit TransformMap(std::vector<Connection> && connections);
219 
220  /*
221  * Return the internal frame ID corresponding to a coordinate system.
222  *
223  * @param system The system to convert.
224  * @return the ID by which the coordinate system can be found in transforms.
225  *
226  * @throws lsst::pex::exceptions::InvalidParameterError Thrown if `system`
227  * is not in frameIds.
228  *
229  * @exceptsafe Provides strong exception guarantee.
230  */
231  int _getFrame(CameraSys const &system) const;
232 
233  /*
234  * Return ast::Mapping that transforms between two coordinate systems.
235  *
236  * @param fromSys, toSys Coordinate systems between which to transform
237  * @return an invertible Mapping that converts from `fromSys` to `toSys`
238  *
239  * @throws lsst::pex::exceptions::InvalidParameterError Thrown if either
240  * `fromSys` or `toSys` is not supported.
241  */
242  std::shared_ptr<ast::Mapping const> _getMapping(CameraSys const &fromSys, CameraSys const &toSys) const;
243 
244  std::string getPersistenceName() const override;
245 
246  std::string getPythonModule() const override;
247 
248  void write(OutputArchiveHandle& handle) const override;
249 
250  /*
251  * Sequence of connections that define the edges of the graph.
252  * Ordered by distance from the reference system.
253  */
254  std::vector<Connection> _connections;
255 
256  // Stores information on all relationships between Transforms.
258 
259  /*
260  * Translates from LSST coordinate ID to AST frame ID.
261  *
262  * Must have exactly one mapping for each Frame in `transforms`.
263  */
264  CameraSysFrameIdMap _frameIds;
265 
266 };
267 
268 
269 std::ostream & operator<<(std::ostream & os, TransformMap::Connection const & connection);
270 
271 } // namespace cameraGeom
272 } // namespace afw
273 } // namespace lsst
274 
275 #endif
std::ostream * os
Definition: Schema.cc:557
T begin(T... args)
Camera coordinate system; used as a key in in TransformMap.
Definition: CameraSys.h:83
A registry of 2-dimensional coordinate transforms for a specific camera.
Definition: TransformMap.h:62
bool isPersistable() const noexcept override
TransformMaps should always be Persistable.
Definition: TransformMap.h:210
CameraSysIterator begin() const
Definition: TransformMap.h:164
static std::shared_ptr< TransformMap const > make(CameraSys const &reference, Transforms const &transforms)
Construct a TransformMap with all transforms relative to a single reference CameraSys.
TransformMap & operator=(TransformMap &&)=delete
boost::transform_iterator< GetKey, CameraSysFrameIdMap::const_iterator > CameraSysIterator
Definition: TransformMap.h:75
TransformMap(TransformMap const &other)=delete
CameraSysIterator end() const
Definition: TransformMap.h:166
size_t size() const noexcept
Get the number of supported coordinate systems.
bool contains(CameraSys const &system) const noexcept
Can this transform to and from the specified coordinate system?
TransformMap(TransformMap &&other)=delete
std::vector< Connection > getConnections() const
Return the sequence of connections used to construct this Transform.
std::shared_ptr< geom::TransformPoint2ToPoint2 > getTransform(CameraSys const &fromSys, CameraSys const &toSys) const
Get a Transform from one camera coordinate system to another.
TransformMap & operator=(TransformMap const &)=delete
lsst::geom::Point2D transform(lsst::geom::Point2D const &point, CameraSys const &fromSys, CameraSys const &toSys) const
Convert a point from one camera coordinate system to another.
A CRTP facade class for subclasses of Persistable.
Definition: Persistable.h:176
A base class for objects that can be persisted via afw::table::io Archive classes.
Definition: Persistable.h:74
io::OutputArchiveHandle OutputArchiveHandle
Definition: Persistable.h:108
T end(T... args)
std::ostream & operator<<(std::ostream &os, CameraSysPrefix const &detSysPrefix)
Definition: CameraSys.cc:47
std::string getPythonModule() const override
class[[deprecated("Removed with no replacement (but see lsst::afw::image::TransmissionCurve). Will be " "removed after v22.")]] FilterProperty final
Describe the properties of a Filter (e.g.
Definition: Filter.h:53
std::string getPersistenceName() const override
void write(OutputArchiveHandle &handle) const override
Point< double, 2 > Point2D
Definition: Point.h:324
A base class for image defects.
STL namespace.
Representation of a single edge in the graph defined by a TransformMap.
Definition: TransformMap.h:80
void reverse()
Reverse the connection, by swapping fromSys and toSys and inverting the transform.
std::shared_ptr< geom::TransformPoint2ToPoint2 const > transform
Definition: TransformMap.h:81