LSSTApplications  16.0-10-g0ee56ad+5,16.0-11-ga33d1f2+5,16.0-12-g3ef5c14+3,16.0-12-g71e5ef5+18,16.0-12-gbdf3636+3,16.0-13-g118c103+3,16.0-13-g8f68b0a+3,16.0-15-gbf5c1cb+4,16.0-16-gfd17674+3,16.0-17-g7c01f5c+3,16.0-18-g0a50484+1,16.0-20-ga20f992+8,16.0-21-g0e05fd4+6,16.0-21-g15e2d33+4,16.0-22-g62d8060+4,16.0-22-g847a80f+4,16.0-25-gf00d9b8+1,16.0-28-g3990c221+4,16.0-3-gf928089+3,16.0-32-g88a4f23+5,16.0-34-gd7987ad+3,16.0-37-gc7333cb+2,16.0-4-g10fc685+2,16.0-4-g18f3627+26,16.0-4-g5f3a788+26,16.0-5-gaf5c3d7+4,16.0-5-gcc1f4bb+1,16.0-6-g3b92700+4,16.0-6-g4412fcd+3,16.0-6-g7235603+4,16.0-69-g2562ce1b+2,16.0-8-g14ebd58+4,16.0-8-g2df868b+1,16.0-8-g4cec79c+6,16.0-8-gadf6c7a+1,16.0-8-gfc7ad86,16.0-82-g59ec2a54a+1,16.0-9-g5400cdc+2,16.0-9-ge6233d7+5,master-g2880f2d8cf+3,v17.0.rc1
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:399
AST wrapper classes and functions.
PolyMap & operator=(PolyMap const &)=delete
tuple options
Definition: lsstimport.py:47
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:347
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:373
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