lsst.astshim  master-g52c76259df
WcsMap.h
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_WCSMAP_H
23 #define ASTSHIM_WCSMAP_H
24 
25 #include <memory>
26 #include <sstream>
27 #include <utility>
28 
29 #include "astshim/base.h"
30 #include "astshim/detail/utils.h"
31 #include "astshim/Mapping.h"
32 
33 namespace ast {
34 
48 enum class WcsType {
49  AZP = AST__AZP,
50  SZP = AST__SZP,
51  TAN = AST__TAN,
52  STG = AST__STG,
53  SIN = AST__SIN,
54  ARC = AST__ARC,
55  ZPN = AST__ZPN,
56  ZEA = AST__ZEA,
57  AIR = AST__AIR,
58  CYP = AST__CYP,
59  CEA = AST__CEA,
60  CAR = AST__CAR,
61  MER = AST__MER,
62  SFL = AST__SFL,
63  PAR = AST__PAR,
64  MOL = AST__MOL,
65  AIT = AST__AIT,
66  COP = AST__COP,
67  COE = AST__COE,
68  COD = AST__COD,
69  COO = AST__COO,
70  BON = AST__BON,
71  PCO = AST__PCO,
72  TSC = AST__TSC,
73  CSC = AST__CSC,
74  QSC = AST__QSC,
75  NCP = AST__NCP,
76  GLS = AST__GLS,
77  TPN = AST__TPN,
78  HPX = AST__HPX,
79  XPH = AST__XPH,
80  WCSBAD = AST__WCSBAD,
81 };
82 
146 class WcsMap : public Mapping {
147  friend class Object;
148 
149 public:
209  explicit WcsMap(int ncoord, WcsType type, int lonax, int latax, std::string const &options = "")
210  : Mapping(reinterpret_cast<AstMapping *>(
211  astWcsMap(ncoord, static_cast<int>(type), lonax, latax, "%s", options.c_str()))) {}
212 
213  virtual ~WcsMap() {}
214 
215  WcsMap(WcsMap const &) = delete;
216  WcsMap(WcsMap &&) = default;
217  WcsMap &operator=(WcsMap const &) = delete;
218  WcsMap &operator=(WcsMap &&) = default;
219 
221  std::shared_ptr<WcsMap> copy() const { return std::static_pointer_cast<WcsMap>(copyPolymorphic()); }
222 
224  double getNatLat() const { return getD("NatLat"); }
225 
227  double getNatLon() const { return getD("NatLon"); }
228 
235  double getPVi_m(int i, int m) const {
236  std::stringstream os;
237  os << "PV" << i << "_" << m;
238  return getD(os.str());
239  }
240 
242  int getPVMax(int axis) const { return getI(detail::formatAxisAttr("PVMax", axis)); }
243 
247  std::pair<int, int> getWcsAxis() const {
248  return std::make_pair(getI(detail::formatAxisAttr("WcsAxis", 1)),
249  getI(detail::formatAxisAttr("WcsAxis", 2)));
250  }
251 
253  WcsType getWcsType() const { return static_cast<WcsType>(getI("WcsType")); }
254 
255 protected:
256  virtual std::shared_ptr<Object> copyPolymorphic() const override {
257  return copyImpl<WcsMap, AstWcsMap>();
258  }
259 
261  explicit WcsMap(AstWcsMap *rawptr) : Mapping(reinterpret_cast<AstMapping *>(rawptr)) {
262  if (!astIsAWcsMap(getRawPtr())) {
263  std::ostringstream os;
264  os << "this is a " << getClassName() << ", which is not a WcsMap";
265  throw std::invalid_argument(os.str());
266  }
267  }
268 };
269 
270 } // namespace ast
271 
272 #endif
int getPVMax(int axis) const
Get PVMax(axis) for one axis: maximum number of FITS-WCS projection parameters.
Definition: WcsMap.h:242
WcsMap(int ncoord, WcsType type, int lonax, int latax, std::string const &options="")
Definition: WcsMap.h:209
double getNatLon() const
get NatLon: native longitude of the reference point of a FITS-WCS projection.
Definition: WcsMap.h:227
AST wrapper classes and functions.
Definition: attributes_channel.dox:1
Definition: WcsMap.h:146
std::shared_ptr< WcsMap > copy() const
Return a deep copy of this object.
Definition: WcsMap.h:221
double getPVi_m(int i, int m) const
Definition: WcsMap.h:235
Definition: Mapping.h:59
std::pair< int, int > getWcsAxis() const
Definition: WcsMap.h:247
WcsType
Definition: WcsMap.h:48
WcsType getWcsType() const
Get WcsType: FITS-WCS projection type.
Definition: WcsMap.h:253
virtual std::shared_ptr< Object > copyPolymorphic() const override
Definition: WcsMap.h:256
double getNatLat() const
get NatLat: native latitude of the reference point of a FITS-WCS projection.
Definition: WcsMap.h:224
Definition: Object.h:49
WcsMap(AstWcsMap *rawptr)
Construct a WcsMap from a raw AST pointer.
Definition: WcsMap.h:261