LSST Applications  21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
PolyMap.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_POLYMAP_H
23 #define ASTSHIM_POLYMAP_H
24 
25 #include <algorithm>
26 #include <memory>
27 #include <vector>
28 
29 #include "astshim/base.h"
30 #include "astshim/Mapping.h"
31 
32 namespace ast {
33 
49 class PolyMap : public Mapping {
50  friend class Object;
51 
52 public:
99  explicit PolyMap(ConstArray2D const &coeff_f, ConstArray2D const &coeff_i,
100  std::string const &options = "IterInverse=0")
101  : Mapping(reinterpret_cast<AstMapping *>(_makeRawPolyMap(coeff_f, coeff_i, options))) {}
102 
126  explicit PolyMap(ConstArray2D const &coeff_f, int nout, std::string const &options = "IterInverse=0")
127  : Mapping(reinterpret_cast<AstMapping *>(_makeRawPolyMap(coeff_f, nout, options))) {}
128 
129  virtual ~PolyMap() {}
130 
132  PolyMap(PolyMap const &) = default;
133  PolyMap(PolyMap &&) = default;
134  PolyMap &operator=(PolyMap const &) = delete;
135  PolyMap &operator=(PolyMap &&) = default;
136 
138  std::shared_ptr<PolyMap> copy() const { return std::static_pointer_cast<PolyMap>(copyPolymorphic()); }
139 
141  bool getIterInverse() const { return getB("IterInverse"); }
142 
144  int getNIterInverse() const { return getI("NIterInverse"); }
145 
147  double getTolInverse() const { return getD("TolInverse"); }
148 
232  PolyMap polyTran(bool forward, double acc, double maxacc, int maxorder, std::vector<double> const &lbnd,
233  std::vector<double> const &ubnd) const;
234 
235 protected:
236  virtual std::shared_ptr<Object> copyPolymorphic() const override {
237  return copyImpl<PolyMap, AstPolyMap>();
238  }
239 
241  PolyMap(AstPolyMap *map);
242 
243 private:
245  AstPolyMap *_makeRawPolyMap(ConstArray2D const &coeff_f, ConstArray2D const &coeff_i,
246  std::string const &options = "") const;
247 
249  AstPolyMap *_makeRawPolyMap(ConstArray2D const &coeff_f, int nout, std::string const &options = "") const;
250 };
251 
252 } // namespace ast
253 
254 #endif
An abstract base class for objects which transform one set of coordinates to another.
Definition: Mapping.h:59
Abstract base class for all AST objects.
Definition: Object.h:51
double getD(std::string const &attrib) const
Get the value of an attribute as a double.
Definition: Object.h:374
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.h:400
PolyMap is a Mapping which performs a general polynomial transformation.
Definition: PolyMap.h:49
PolyMap(PolyMap &&)=default
PolyMap(ConstArray2D const &coeff_f, ConstArray2D const &coeff_i, std::string const &options="IterInverse=0")
Construct a PolyMap with specified forward and/or inverse transforms.
Definition: PolyMap.h:99
int getNIterInverse() const
Get NIterInverse: maximum number of iterations for iterative inverse.
Definition: PolyMap.h:144
virtual ~PolyMap()
Definition: PolyMap.h:129
std::shared_ptr< PolyMap > copy() const
Return a deep copy of this object.
Definition: PolyMap.h:138
PolyMap(PolyMap const &)=default
Copy constructor: make a deep copy.
bool getIterInverse() const
Get IterInverse: does this provide an iterative inverse transformation?
Definition: PolyMap.h:141
double getTolInverse() const
Get TolInverse: target relative error for iterative inverse.
Definition: PolyMap.h:147
PolyMap(ConstArray2D const &coeff_f, int nout, std::string const &options="IterInverse=0")
Construct a PolyMap with only the forward transform specified.
Definition: PolyMap.h:126
PolyMap & operator=(PolyMap &&)=default
virtual std::shared_ptr< Object > copyPolymorphic() const override
Return a deep copy of this object.
Definition: PolyMap.h:236
PolyMap polyTran(bool forward, double acc, double maxacc, int maxorder, std::vector< double > const &lbnd, std::vector< double > const &ubnd) const
This function creates a new PolyMap which is a copy of this one, in which a specified transformation ...
Definition: PolyMap.cc:30
PolyMap & operator=(PolyMap const &)=delete
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