LSST Applications g0f08755f38+82efc23009,g12f32b3c4e+e7bdf1200e,g1653933729+a8ce1bb630,g1a0ca8cf93+50eff2b06f,g28da252d5a+52db39f6a5,g2bbee38e9b+37c5a29d61,g2bc492864f+37c5a29d61,g2cdde0e794+c05ff076ad,g3156d2b45e+41e33cbcdc,g347aa1857d+37c5a29d61,g35bb328faa+a8ce1bb630,g3a166c0a6a+37c5a29d61,g3e281a1b8c+fb992f5633,g414038480c+7f03dfc1b0,g41af890bb2+11b950c980,g5fbc88fb19+17cd334064,g6b1c1869cb+12dd639c9a,g781aacb6e4+a8ce1bb630,g80478fca09+72e9651da0,g82479be7b0+04c31367b4,g858d7b2824+82efc23009,g9125e01d80+a8ce1bb630,g9726552aa6+8047e3811d,ga5288a1d22+e532dc0a0b,gae0086650b+a8ce1bb630,gb58c049af0+d64f4d3760,gc28159a63d+37c5a29d61,gcf0d15dbbd+2acd6d4d48,gd7358e8bfb+778a810b6e,gda3e153d99+82efc23009,gda6a2b7d83+2acd6d4d48,gdaeeff99f8+1711a396fd,ge2409df99d+6b12de1076,ge79ae78c31+37c5a29d61,gf0baf85859+d0a5978c5a,gf3967379c6+4954f8c433,gfb92a5be7c+82efc23009,gfec2e1e490+2aaed99252,w.2024.46
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.cc:178
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