LSSTApplications  20.0.0
LSSTDataManagementBasePackage
PolyMap.cc
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 #include <sstream>
23 #include <stdexcept>
24 
26 #include "astshim/PolyMap.h"
27 
28 namespace ast {
29 
30 PolyMap PolyMap::polyTran(bool forward, double acc, double maxacc, int maxorder,
31  std::vector<double> const &lbnd, std::vector<double> const &ubnd) const {
32  // If there is an iterative inverse then reject attempts to fit the other direction.
33  // AST catches the case that there are no inverse coefficients,
34  // but I prefer to also raise if there are inverse coefficients because
35  // the iterative inverse cannot match the inverse coefficients, except in the most trivial cases,
36  // and the inverse coefficients are used to fit the forward direction,
37  // so the results are likely to be surprising
38  if (getIterInverse()) {
39  if (forward != isInverted()) {
40  if (forward) {
41  throw std::invalid_argument("Cannot fit forward transform when inverse is iterative");
42  } else {
43  throw std::invalid_argument("Cannot fit inverse transform when forward is iterative");
44  }
45  }
46  }
47  return PolyMap(detail::polyTranImpl<AstPolyMap>(*this, forward, acc, maxacc, maxorder, lbnd, ubnd));
48 }
49 
50 PolyMap::PolyMap(AstPolyMap *map) : Mapping(reinterpret_cast<AstMapping *>(map)) {
51  if (!astIsAPolyMap(getRawPtr())) {
53  os << "this is a " << getClassName() << ", which is not a PolyMap";
54  throw std::invalid_argument(os.str());
55  }
56 }
57 
59 AstPolyMap *PolyMap::_makeRawPolyMap(ConstArray2D const &coeff_f, ConstArray2D const &coeff_i,
60  std::string const &options) const {
61  const int nin = coeff_f.getSize<1>() - 2;
62  const int ncoeff_f = coeff_f.getSize<0>();
63  const int nout = coeff_i.getSize<1>() - 2;
64  const int ncoeff_i = coeff_i.getSize<0>();
65 
66  if ((ncoeff_f == 0) && (ncoeff_i == 0)) {
68  "Must specify forward or inverse transform (coeff_f and coeff_i both empty)");
69  }
70  if (nin <= 0) {
72  os << "coeff_f row length = " << nin + 2
73  << ", which is too short; length = nin + 2 and nin must be > 0";
74  throw std::invalid_argument(os.str());
75  }
76  if (nout <= 0) {
78  os << "coeff_i row length " << nout + 2
79  << ", which is too short; length = nout + 2 and nout must be > 0";
80  throw std::invalid_argument(os.str());
81  }
82 
83  auto result = astPolyMap(nin, nout, ncoeff_f, coeff_f.getData(), ncoeff_i, coeff_i.getData(), "%s",
84  options.c_str());
85  assertOK();
86  return result;
87 }
88 
90 AstPolyMap *PolyMap::_makeRawPolyMap(ConstArray2D const &coeff_f, int nout,
91  std::string const &options) const {
92  const int nin = coeff_f.getSize<1>() - 2;
93  const int ncoeff_f = coeff_f.getSize<0>();
94  if (ncoeff_f <= 0) {
95  throw std::invalid_argument("Must specify forward transform (coeff_f is empty)");
96  }
97  if (nin <= 0) {
99  os << "coeff_f row length = " << nin + 2
100  << ", which is too short; length = nin + 2 and nin must be > 0";
101  throw std::invalid_argument(os.str());
102  }
103  if (nout <= 0) {
105  os << "nout = " << nout << " <0 =";
106  throw std::invalid_argument(os.str());
107  }
108 
109  auto result = astPolyMap(nin, nout, ncoeff_f, coeff_f.getData(), 0, nullptr, "%s", options.c_str());
110  assertOK();
111  return result;
112 }
113 
114 } // namespace ast
std::string
STL class.
ast::assertOK
void assertOK(AstObject *rawPtr1=nullptr, AstObject *rawPtr2=nullptr)
Throw std::runtime_error if AST's state is bad.
Definition: base.cc:49
std::vector< double >
ast::Mapping
An abstract base class for objects which transform one set of coordinates to another.
Definition: Mapping.h:59
ast::PolyMap::PolyMap
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
ast::PolyMap
PolyMap is a Mapping which performs a general polynomial transformation.
Definition: PolyMap.h:49
ast::Mapping::isInverted
bool isInverted() const
Is this an inverted mapping?
Definition: Mapping.h:95
ast::Object::getClassName
std::string getClassName() const
Get Class: the name of the class (e.g.
Definition: Object.h:139
ast::PolyMap::polyTran
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
std::string::c_str
T c_str(T... args)
std::invalid_argument
STL class.
result
py::object result
Definition: _schema.cc:429
std::ostringstream
STL class.
ast
AST wrapper classes and functions.
Definition: attributes_channel.dox:1
os
std::ostream * os
Definition: Schema.cc:746
polyMapUtils.h
ast::detail::polyTranImpl< AstPolyMap >
template AstPolyMap * polyTranImpl< AstPolyMap >(PolyMap const &, bool, double, double, int, std::vector< double > const &, std::vector< double > const &)
ast::PolyMap::getIterInverse
bool getIterInverse() const
Get IterInverse: does this provide an iterative inverse transformation?
Definition: PolyMap.h:141
ast::Object::getRawPtr
AstObject const * getRawPtr() const
Get the raw AST pointer.
Definition: Object.h:292
ast::ConstArray2D
ndarray::Array< const double, 2, 2 > ConstArray2D
2D array of const double; typically used for lists of const points
Definition: base.h:46
PolyMap.h