LSSTApplications  17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
LSSTDataManagementBasePackage
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
int getPVMax(int axis) const
Get PVMax(axis) for one axis: maximum number of FITS-WCS projection parameters.
Definition: WcsMap.h:245
WcsMap(int ncoord, WcsType type, int lonax, int latax, std::string const &options="")
Create a WcsMap.
Definition: WcsMap.h:209
double getNatLon() const
get NatLon: native longitude of the reference point of a FITS-WCS projection.
Definition: WcsMap.h:230
AST wrapper classes and functions.
Map from a spherical system to a cartesian system using standard FITS sky coordinate projections...
Definition: WcsMap.h:146
std::shared_ptr< WcsMap > copy() const
Return a deep copy of this object.
Definition: WcsMap.h:224
virtual ~WcsMap()
Definition: WcsMap.h:215
void assertOK(AstObject *rawPtr1=nullptr, AstObject *rawPtr2=nullptr)
Throw std::runtime_error if AST&#39;s state is bad.
Definition: base.cc:49
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
tuple options
Definition: lsstimport.py:47
An abstract base class for objects which transform one set of coordinates to another.
Definition: Mapping.h:59
std::pair< int, int > getWcsAxis() const
Get WcsAxis(lonlat) FITS-WCS projection axis for longitude, latitude.
Definition: WcsMap.h:250
WcsType
WCS types that give the projection type code (in upper case) as used in the FITS-WCS "CTYPEi" keyword...
Definition: WcsMap.h:48
STL class.
WcsType getWcsType() const
Get WcsType: FITS-WCS projection type.
Definition: WcsMap.h:256
table::Key< int > type
Definition: Detector.cc:167
T str(T... args)
T make_pair(T... args)
T static_pointer_cast(T... args)
virtual std::shared_ptr< Object > copyPolymorphic() const override
Return a deep copy of this object.
Definition: WcsMap.h:259
std::string getClassName(AstObject const *rawObj)
Get the AST class name, changing CmpMap to SeriesMap or ParallelMap as appropriate.
Definition: utils.cc:37
std::string formatAxisAttr(std::string const &name, int axis)
Format an axis-specific attribute by appending the axis index.
Definition: utils.h:79
int m
Definition: SpanSet.cc:49
double getNatLat() const
get NatLat: native latitude of the reference point of a FITS-WCS projection.
Definition: WcsMap.h:227
Abstract base class for all AST objects.
Definition: Object.h:51
std::ostream * os
Definition: Schema.cc:746
WcsMap(AstWcsMap *rawptr)
Construct a WcsMap from a raw AST pointer.
Definition: WcsMap.h:264