LSST Applications  21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
WcsMap.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_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  assertOK();
213  }
214 
215  virtual ~WcsMap() {}
216 
218  WcsMap(WcsMap const &) = default;
219  WcsMap(WcsMap &&) = default;
220  WcsMap &operator=(WcsMap const &) = delete;
221  WcsMap &operator=(WcsMap &&) = default;
222 
224  std::shared_ptr<WcsMap> copy() const { return std::static_pointer_cast<WcsMap>(copyPolymorphic()); }
225 
227  double getNatLat() const { return getD("NatLat"); }
228 
230  double getNatLon() const { return getD("NatLon"); }
231 
238  double getPVi_m(int i, int m) const {
240  os << "PV" << i << "_" << m;
241  return getD(os.str());
242  }
243 
245  int getPVMax(int axis) const { return getI(detail::formatAxisAttr("PVMax", axis)); }
246 
251  return std::make_pair(getI(detail::formatAxisAttr("WcsAxis", 1)),
252  getI(detail::formatAxisAttr("WcsAxis", 2)));
253  }
254 
256  WcsType getWcsType() const { return static_cast<WcsType>(getI("WcsType")); }
257 
258 protected:
259  virtual std::shared_ptr<Object> copyPolymorphic() const override {
260  return copyImpl<WcsMap, AstWcsMap>();
261  }
262 
264  explicit WcsMap(AstWcsMap *rawptr) : Mapping(reinterpret_cast<AstMapping *>(rawptr)) {
265  if (!astIsAWcsMap(getRawPtr())) {
267  os << "this is a " << getClassName() << ", which is not a WcsMap";
268  throw std::invalid_argument(os.str());
269  }
270  }
271 };
272 
273 } // namespace ast
274 
275 #endif
table::Key< int > type
Definition: Detector.cc:163
std::ostream * os
Definition: Schema.cc:557
int m
Definition: SpanSet.cc:48
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
std::string getClassName() const
Get Class: the name of the class (e.g.
Definition: Object.h:139
AstObject const * getRawPtr() const
Get the raw AST pointer.
Definition: Object.h:292
int getI(std::string const &attrib) const
Get the value of an attribute as an int.
Definition: Object.h:400
Map from a spherical system to a cartesian system using standard FITS sky coordinate projections.
Definition: WcsMap.h:146
WcsType getWcsType() const
Get WcsType: FITS-WCS projection type.
Definition: WcsMap.h:256
std::shared_ptr< WcsMap > copy() const
Return a deep copy of this object.
Definition: WcsMap.h:224
double getNatLat() const
get NatLat: native latitude of the reference point of a FITS-WCS projection.
Definition: WcsMap.h:227
WcsMap & operator=(WcsMap &&)=default
double getNatLon() const
get NatLon: native longitude of the reference point of a FITS-WCS projection.
Definition: WcsMap.h:230
WcsMap(WcsMap const &)=default
Copy constructor: make a deep copy.
WcsMap(int ncoord, WcsType type, int lonax, int latax, std::string const &options="")
Create a WcsMap.
Definition: WcsMap.h:209
WcsMap(AstWcsMap *rawptr)
Construct a WcsMap from a raw AST pointer.
Definition: WcsMap.h:264
int getPVMax(int axis) const
Get PVMax(axis) for one axis: maximum number of FITS-WCS projection parameters.
Definition: WcsMap.h:245
virtual std::shared_ptr< Object > copyPolymorphic() const override
Return a deep copy of this object.
Definition: WcsMap.h:259
WcsMap & operator=(WcsMap const &)=delete
virtual ~WcsMap()
Definition: WcsMap.h:215
double getPVi_m(int i, int m) const
Get PVi_m for one value of i and m: a FITS-WCS projection parameter.
Definition: WcsMap.h:238
WcsMap(WcsMap &&)=default
std::pair< int, int > getWcsAxis() const
Get WcsAxis(lonlat) FITS-WCS projection axis for longitude, latitude.
Definition: WcsMap.h:250
T make_pair(T... args)
std::string formatAxisAttr(std::string const &name, int axis)
Format an axis-specific attribute by appending the axis index.
Definition: utils.h:79
AST wrapper classes and functions.
WcsType
WCS types that give the projection type code (in upper case) as used in the FITS-WCS "CTYPEi" keyword...
Definition: WcsMap.h:48
void assertOK(AstObject *rawPtr1=nullptr, AstObject *rawPtr2=nullptr)
Throw std::runtime_error if AST's state is bad.
Definition: base.cc:49