LSSTApplications  17.0+124,17.0+14,17.0+73,18.0.0+37,18.0.0+80,18.0.0-4-g68ffd23+4,18.1.0-1-g0001055+12,18.1.0-1-g03d53ef+5,18.1.0-1-g1349e88+55,18.1.0-1-g2505f39+44,18.1.0-1-g5315e5e+4,18.1.0-1-g5e4b7ea+14,18.1.0-1-g7e8fceb+4,18.1.0-1-g85f8cd4+48,18.1.0-1-g8ff0b9f+4,18.1.0-1-ga2c679d+1,18.1.0-1-gd55f500+35,18.1.0-10-gb58edde+2,18.1.0-11-g0997b02+4,18.1.0-13-gfe4edf0b+12,18.1.0-14-g259bd21+21,18.1.0-19-gdb69f3f+2,18.1.0-2-g5f9922c+24,18.1.0-2-gd3b74e5+11,18.1.0-2-gfbf3545+32,18.1.0-26-g728bddb4+5,18.1.0-27-g6ff7ca9+2,18.1.0-3-g52aa583+25,18.1.0-3-g8ea57af+9,18.1.0-3-gb69f684+42,18.1.0-3-gfcaddf3+6,18.1.0-32-gd8786685a,18.1.0-4-gf3f9b77+6,18.1.0-5-g1dd662b+2,18.1.0-5-g6dbcb01+41,18.1.0-6-gae77429+3,18.1.0-7-g9d75d83+9,18.1.0-7-gae09a6d+30,18.1.0-9-gc381ef5+4,w.2019.45
LSSTDataManagementBasePackage
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 
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
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
virtual ~PolyMap()
Definition: PolyMap.h:129
ndarray::Array< const double, 2, 2 > ConstArray2D
2D array of const double; typically used for lists of const points
Definition: base.h:46
int getNIterInverse() const
Get NIterInverse: maximum number of iterations for iterative inverse.
Definition: PolyMap.h:144
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
int getI(std::string const &attrib) const
Get the value of an attribute as an int.
Definition: Object.h:400
AST wrapper classes and functions.
PolyMap & operator=(PolyMap const &)=delete
An abstract base class for objects which transform one set of coordinates to another.
Definition: Mapping.h:59
STL class.
bool getIterInverse() const
Get IterInverse: does this provide an iterative inverse transformation?
Definition: PolyMap.h:141
std::shared_ptr< PolyMap > copy() const
Return a deep copy of this object.
Definition: PolyMap.h:138
bool getB(std::string const &attrib) const
Get the value of an attribute as a bool.
Definition: Object.h:348
virtual std::shared_ptr< Object > copyPolymorphic() const override
Return a deep copy of this object.
Definition: PolyMap.h:236
T static_pointer_cast(T... args)
double getD(std::string const &attrib) const
Get the value of an attribute as a double.
Definition: Object.h:374
PolyMap is a Mapping which performs a general polynomial transformation.
Definition: PolyMap.h:49
double getTolInverse() const
Get TolInverse: target relative error for iterative inverse.
Definition: PolyMap.h:147
Abstract base class for all AST objects.
Definition: Object.h:51
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