LSSTApplications  21.0.0+1b62c9342b,21.0.0+45a059f35e,21.0.0-1-ga51b5d4+ceb9cf20a3,21.0.0-2-g103fe59+4d13aff7ba,21.0.0-2-g1367e85+571a348718,21.0.0-2-g2909d54+45a059f35e,21.0.0-2-g45278ab+1b62c9342b,21.0.0-2-g4bc9b9f+ebfe466dad,21.0.0-2-g5242d73+571a348718,21.0.0-2-g54e2caa+07cebfb09d,21.0.0-2-g66bcc37+0b2c5d3971,21.0.0-2-g7f82c8f+08f1f55c36,21.0.0-2-g8dde007+5d1b9cb3f5,21.0.0-2-g8f08a60+73884b2cf5,21.0.0-2-ga326454+08f1f55c36,21.0.0-2-ga63a54e+458e82fbcd,21.0.0-2-gc738bc1+8c4731df06,21.0.0-2-gde069b7+5a8f2956b8,21.0.0-2-ge17e5af+571a348718,21.0.0-2-ge712728+cfa36ee5f9,21.0.0-2-gecfae73+e597808034,21.0.0-2-gfc62afb+571a348718,21.0.0-20-g4449a12+6d1341e0f3,21.0.0-22-gf0532904+1cd928f0c5,21.0.0-3-g4c5b185+c3794955c6,21.0.0-3-g6d51c4a+0b2c5d3971,21.0.0-3-g8076721+5adeb471db,21.0.0-3-gaa929c8+01f4b7cfca,21.0.0-3-gd222c45+afc8332dbe,21.0.0-4-g1383c07+0b2c5d3971,21.0.0-4-g3300ddd+1b62c9342b,21.0.0-4-g5873dc9+9a92674037,21.0.0-4-g8a80011+bd904b6426,21.0.0-5-gcff38f6+844b7f7b93,21.0.0-6-g463d161+18af5fb57b,21.0.0-6-gd3283ba+01f4b7cfca,21.0.0-8-g19111d86+8234efb485,21.0.0-9-g7bed000b9+c7d3cce47e,w.2021.04
LSSTDataManagementBasePackage
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 
34 #include "lsst/afw/geom/Endpoint.h"
36 
37 namespace lsst {
38 namespace afw {
39 namespace geom {
40 
41 class SkyWcs;
42 
66 template <class FromEndpoint, class ToEndpoint>
67 class Transform final : public table::io::PersistableFacade<Transform<FromEndpoint, ToEndpoint>>,
68  public table::io::Persistable {
69  // SkyWcs is a friend so it can call a protected Transform constructor
70  friend class SkyWcs;
71 
72 public:
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;
81  Transform &operator=(Transform &&) = 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 
135  std::shared_ptr<const ast::Mapping> getMapping() const { return _mapping; }
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 
267 protected:
271  explicit Transform(std::shared_ptr<ast::Mapping> mapping);
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 
282 private:
283  FromEndpoint _fromEndpoint;
285  ToEndpoint _toEndpoint;
286 };
287 
295 template <class FromEndpoint, class ToEndpoint>
296 std::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
Persistable.h
lsst::afw::geom::Transform::write
void write(OutputArchiveHandle &handle) const override
Write the object to one or more catalogs.
Definition: Transform.cc:241
lsst::afw::geom::Transform::~Transform
~Transform() override=default
lsst::afw::geom::Transform::operator=
Transform & operator=(Transform const &)=delete
astshim.fitsChanContinued.next
def next(self)
Definition: fitsChanContinued.py:105
lsst::afw::geom::Transform::hasInverse
bool hasInverse() const
Test if this method has an inverse transform.
Definition: Transform.h:125
lsst::afw::geom::Transform::operator=
Transform & operator=(Transform &&)=delete
lsst::afw::geom::Transform::getFromEndpoint
FromEndpoint getFromEndpoint() const
Get the "from" endpoint.
Definition: Transform.h:130
ast::FrameSet
A FrameSet consists of a set of one or more Frames (which describe coordinate systems),...
Definition: FrameSet.h:99
std::string
STL class.
std::shared_ptr< const ast::Mapping >
lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >::FromArray
typename FromEndpoint::Array FromArray
Definition: Transform.h:73
lsst::afw::geom::Transform
Transform LSST spatial data, such as lsst::geom::Point2D and lsst::geom::SpherePoint,...
Definition: Transform.h:68
ast::Mapping
An abstract base class for objects which transform one set of coordinates to another.
Definition: Mapping.h:59
lsst::afw::geom::Transform::hasForward
bool hasForward() const
Test if this method has a forward transform.
Definition: Transform.h:118
lsst::afw::geom::Transform::getShortClassName
static std::string getShortClassName()
Return a short version of the class name with no punctuation.
Definition: Transform.cc:138
lsst::afw
Definition: imageAlgorithm.dox:1
lsst::afw::geom::Transform::applyForward
ToPoint applyForward(FromPoint const &point) const
Transform one point in the forward direction ("from" to "to")
Definition: Transform.cc:79
lsst::afw::geom::Transform::getToEndpoint
ToEndpoint getToEndpoint() const
Get the "to" endpoint.
Definition: Transform.h:140
lsst::afw::geom::SkyWcs
A 2-dimensional celestial WCS that transform pixels to ICRS RA/Dec, using the LSST standard for pixel...
Definition: SkyWcs.h:117
Endpoint.h
ast::Mapping::hasInverse
bool hasInverse() const
Is the inverse transform available?
Definition: Mapping.h:123
astshim.h
lsst::afw::geom::Transform::getPythonModule
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
ast::Mapping::hasForward
bool hasForward() const
Is the forward transform available?
Definition: Mapping.h:114
lsst::afw::geom::Transform::writeStream
void writeStream(std::ostream &os) const
Serialize this Transform to an output stream.
Definition: Transform.cc:158
lsst::afw::geom::Transform::Transform
Transform(Transform &&)=default
lsst::afw::geom::operator<<
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:240
lsst::afw::geom::Transform::isPersistable
bool isPersistable() const noexcept override
Whether the Transform is persistable via afw::table::io (always true).
Definition: Transform.h:265
lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >::ToArray
typename ToEndpoint::Array ToArray
Definition: Transform.h:75
std::ostream
STL class.
lsst::afw::geom::Transform::readStream
static std::shared_ptr< Transform< FromEndpoint, ToEndpoint > > readStream(std::istream &is)
Deserialize a Transform of this type from an input stream.
Definition: Transform.cc:145
x
double x
Definition: ChebyshevBoundedField.cc:277
frameSet
table::Key< table::Array< std::uint8_t > > frameSet
Definition: TransformBoundedField.cc:91
lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >::FromPoint
typename FromEndpoint::Point FromPoint
Definition: Transform.h:74
lsst.pipe.tasks.cli.cmd.commands.str
str
Definition: commands.py:50
lsst::afw::geom::Transform::getPersistenceName
std::string getPersistenceName() const override
Return the unique name used to persist this object and look up its factory.
Definition: Transform.h:274
lsst::afw::geom::Transform::readString
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:151
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::afw::geom::Transform::getMapping
std::shared_ptr< const ast::Mapping > getMapping() const
Get the contained mapping.
Definition: Transform.h:135
lsst::geom
Definition: AffineTransform.h:36
lsst::afw::table::io::Persistable
A base class for objects that can be persisted via afw::table::io Archive classes.
Definition: Persistable.h:74
os
std::ostream * os
Definition: Schema.cc:746
lsst::afw::geom::Transform::Transform
Transform(Transform const &)=default
lsst::afw::geom::Transform::inverted
std::shared_ptr< Transform< ToEndpoint, FromEndpoint > > inverted() const
The inverse of this Transform.
Definition: Transform.cc:111
lsst::afw::geom::Transform::writeString
std::string writeString() const
Serialize this Transform to a string, using the same format as writeStream.
Definition: Transform.cc:163
lsst::afw::table::io::PersistableFacade
A CRTP facade class for subclasses of Persistable.
Definition: Persistable.h:176
lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >::ToPoint
typename ToEndpoint::Point ToPoint
Definition: Transform.h:76
transform
table::Key< int > transform
Definition: TransformMap.cc:299
lsst::afw::geom::Transform::getJacobian
Eigen::MatrixXd getJacobian(FromPoint const &x) const
The Jacobian matrix of this Transform.
Definition: Transform.cc:123
lsst::afw::geom::Transform::applyInverse
FromPoint applyInverse(ToPoint const &point) const
Transform one point in the inverse direction ("to" to "from")
Definition: Transform.cc:95
std::istream
STL class.
lsst::afw::table::io::Persistable::OutputArchiveHandle
io::OutputArchiveHandle OutputArchiveHandle
Definition: Persistable.h:108
lsst::afw::geom::Transform::then
std::shared_ptr< Transform< FromEndpoint, NextToEndpoint > > then(Transform< ToEndpoint, NextToEndpoint > const &next, bool simplify=true) const
Concatenate two Transforms.
Definition: Transform.cc:171