LSST Applications g0dd1f4853b+10f999ec6a,g1635faa6d4+b976e9dbb0,g1653933729+a8ce1bb630,g28da252d5a+20f909b684,g2bbee38e9b+de1ea1445d,g2bc492864f+de1ea1445d,g2cdde0e794+c2c89b37c4,g3156d2b45e+41e33cbcdc,g347aa1857d+de1ea1445d,g35bb328faa+a8ce1bb630,g3a166c0a6a+de1ea1445d,g3e281a1b8c+9f2c4e2fc3,g414038480c+077ccc18e7,g41af890bb2+fa1be12bb0,g531c6476d5+b4b02c216c,g5fbc88fb19+17cd334064,g781aacb6e4+a8ce1bb630,g7ab3e175f3+14b8e72808,g80478fca09+f5ec7b2bf0,g82479be7b0+0c309e1a1e,g858d7b2824+b4b02c216c,g9125e01d80+a8ce1bb630,ga5288a1d22+46505f0d18,gae0086650b+a8ce1bb630,gb58c049af0+d64f4d3760,gb9c6c11c1e+5a4033fdfe,gc28159a63d+de1ea1445d,gcf0d15dbbd+e25110243b,gd3624f51fd+6b4a7374c1,gda3e153d99+b4b02c216c,gda6a2b7d83+e25110243b,gdaeeff99f8+1711a396fd,ge2409df99d+4338270cf0,ge33fd446bb+b4b02c216c,ge79ae78c31+de1ea1445d,gee3d5c6094+3b2e26a966,gf0baf85859+147a0692ba,gf3967379c6+02b11634a5,w.2024.45
LSST Data Management Base Package
Loading...
Searching...
No Matches
Transform.h
Go to the documentation of this file.
1// -*- lsst-c++ -*-
2/*
3 * LSST Data Management System
4 * Copyright 2008-2017 LSST Corporation.
5 *
6 * This product includes software developed by the
7 * LSST Project (http://www.lsst.org/).
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 LSST License Statement and
20 * the GNU General Public License along with this program. If not,
21 * see <http://www.lsstcorp.org/LegalNotices/>.
22 */
23
24#ifndef LSST_AFW_GEOM_TRANSFORM_H
25#define LSST_AFW_GEOM_TRANSFORM_H
26
27#include <memory>
28#include <vector>
29
30#include "astshim.h"
31#include "Eigen/Core"
32#include "ndarray.h"
33
36
37namespace lsst {
38namespace afw {
39namespace geom {
40
41class SkyWcs;
42
66template <class FromEndpoint, class ToEndpoint>
67class Transform final : public table::io::PersistableFacade<Transform<FromEndpoint, ToEndpoint>>,
69 // SkyWcs is a friend so it can call a protected Transform constructor
70 friend class SkyWcs;
71
72public:
73 using FromArray = typename FromEndpoint::Array;
74 using FromPoint = typename FromEndpoint::Point;
75 using ToArray = typename ToEndpoint::Array;
76 using ToPoint = typename ToEndpoint::Point;
77
78 Transform(Transform const &) = default;
79 Transform(Transform &&) = default;
80 Transform &operator=(Transform const &) = delete;
82 ~Transform() override = default;
83
91 explicit Transform(ast::Mapping const &mapping, bool simplify = true);
92
111 explicit Transform(ast::FrameSet const &frameSet, bool simplify = true);
112
118 bool hasForward() const { return _mapping->hasForward(); }
119
125 bool hasInverse() const { return _mapping->hasInverse(); }
126
130 FromEndpoint getFromEndpoint() const { return _fromEndpoint; }
131
136
140 ToEndpoint getToEndpoint() const { return _toEndpoint; }
141
145 ToPoint applyForward(FromPoint const &point) const;
146
154 ToArray applyForward(FromArray const &array) const;
155
159 FromPoint applyInverse(ToPoint const &point) const;
160
168 FromArray applyInverse(ToArray const &array) const;
169
179
201 Eigen::MatrixXd getJacobian(FromPoint const &x) const;
202
223 template <class NextToEndpoint>
225 Transform<ToEndpoint, NextToEndpoint> const &next, bool simplify = true) const;
226
236
243
246
259 void writeStream(std::ostream &os) const;
260
262 std::string writeString() const;
263
265 bool isPersistable() const noexcept override { return true; }
266
267protected:
272
273 // implement afw::table::io::Persistable interface
274 std::string getPersistenceName() const override { return getShortClassName(); }
275
276 // implement afw::table::io::Persistable interface
277 std::string getPythonModule() const override { return "lsst.afw.geom"; }
278
279 // implement afw::table::io::Persistable interface
280 void write(OutputArchiveHandle &handle) const override;
281
282private:
283 FromEndpoint _fromEndpoint;
285 ToEndpoint _toEndpoint;
286};
287
295template <class FromEndpoint, class ToEndpoint>
296std::ostream &operator<<(std::ostream &os, Transform<FromEndpoint, ToEndpoint> const &transform);
297
298// typedefs for the most common transforms; names match Python names
299
303
304} // namespace geom
305} // namespace afw
306} // namespace lsst
307
308#endif
table::Key< table::Array< std::uint8_t > > frameSet
A FrameSet consists of a set of one or more Frames (which describe coordinate systems),...
Definition FrameSet.h:99
An abstract base class for objects which transform one set of coordinates to another.
Definition Mapping.h:59
bool hasForward() const
Is the forward transform available?
Definition Mapping.h:114
bool hasInverse() const
Is the inverse transform available?
Definition Mapping.h:123
A 2-dimensional celestial WCS that transform pixels to ICRS RA/Dec, using the LSST standard for pixel...
Definition SkyWcs.h:117
Transform LSST spatial data, such as lsst::geom::Point2D and lsst::geom::SpherePoint,...
Definition Transform.h:68
~Transform() override=default
typename FromEndpoint::Point FromPoint
Definition Transform.h:74
std::shared_ptr< const ast::Mapping > getMapping() const
Get the contained mapping.
Definition Transform.h:135
FromEndpoint getFromEndpoint() const
Get the "from" endpoint.
Definition Transform.h:130
static std::shared_ptr< Transform< FromEndpoint, ToEndpoint > > readStream(std::istream &is)
Deserialize a Transform of this type from an input stream.
Definition Transform.cc:144
Transform(Transform &&)=default
std::string getPersistenceName() const override
Return the unique name used to persist this object and look up its factory.
Definition Transform.h:274
FromPoint applyInverse(ToPoint const &point) const
Transform one point in the inverse direction ("to" to "from")
typename ToEndpoint::Array ToArray
Definition Transform.h:75
static std::string getShortClassName()
Return a short version of the class name with no punctuation.
Definition Transform.cc:137
std::shared_ptr< Transform< ToEndpoint, FromEndpoint > > inverted() const
The inverse of this Transform.
Definition Transform.cc:110
ToEndpoint getToEndpoint() const
Get the "to" endpoint.
Definition Transform.h:140
bool hasInverse() const
Test if this method has an inverse transform.
Definition Transform.h:125
typename ToEndpoint::Point ToPoint
Definition Transform.h:76
bool isPersistable() const noexcept override
Whether the Transform is persistable via afw::table::io (always true).
Definition Transform.h:265
void write(OutputArchiveHandle &handle) const override
Write the object to one or more catalogs.
Definition Transform.cc:240
bool hasForward() const
Test if this method has a forward transform.
Definition Transform.h:118
Eigen::MatrixXd getJacobian(FromPoint const &x) const
The Jacobian matrix of this Transform.
Definition Transform.cc:122
std::string writeString() const
Serialize this Transform to a string, using the same format as writeStream.
Definition Transform.cc:162
typename FromEndpoint::Array FromArray
Definition Transform.h:73
FromArray applyInverse(ToArray const &array) const
Transform an array of points in the inverse direction ("to" to "from")
std::string getPythonModule() const override
Return the fully-qualified Python module that should be imported to guarantee that its factory is reg...
Definition Transform.h:277
Transform(Transform const &)=default
ToArray applyForward(FromArray const &array) const
Transform an array of points in the forward direction ("from" to "to")
Transform & operator=(Transform const &)=delete
static std::shared_ptr< Transform< FromEndpoint, ToEndpoint > > readString(std::string &str)
Deserialize a Transform of this type from a string, using the same format as readStream.
Definition Transform.cc:150
std::shared_ptr< Transform< FromEndpoint, NextToEndpoint > > then(Transform< ToEndpoint, NextToEndpoint > const &next, bool simplify=true) const
Concatenate two Transforms.
Definition Transform.cc:170
Transform & operator=(Transform &&)=delete
ToPoint applyForward(FromPoint const &point) const
Transform one point in the forward direction ("from" to "to")
void writeStream(std::ostream &os) const
Serialize this Transform to an output stream.
Definition Transform.cc:157
A CRTP facade class for subclasses of Persistable.
A base class for objects that can be persisted via afw::table::io Archive classes.
Definition Persistable.h:74
io::OutputArchiveHandle OutputArchiveHandle
std::ostream & operator<<(std::ostream &os, GenericEndpoint const &endpoint)
Print "GenericEndpoint(_n_)" to the ostream where _n_ is the number of axes, e.g. "GenericAxes(4)".
Definition Endpoint.cc:239