LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
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
72 std::shared_ptr<Mapping> copy() const { return std::static_pointer_cast<Mapping>(copyPolymorphic()); }
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.
410 virtual std::shared_ptr<Object> copyPolymorphic() const override {
411 return std::static_pointer_cast<Mapping>(copyImpl<Mapping, AstMapping>());
412 }
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
py::object result
Definition _schema.cc:429
std::ostream * os
Definition Schema.cc:557
table::Key< int > to
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
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
Abstract base class for all AST objects.
Definition Object.h:51
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
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
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