LSST Applications 26.0.0,g0265f82a02+6660c170cc,g07994bdeae+30b05a742e,g0a0026dc87+17526d298f,g0a60f58ba1+17526d298f,g0e4bf8285c+96dd2c2ea9,g0ecae5effc+c266a536c8,g1e7d6db67d+6f7cb1f4bb,g26482f50c6+6346c0633c,g2bbee38e9b+6660c170cc,g2cc88a2952+0a4e78cd49,g3273194fdb+f6908454ef,g337abbeb29+6660c170cc,g337c41fc51+9a8f8f0815,g37c6e7c3d5+7bbafe9d37,g44018dc512+6660c170cc,g4a941329ef+4f7594a38e,g4c90b7bd52+5145c320d2,g58be5f913a+bea990ba40,g635b316a6c+8d6b3a3e56,g67924a670a+bfead8c487,g6ae5381d9b+81bc2a20b4,g93c4d6e787+26b17396bd,g98cecbdb62+ed2cb6d659,g98ffbb4407+81bc2a20b4,g9ddcbc5298+7f7571301f,ga1e77700b3+99e9273977,gae46bcf261+6660c170cc,gb2715bf1a1+17526d298f,gc86a011abf+17526d298f,gcf0d15dbbd+96dd2c2ea9,gdaeeff99f8+0d8dbea60f,gdb4ec4c597+6660c170cc,ge23793e450+96dd2c2ea9,gf041782ebf+171108ac67
LSST Data Management Base Package
Loading...
Searching...
No Matches
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
32namespace ast {
33
49class PolyMap : public Mapping {
50 friend class Object;
51
52public:
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
235protected:
236 virtual std::shared_ptr<Object> copyPolymorphic() const override {
237 return copyImpl<PolyMap, AstPolyMap>();
238 }
239
241 PolyMap(AstPolyMap *map);
242
243private:
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
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
virtual std::shared_ptr< Object > copyPolymorphic() const override
Return a deep copy of this object.
Definition PolyMap.h:236
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
std::shared_ptr< PolyMap > copy() const
Return a deep copy of this object.
Definition PolyMap.h:138
PolyMap & operator=(PolyMap &&)=default
PolyMap & operator=(PolyMap const &)=delete
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
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