LSST Applications  21.0.0+04719a4bac,21.0.0-1-ga51b5d4+f5e6047307,21.0.0-11-g2b59f77+a9c1acf22d,21.0.0-11-ga42c5b2+86977b0b17,21.0.0-12-gf4ce030+76814010d2,21.0.0-13-g1721dae+760e7a6536,21.0.0-13-g3a573fe+768d78a30a,21.0.0-15-g5a7caf0+f21cbc5713,21.0.0-16-g0fb55c1+b60e2d390c,21.0.0-19-g4cded4ca+71a93a33c0,21.0.0-2-g103fe59+bb20972958,21.0.0-2-g45278ab+04719a4bac,21.0.0-2-g5242d73+3ad5d60fb1,21.0.0-2-g7f82c8f+8babb168e8,21.0.0-2-g8f08a60+06509c8b61,21.0.0-2-g8faa9b5+616205b9df,21.0.0-2-ga326454+8babb168e8,21.0.0-2-gde069b7+5e4aea9c2f,21.0.0-2-gecfae73+1d3a86e577,21.0.0-2-gfc62afb+3ad5d60fb1,21.0.0-25-g1d57be3cd+e73869a214,21.0.0-3-g357aad2+ed88757d29,21.0.0-3-g4a4ce7f+3ad5d60fb1,21.0.0-3-g4be5c26+3ad5d60fb1,21.0.0-3-g65f322c+e0b24896a3,21.0.0-3-g7d9da8d+616205b9df,21.0.0-3-ge02ed75+a9c1acf22d,21.0.0-4-g591bb35+a9c1acf22d,21.0.0-4-g65b4814+b60e2d390c,21.0.0-4-gccdca77+0de219a2bc,21.0.0-4-ge8a399c+6c55c39e83,21.0.0-5-gd00fb1e+05fce91b99,21.0.0-6-gc675373+3ad5d60fb1,21.0.0-64-g1122c245+4fb2b8f86e,21.0.0-7-g04766d7+cd19d05db2,21.0.0-7-gdf92d54+04719a4bac,21.0.0-8-g5674e7b+d1bd76f71f,master-gac4afde19b+a9c1acf22d,w.2021.13
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