LSSTApplications  19.0.0-14-gb0260a2+72efe9b372,20.0.0+7927753e06,20.0.0+8829bf0056,20.0.0+995114c5d2,20.0.0+b6f4b2abd1,20.0.0+bddc4f4cbe,20.0.0-1-g253301a+8829bf0056,20.0.0-1-g2b7511a+0d71a2d77f,20.0.0-1-g5b95a8c+7461dd0434,20.0.0-12-g321c96ea+23efe4bbff,20.0.0-16-gfab17e72e+fdf35455f6,20.0.0-2-g0070d88+ba3ffc8f0b,20.0.0-2-g4dae9ad+ee58a624b3,20.0.0-2-g61b8584+5d3db074ba,20.0.0-2-gb780d76+d529cf1a41,20.0.0-2-ged6426c+226a441f5f,20.0.0-2-gf072044+8829bf0056,20.0.0-2-gf1f7952+ee58a624b3,20.0.0-20-geae50cf+e37fec0aee,20.0.0-25-g3dcad98+544a109665,20.0.0-25-g5eafb0f+ee58a624b3,20.0.0-27-g64178ef+f1f297b00a,20.0.0-3-g4cc78c6+e0676b0dc8,20.0.0-3-g8f21e14+4fd2c12c9a,20.0.0-3-gbd60e8c+187b78b4b8,20.0.0-3-gbecbe05+48431fa087,20.0.0-38-ge4adf513+a12e1f8e37,20.0.0-4-g97dc21a+544a109665,20.0.0-4-gb4befbc+087873070b,20.0.0-4-gf910f65+5d3db074ba,20.0.0-5-gdfe0fee+199202a608,20.0.0-5-gfbfe500+d529cf1a41,20.0.0-6-g64f541c+d529cf1a41,20.0.0-6-g9a5b7a1+a1cd37312e,20.0.0-68-ga3f3dda+5fca18c6a4,20.0.0-9-g4aef684+e18322736b,w.2020.45
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 
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 
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
ast::Mapping::operator=
Mapping & operator=(Mapping &&)=default
ast::Mapping::Mapping
Mapping(Mapping &&)=default
astshim.fitsChanContinued.next
def next(self)
Definition: fitsChanContinued.py:105
from
table::Key< int > from
Definition: TransformMap.cc:348
ast::Object::getB
bool getB(std::string const &attrib) const
Get the value of an attribute as a bool.
Definition: Object.h:348
ast::Mapping::tranGridForward
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
std::shared_ptr
STL class.
ast::Mapping::tranGridInverse
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
ast::Mapping::simplified
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
ast::Mapping::tranGridForward
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
ast::assertOK
void assertOK(AstObject *rawPtr1=nullptr, AstObject *rawPtr2=nullptr)
Throw std::runtime_error if AST's state is bad.
Definition: base.cc:49
ast::Object::setB
void setB(std::string const &attrib, bool value)
Set the value of an attribute as a bool.
Definition: Object.h:452
ast::Mapping::copyPolymorphic
virtual std::shared_ptr< Object > copyPolymorphic() const override
Return a deep copy of this object.
Definition: Mapping.h:410
std::vector< double >
std::vector::size
T size(T... args)
ast::Mapping::then
SeriesMap then(Mapping const &next) const
Return a series compound mapping this(first(input)) containing shallow copies of the original.
Definition: Mapping.cc:37
ast::Mapping
An abstract base class for objects which transform one set of coordinates to another.
Definition: Mapping.h:59
ast::Mapping::decompose
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
ast::Mapping::applyInverse
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
ast::Object
Abstract base class for all AST objects.
Definition: Object.h:51
ast::Mapping::getNOut
int getNOut() const
Get NOut: the number of output axes.
Definition: Mapping.h:82
ast::Mapping::applyForward
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
ast::Mapping::applyInverse
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
ast::Mapping::hasInverse
bool hasInverse() const
Is the inverse transform available?
Definition: Mapping.h:123
ast::Mapping::under
ParallelMap under(Mapping const &next) const
Return a parallel compound mapping containing shallow copies of the original.
Definition: Mapping.cc:39
ast::Mapping::linearApprox
Array2D linearApprox(PointD const &lbnd, PointD const &ubnd, double tol) const
Compute a linear approximation to the forward transformation.
Definition: Mapping.cc:49
ast::Mapping::Mapping
Mapping(Mapping const &)=default
Copy constructor: make a deep copy.
ast::SeriesMap
A series compound mapping where the first Mapping is used to transform the coordinates of each point ...
Definition: SeriesMap.h:53
ast::Mapping::hasForward
bool hasForward() const
Is the forward transform available?
Definition: Mapping.h:114
ast::Mapping::rate
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
ast::Mapping::isInverted
bool isInverted() const
Is this an inverted mapping?
Definition: Mapping.h:95
ast::Object::getClassName
std::string getClassName() const
Get Class: the name of the class (e.g.
Definition: Object.h:139
ast::Object::getI
int getI(std::string const &attrib) const
Get the value of an attribute as an int.
Definition: Object.h:400
ast::Array2D
ndarray::Array< double, 2, 2 > Array2D
2D array of const double; typically used for lists of const points
Definition: base.h:42
ast::Mapping::Mapping
Mapping(AstMapping *rawMap)
Construct a mapping from a pointer to a raw AST subclass of AstMapping.
Definition: Mapping.h:400
ast::Mapping::operator=
Mapping & operator=(Mapping const &)=delete
ast::Mapping::~Mapping
virtual ~Mapping()
Definition: Mapping.h:63
std::invalid_argument
STL class.
ast::Mapping::tranGridInverse
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
utils.h
ast::Mapping::applyForward
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
result
py::object result
Definition: _schema.cc:429
base.h
ast::Mapping::applyInverse
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
ast::Mapping::copy
std::shared_ptr< Mapping > copy() const
Return a deep copy of this object.
Definition: Mapping.h:72
ast::Mapping::inverted
std::shared_ptr< Mapping > inverted() const
Get an inverse mapping.
Definition: Mapping.cc:41
std::ostringstream
STL class.
to
table::Key< int > to
Definition: TransformMap.cc:349
ast::Mapping::setReport
void setReport(bool report)
Set Report: report transformed coordinates to stdout?
Definition: Mapping.h:225
ast
AST wrapper classes and functions.
Definition: attributes_channel.dox:1
ast::Mapping::getNIn
int getNIn() const
Get NIn: the number of input axes.
Definition: Mapping.h:77
os
std::ostream * os
Definition: Schema.cc:746
ast::Mapping::getReport
bool getReport() const
Get Report: report transformed coordinates to stdout?
Definition: Mapping.h:105
ast::Mapping::getIsLinear
bool getIsLinear() const
Get IsLinear: is the Mapping linear?
Definition: Mapping.h:100
ast::arrayFromVector
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
ast::ParallelMap
A parallel compound mapping where the first Mapping is used to transform the lower numbered coordinat...
Definition: ParallelMap.h:53
ast::Object::getRawPtr
AstObject const * getRawPtr() const
Get the raw AST pointer.
Definition: Object.h:292
std::size_t
ast::Mapping::getIsSimple
bool getIsSimple() const
Get IsSimple: has the mapping been simplified?
Definition: Mapping.h:87
ast::Mapping::applyForward
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
ast::detail::assertEqual
void assertEqual(T1 val1, std::string const &descr1, T2 val2, std::string const &descr2)
Definition: utils.h:48
Object.h
ast::ConstArray2D
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::data
T data(T... args)