LSST Applications g0b6bd0c080+a72a5dd7e6,g1182afd7b4+2a019aa3bb,g17e5ecfddb+2b8207f7de,g1d67935e3f+06cf436103,g38293774b4+ac198e9f13,g396055baef+6a2097e274,g3b44f30a73+6611e0205b,g480783c3b1+98f8679e14,g48ccf36440+89c08d0516,g4b93dc025c+98f8679e14,g5c4744a4d9+a302e8c7f0,g613e996a0d+e1c447f2e0,g6c8d09e9e7+25247a063c,g7271f0639c+98f8679e14,g7a9cd813b8+124095ede6,g9d27549199+a302e8c7f0,ga1cf026fa3+ac198e9f13,ga32aa97882+7403ac30ac,ga786bb30fb+7a139211af,gaa63f70f4e+9994eb9896,gabf319e997+ade567573c,gba47b54d5d+94dc90c3ea,gbec6a3398f+06cf436103,gc6308e37c7+07dd123edb,gc655b1545f+ade567573c,gcc9029db3c+ab229f5caf,gd01420fc67+06cf436103,gd877ba84e5+06cf436103,gdb4cecd868+6f279b5b48,ge2d134c3d5+cc4dbb2e3f,ge448b5faa6+86d1ceac1d,gecc7e12556+98f8679e14,gf3ee170dca+25247a063c,gf4ac96e456+ade567573c,gf9f5ea5b4d+ac198e9f13,gff490e6085+8c2580be5c,w.2022.27
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
37namespace lsst {
38namespace afw {
39namespace cameraGeom {
40
62class TransformMap final : public table::io::PersistableFacade<TransformMap>, public table::io::Persistable {
63private:
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
72public:
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;
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
212private:
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
269std::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
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.
bool isPersistable() const noexcept override
TransformMaps should always be Persistable.
Definition: TransformMap.h:210
TransformMap & operator=(TransformMap const &)=delete
CameraSysIterator begin() const
Definition: TransformMap.h:164
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
TransformMap & operator=(TransformMap &&)=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.
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
Point< double, 2 > Point2D
Definition: Point.h:324
def write(self, patchRef, catalog)
Write the output.
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