LSST Applications g0b6bd0c080+a72a5dd7e6,g1182afd7b4+2a019aa3bb,g17e5ecfddb+2b8207f7de,g1d67935e3f+06cf436103,g38293774b4+ac198e9f13,g396055baef+6a2097e274,g3b44f30a73+6611e0205b,g480783c3b1+98f8679e14,g48ccf36440+89c08d0516,g4b93dc025c+98f8679e14,g5c4744a4d9+a302e8c7f0,g613e996a0d+e1c447f2e0,g6c8d09e9e7+25247a063c,g7271f0639c+98f8679e14,g7a9cd813b8+124095ede6,g9d27549199+a302e8c7f0,ga1cf026fa3+ac198e9f13,ga32aa97882+7403ac30ac,ga786bb30fb+7a139211af,gaa63f70f4e+9994eb9896,gabf319e997+ade567573c,gba47b54d5d+94dc90c3ea,gbec6a3398f+06cf436103,gc6308e37c7+07dd123edb,gc655b1545f+ade567573c,gcc9029db3c+ab229f5caf,gd01420fc67+06cf436103,gd877ba84e5+06cf436103,gdb4cecd868+6f279b5b48,ge2d134c3d5+cc4dbb2e3f,ge448b5faa6+86d1ceac1d,gecc7e12556+98f8679e14,gf3ee170dca+25247a063c,gf4ac96e456+ade567573c,gf9f5ea5b4d+ac198e9f13,gff490e6085+8c2580be5c,w.2022.27
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"
31#include "astshim/Mapping.h"
32
33namespace ast {
34
48enum 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
146class WcsMap : public Mapping {
147 friend class Object;
148
149public:
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
258protected:
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
int getI(std::string const &attrib) const
Get the value of an attribute as an int.
Definition: Object.h:400
AstObject const * getRawPtr() const
Get the raw AST pointer.
Definition: Object.h:292
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
double getNatLat() const
get NatLat: native latitude of the reference point of a FITS-WCS projection.
Definition: WcsMap.h:227
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 & operator=(WcsMap const &)=delete
WcsMap(int ncoord, WcsType type, int lonax, int latax, std::string const &options="")
Create a WcsMap.
Definition: WcsMap.h:209
std::shared_ptr< WcsMap > copy() const
Return a deep copy of this object.
Definition: WcsMap.h:224
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
std::pair< int, int > getWcsAxis() const
Get WcsAxis(lonlat) FITS-WCS projection axis for longitude, latitude.
Definition: WcsMap.h:250
WcsMap & operator=(WcsMap &&)=default
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
virtual std::shared_ptr< Object > copyPolymorphic() const override
Return a deep copy of this object.
Definition: WcsMap.h:259
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