LSSTApplications  17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
LSSTDataManagementBasePackage
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"
31 #include "astshim/detail/utils.h"
32 #include "astshim/Object.h"
33 
34 namespace ast {
35 
36 class ParallelMap;
37 class SeriesMap;
38 
59 class Mapping : public Object {
60  friend class Object;
61 
62 public:
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 
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 
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 
396 protected:
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 
430 private:
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
A series compound mapping where the first Mapping is used to transform the coordinates of each point ...
Definition: SeriesMap.h:53
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
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
ndarray::Array< const double, 2, 2 > ConstArray2D
2D array of const double; typically used for lists of const points
Definition: base.h:46
virtual std::shared_ptr< Object > copyPolymorphic() const override
Return a deep copy of this object.
Definition: Mapping.h:410
Mapping(Mapping const &)=default
Copy constructor: make a deep copy.
AstObject const * getRawPtr() const
Get the raw AST pointer.
Definition: Object.h:292
table::Key< int > from
void setB(std::string const &attrib, bool value)
Set the value of an attribute as a bool.
Definition: Object.h:452
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
int getI(std::string const &attrib) const
Get the value of an attribute as an int.
Definition: Object.h:400
bool hasInverse() const
Is the inverse transform available?
Definition: Mapping.h:123
ndarray::Array< double, 2, 2 > Array2D
2D array of const double; typically used for lists of const points
Definition: base.h:42
AST wrapper classes and functions.
std::string getClassName() const
Get Class: the name of the class (e.g.
Definition: Object.h:139
py::object result
Definition: schema.cc:418
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
void assertOK(AstObject *rawPtr1=nullptr, AstObject *rawPtr2=nullptr)
Throw std::runtime_error if AST&#39;s state is bad.
Definition: base.cc:49
SeriesMap then(Mapping const &next) const
Return a series compound mapping this(first(input)) containing shallow copies of the original...
Definition: Mapping.cc:37
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
bool isInverted() const
Is this an inverted mapping?
Definition: Mapping.h:95
An abstract base class for objects which transform one set of coordinates to another.
Definition: Mapping.h:59
std::shared_ptr< Mapping > inverted() const
Get an inverse mapping.
Definition: Mapping.cc:41
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
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
Mapping(AstMapping *rawMap)
Construct a mapping from a pointer to a raw AST subclass of AstMapping.
Definition: Mapping.h:400
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
A parallel compound mapping where the first Mapping is used to transform the lower numbered coordinat...
Definition: ParallelMap.h:53
Mapping & operator=(Mapping const &)=delete
T data(T... args)
table::Key< int > to
bool getB(std::string const &attrib) const
Get the value of an attribute as a bool.
Definition: Object.h:348
bool getReport() const
Get Report: report transformed coordinates to stdout?
Definition: Mapping.h:105
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
T str(T... args)
std::shared_ptr< Mapping > copy() const
Return a deep copy of this object.
Definition: Mapping.h:72
T static_pointer_cast(T... args)
bool getIsLinear() const
Get IsLinear: is the Mapping linear?
Definition: Mapping.h:100
Array2D linearApprox(PointD const &lbnd, PointD const &ubnd, double tol) const
Compute a linear approximation to the forward transformation.
Definition: Mapping.cc:49
ParallelMap under(Mapping const &next) const
Return a parallel compound mapping containing shallow copies of the original.
Definition: Mapping.cc:39
T size(T... args)
void setReport(bool report)
Set Report: report transformed coordinates to stdout?
Definition: Mapping.h:225
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
int getNIn() const
Get NIn: the number of input axes.
Definition: Mapping.h:77
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
void assertEqual(T1 val1, std::string const &descr1, T2 val2, std::string const &descr2)
Definition: utils.h:48
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
bool hasForward() const
Is the forward transform available?
Definition: Mapping.h:114
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
Abstract base class for all AST objects.
Definition: Object.h:51
int getNOut() const
Get NOut: the number of output axes.
Definition: Mapping.h:82
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
virtual ~Mapping()
Definition: Mapping.h:63
std::ostream * os
Definition: Schema.cc:746