LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
LSST Data Management Base Package
Loading...
Searching...
No Matches
Mapping.h
Go to the documentation of this file.
1/*
2 * LSST Data Management System
3 * Copyright 2017 AURA/LSST.
4 *
5 * This product includes software developed by the
6 * LSST Project (http://www.lsst.org/).
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 LSST License Statement and
19 * the GNU General Public License along with this program. If not,
20 * see <https://www.lsstcorp.org/LegalNotices/>.
21 */
22#ifndef ASTSHIM_MAPPING_H
23#define ASTSHIM_MAPPING_H
24
25#include <memory>
26#include <vector>
27
28#include "ndarray.h"
29
30#include "astshim/base.h"
32#include "astshim/Object.h"
33
34namespace ast {
35
36class ParallelMap;
37class SeriesMap;
38
59class Mapping : public Object {
60 friend class Object;
61
62public:
63 virtual ~Mapping() {}
64
66 Mapping(Mapping const &) = default;
67 Mapping(Mapping &&) = default;
68 Mapping &operator=(Mapping const &) = delete;
69 Mapping &operator=(Mapping &&) = default;
70
73
77 int getNIn() const { return getI("NIn"); }
78
82 int getNOut() const { return getI("NOut"); }
83
87 bool getIsSimple() const { return getI("IsSimple"); }
88
95 bool isInverted() const { return getB("Invert"); }
96
100 bool getIsLinear() const { return getB("IsLinear"); }
101
105 bool getReport() const { return getB("Report"); }
106
114 bool hasForward() const { return getB("TranForward"); }
115
123 bool hasInverse() const { return getB("TranInverse"); }
124
139
164 Array2D linearApprox(PointD const &lbnd, PointD const &ubnd, double tol) const;
165
177 SeriesMap then(Mapping const &next) const;
178
195 ParallelMap under(Mapping const &next) const;
196
215 double rate(PointD const &at, int ax1, int ax2) const {
216 detail::assertEqual(at.size(), "at.size", static_cast<std::size_t>(getNIn()), "nIn");
217 double result = astRate(getRawPtr(), const_cast<double *>(at.data()), ax1, ax2);
218 assertOK();
219 return result;
220 }
221
225 void setReport(bool report) { setB("Report", report); }
226
249 AstObject *rawSimpMap = reinterpret_cast<AstObject *>(astSimplify(getRawPtr()));
250 assertOK(rawSimpMap);
251 return Object::fromAstObject<Mapping>(rawSimpMap, true);
252 }
253
260 void applyForward(ConstArray2D const &from, Array2D const &to) const { _tran(from, true, to); }
261
268 Array2D applyForward(ConstArray2D const &from) const {
269 Array2D to = ndarray::allocate(getNOut(), from.getSize<1>());
270 _tran(from, true, to);
271 return to;
272 }
273
281 auto fromArr = arrayFromVector(from, getNIn());
282 std::vector<double> to(fromArr.getSize<1>() * getNOut());
283 auto toArr = arrayFromVector(to, getNOut());
284 _tran(fromArr, true, toArr);
285 return to;
286 }
287
294 void applyInverse(ConstArray2D const &from, Array2D const &to) const { _tran(from, false, to); }
295
302 Array2D applyInverse(ConstArray2D const &from) const {
303 Array2D to = ndarray::allocate(getNIn(), from.getSize<1>());
304 _tran(from, false, to);
305 return to;
306 }
307
315 auto fromArr = arrayFromVector(from, getNOut());
316 std::vector<double> to(fromArr.getSize<1>() * getNIn());
317 auto toArr = arrayFromVector(to, getNIn());
318 _tran(fromArr, false, toArr);
319 return to;
320 }
321
358 void tranGridForward(PointI const &lbnd, PointI const &ubnd, double tol, int maxpix,
359 Array2D const &to) const {
360 _tranGrid(lbnd, ubnd, tol, maxpix, true, to);
361 }
362
369 Array2D tranGridForward(PointI const &lbnd, PointI const &ubnd, double tol, int maxpix, int nPts) const {
370 Array2D to = ndarray::allocate(nPts, getNOut());
371 _tranGrid(lbnd, ubnd, tol, maxpix, true, to);
372 return to;
373 }
374
380 void tranGridInverse(PointI const &lbnd, PointI const &ubnd, double tol, int maxpix,
381 Array2D const &to) const {
382 _tranGrid(lbnd, ubnd, tol, maxpix, false, to);
383 }
384
390 Array2D tranGridInverse(PointI const &lbnd, PointI const &ubnd, double tol, int maxpix, int nPts) const {
391 Array2D to = ndarray::allocate(nPts, getNIn());
392 _tranGrid(lbnd, ubnd, tol, maxpix, false, to);
393 return to;
394 }
395
396protected:
400 explicit Mapping(AstMapping *rawMap) : Object(reinterpret_cast<AstObject *>(rawMap)) {
401 assertOK();
402 if (!astIsAMapping(getRawPtr())) {
404 os << "this is a " << getClassName() << ", which is not a Mapping";
405 throw std::invalid_argument(os.str());
406 }
407 }
408
409 // Protected implementation of deep-copy.
413
427 template <typename Class>
428 std::shared_ptr<Class> decompose(int i, bool copy) const;
429
430private:
438 void _tran(ConstArray2D const &from, bool doForward, Array2D const &to) const;
439
443 void _tranGrid(PointI const &lbnd, PointI const &ubnd, double tol, int maxpix, bool doForward,
444 Array2D const &to) const;
445};
446
447} // namespace ast
448
449#endif
An abstract base class for objects which transform one set of coordinates to another.
Definition Mapping.h:59
friend class Object
Definition Mapping.h:60
bool hasForward() const
Is the forward transform available?
Definition Mapping.h:114
std::shared_ptr< Mapping > simplified() const
Return a simplied version of the mapping (which may be a compound Mapping such as a CmpMap).
Definition Mapping.h:248
bool isInverted() const
Is this an inverted mapping?
Definition Mapping.h:95
void tranGridInverse(PointI const &lbnd, PointI const &ubnd, double tol, int maxpix, Array2D const &to) const
Transform a grid of points in the inverse direction.
Definition Mapping.h:380
std::shared_ptr< Mapping > copy() const
Return a deep copy of this object.
Definition Mapping.h:72
Array2D tranGridForward(PointI const &lbnd, PointI const &ubnd, double tol, int maxpix, int nPts) const
Transform a grid of points in the inverse direction, returning the results as a new Array2D.
Definition Mapping.h:369
void tranGridForward(PointI const &lbnd, PointI const &ubnd, double tol, int maxpix, Array2D const &to) const
Transform a grid of points in the forward direction.
Definition Mapping.h:358
SeriesMap then(Mapping const &next) const
Return a series compound mapping this(first(input)) containing shallow copies of the original.
Definition Mapping.cc:37
Array2D applyForward(ConstArray2D const &from) const
Perform a forward transformation on a 2-D array, returning the results as a new array.
Definition Mapping.h:268
bool getReport() const
Get Report: report transformed coordinates to stdout?
Definition Mapping.h:105
Mapping(Mapping const &)=default
Copy constructor: make a deep copy.
void applyInverse(ConstArray2D const &from, Array2D const &to) const
Perform an inverse transformation on a 2-D array, putting the results into a pre-allocated 2-D array.
Definition Mapping.h:294
Mapping(AstMapping *rawMap)
Construct a mapping from a pointer to a raw AST subclass of AstMapping.
Definition Mapping.h:400
void applyForward(ConstArray2D const &from, Array2D const &to) const
Perform a forward transformation on 2-D array, putting the results into a pre-allocated 2-D array.
Definition Mapping.h:260
std::shared_ptr< Class > decompose(int i, bool copy) const
Return a deep copy of one of the two component mappings.
Definition Mapping.cc:64
ParallelMap under(Mapping const &next) const
Return a parallel compound mapping containing shallow copies of the original.
Definition Mapping.cc:39
Array2D linearApprox(PointD const &lbnd, PointD const &ubnd, double tol) const
Compute a linear approximation to the forward transformation.
Definition Mapping.cc:49
bool getIsSimple() const
Get IsSimple: has the mapping been simplified?
Definition Mapping.h:87
Array2D applyInverse(ConstArray2D const &from) const
Perform an inverse transformation on a 2-D array, returning the results as a new 2-D array.
Definition Mapping.h:302
Mapping & operator=(Mapping const &)=delete
Array2D tranGridInverse(PointI const &lbnd, PointI const &ubnd, double tol, int maxpix, int nPts) const
Transform a grid of points in the inverse direction.
Definition Mapping.h:390
double rate(PointD const &at, int ax1, int ax2) const
Evaluate the rate of change of the Mapping with respect to a specified input, at a specified position...
Definition Mapping.h:215
bool getIsLinear() const
Get IsLinear: is the Mapping linear?
Definition Mapping.h:100
int getNOut() const
Get NOut: the number of output axes.
Definition Mapping.h:82
virtual ~Mapping()
Definition Mapping.h:63
Mapping(Mapping &&)=default
void setReport(bool report)
Set Report: report transformed coordinates to stdout?
Definition Mapping.h:225
std::vector< double > applyInverse(std::vector< double > const &from) const
Perform an inverse transformation on a vector, returning the results as a new vector.
Definition Mapping.h:314
virtual std::shared_ptr< Object > copyPolymorphic() const override
Return a deep copy of this object.
Definition Mapping.h:410
bool hasInverse() const
Is the inverse transform available?
Definition Mapping.h:123
int getNIn() const
Get NIn: the number of input axes.
Definition Mapping.h:77
std::shared_ptr< Mapping > inverted() const
Get an inverse mapping.
Definition Mapping.cc:41
std::vector< double > applyForward(std::vector< double > const &from) const
Perform a forward transformation on a vector, returning the results as a new vector.
Definition Mapping.h:280
Mapping & operator=(Mapping &&)=default
static std::shared_ptr< Class > fromAstObject(AstObject *rawObj, bool copy)
Given a bare AST object pointer return a shared pointer to an ast::Object of the correct type.
Definition Object.cc:138
std::shared_ptr< T > copyImpl() const
Implementation of deep copy.
Definition Object.h:320
std::string getClassName() const
Get Class: the name of the class (e.g.
Definition Object.h:139
bool getB(std::string const &attrib) const
Get the value of an attribute as a bool.
Definition Object.h:348
int getI(std::string const &attrib) const
Get the value of an attribute as an int.
Definition Object.cc:178
void setB(std::string const &attrib, bool value)
Set the value of an attribute as a bool.
Definition Object.h:448
AstObject const * getRawPtr() const
Get the raw AST pointer.
Definition Object.h:292
A parallel compound mapping where the first Mapping is used to transform the lower numbered coordinat...
Definition ParallelMap.h:53
A series compound mapping where the first Mapping is used to transform the coordinates of each point ...
Definition SeriesMap.h:53
T data(T... args)
void assertEqual(T1 val1, std::string const &descr1, T2 val2, std::string const &descr2)
Definition utils.h:48
AST wrapper classes and functions.
ndarray::Array< const double, 2, 2 > ConstArray2D
2D array of const double; typically used for lists of const points
Definition base.h:46
std::vector< int > PointI
Vector of ints; typically used for the bounds of Mapping.tranGridForward and inverse.
Definition base.h:50
std::vector< double > PointD
Vector of double; used for bounds, points.
Definition base.h:57
ndarray::Array< double, 2, 2 > Array2D
2D array of const double; typically used for lists of const points
Definition base.h:42
void assertOK(AstObject *rawPtr1=nullptr, AstObject *rawPtr2=nullptr)
Throw std::runtime_error if AST's state is bad.
Definition base.cc:49
ConstArray2D arrayFromVector(std::vector< double > const &vec, int nAxes)
Reshape a vector as a 2-dimensional array that shares the same memory.
Definition base.cc:65
T static_pointer_cast(T... args)
T size(T... args)
T str(T... args)