LSSTApplications  19.0.0-14-gb0260a2+72efe9b372,20.0.0+7927753e06,20.0.0+8829bf0056,20.0.0+995114c5d2,20.0.0+b6f4b2abd1,20.0.0+bddc4f4cbe,20.0.0-1-g253301a+8829bf0056,20.0.0-1-g2b7511a+0d71a2d77f,20.0.0-1-g5b95a8c+7461dd0434,20.0.0-12-g321c96ea+23efe4bbff,20.0.0-16-gfab17e72e+fdf35455f6,20.0.0-2-g0070d88+ba3ffc8f0b,20.0.0-2-g4dae9ad+ee58a624b3,20.0.0-2-g61b8584+5d3db074ba,20.0.0-2-gb780d76+d529cf1a41,20.0.0-2-ged6426c+226a441f5f,20.0.0-2-gf072044+8829bf0056,20.0.0-2-gf1f7952+ee58a624b3,20.0.0-20-geae50cf+e37fec0aee,20.0.0-25-g3dcad98+544a109665,20.0.0-25-g5eafb0f+ee58a624b3,20.0.0-27-g64178ef+f1f297b00a,20.0.0-3-g4cc78c6+e0676b0dc8,20.0.0-3-g8f21e14+4fd2c12c9a,20.0.0-3-gbd60e8c+187b78b4b8,20.0.0-3-gbecbe05+48431fa087,20.0.0-38-ge4adf513+a12e1f8e37,20.0.0-4-g97dc21a+544a109665,20.0.0-4-gb4befbc+087873070b,20.0.0-4-gf910f65+5d3db074ba,20.0.0-5-gdfe0fee+199202a608,20.0.0-5-gfbfe500+d529cf1a41,20.0.0-6-g64f541c+d529cf1a41,20.0.0-6-g9a5b7a1+a1cd37312e,20.0.0-68-ga3f3dda+5fca18c6a4,20.0.0-9-g4aef684+e18322736b,w.2020.45
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
ast::WcsType::XPH
@ XPH
ast::WcsMap::~WcsMap
virtual ~WcsMap()
Definition: WcsMap.h:215
ast::WcsType::SIN
@ SIN
ast::WcsType
WcsType
WCS types that give the projection type code (in upper case) as used in the FITS-WCS "CTYPEi" keyword...
Definition: WcsMap.h:48
ast::WcsType::TSC
@ TSC
std::string
STL class.
std::shared_ptr
STL class.
std::pair< int, int >
ast::assertOK
void assertOK(AstObject *rawPtr1=nullptr, AstObject *rawPtr2=nullptr)
Throw std::runtime_error if AST's state is bad.
Definition: base.cc:49
ast::WcsMap
Map from a spherical system to a cartesian system using standard FITS sky coordinate projections.
Definition: WcsMap.h:146
ast::WcsMap::operator=
WcsMap & operator=(WcsMap const &)=delete
ast::WcsType::HPX
@ HPX
ast::Mapping
An abstract base class for objects which transform one set of coordinates to another.
Definition: Mapping.h:59
ast::WcsType::SFL
@ SFL
ast::WcsType::AZP
@ AZP
ast::WcsType::WCSBAD
@ WCSBAD
ast::WcsMap::WcsMap
WcsMap(WcsMap const &)=default
Copy constructor: make a deep copy.
std::stringstream
STL class.
ast::WcsType::QSC
@ QSC
ast::WcsType::ARC
@ ARC
ast::WcsType::PCO
@ PCO
ast::Object
Abstract base class for all AST objects.
Definition: Object.h:51
ast::WcsMap::getPVi_m
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
ast::WcsMap::getNatLon
double getNatLon() const
get NatLon: native longitude of the reference point of a FITS-WCS projection.
Definition: WcsMap.h:230
ast::WcsType::COO
@ COO
ast::WcsMap::WcsMap
WcsMap(WcsMap &&)=default
ast::WcsMap::getWcsAxis
std::pair< int, int > getWcsAxis() const
Get WcsAxis(lonlat) FITS-WCS projection axis for longitude, latitude.
Definition: WcsMap.h:250
ast::WcsMap::operator=
WcsMap & operator=(WcsMap &&)=default
ast::WcsType::TPN
@ TPN
ast::Object::getClassName
std::string getClassName() const
Get Class: the name of the class (e.g.
Definition: Object.h:139
ast::WcsMap::getPVMax
int getPVMax(int axis) const
Get PVMax(axis) for one axis: maximum number of FITS-WCS projection parameters.
Definition: WcsMap.h:245
ast::Object::getI
int getI(std::string const &attrib) const
Get the value of an attribute as an int.
Definition: Object.h:400
ast::WcsType::CEA
@ CEA
ast::WcsType::COP
@ COP
ast::WcsType::MOL
@ MOL
ast::WcsMap::WcsMap
WcsMap(int ncoord, WcsType type, int lonax, int latax, std::string const &options="")
Create a WcsMap.
Definition: WcsMap.h:209
ast::WcsType::NCP
@ NCP
ast::WcsMap::WcsMap
WcsMap(AstWcsMap *rawptr)
Construct a WcsMap from a raw AST pointer.
Definition: WcsMap.h:264
ast::WcsType::MER
@ MER
std::invalid_argument
STL class.
utils.h
ast::WcsMap::copyPolymorphic
virtual std::shared_ptr< Object > copyPolymorphic() const override
Return a deep copy of this object.
Definition: WcsMap.h:259
base.h
ast::WcsType::CAR
@ CAR
ast::WcsType::CYP
@ CYP
std::ostringstream
STL class.
ast::WcsType::COE
@ COE
ast::WcsType::CSC
@ CSC
ast
AST wrapper classes and functions.
Definition: attributes_channel.dox:1
os
std::ostream * os
Definition: Schema.cc:746
ast::WcsType::BON
@ BON
ast::Object::getD
double getD(std::string const &attrib) const
Get the value of an attribute as a double.
Definition: Object.h:374
Mapping.h
ast::WcsType::AIR
@ AIR
ast::WcsType::PAR
@ PAR
ast::WcsType::STG
@ STG
ast::WcsMap::getNatLat
double getNatLat() const
get NatLat: native latitude of the reference point of a FITS-WCS projection.
Definition: WcsMap.h:227
type
table::Key< int > type
Definition: Detector.cc:163
ast::WcsMap::copy
std::shared_ptr< WcsMap > copy() const
Return a deep copy of this object.
Definition: WcsMap.h:224
ast::WcsMap::getWcsType
WcsType getWcsType() const
Get WcsType: FITS-WCS projection type.
Definition: WcsMap.h:256
ast::WcsType::ZEA
@ ZEA
ast::Object::getRawPtr
AstObject const * getRawPtr() const
Get the raw AST pointer.
Definition: Object.h:292
ast::WcsType::SZP
@ SZP
std::make_pair
T make_pair(T... args)
ast::WcsType::ZPN
@ ZPN
ast::WcsType::COD
@ COD
ast::WcsType::TAN
@ TAN
ast::detail::formatAxisAttr
std::string formatAxisAttr(std::string const &name, int axis)
Format an axis-specific attribute by appending the axis index.
Definition: utils.h:79
ast::WcsType::AIT
@ AIT
ast::WcsType::GLS
@ GLS
m
int m
Definition: SpanSet.cc:49