LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
SkyFrame.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_SKYFRAME_H
23 #define ASTSHIM_SKYFRAME_H
24 
25 #include <memory>
26 #include <vector>
27 
28 #include "astshim/Frame.h"
29 
30 namespace ast {
31 
66 class SkyFrame : public Frame {
67  friend class Object;
68 
69 public:
124  explicit SkyFrame(std::string const &options = "")
125  : Frame(reinterpret_cast<AstFrame *>(astSkyFrame("%s", options.c_str()))) {
126  assertOK();
127  }
128 
129  virtual ~SkyFrame() {}
130 
132  SkyFrame(SkyFrame const &) = default;
133  SkyFrame(SkyFrame &&) = default;
134  SkyFrame &operator=(SkyFrame const &) = delete;
135  SkyFrame &operator=(SkyFrame &&) = default;
136 
138  std::shared_ptr<SkyFrame> copy() const { return std::static_pointer_cast<SkyFrame>(copyPolymorphic()); }
139 
141  bool getAlignOffset() const { return getB("AlignOffset"); }
142 
144  bool getAsTime(int axis) const { return getB(detail::formatAxisAttr("AsTime", axis)); }
145 
147  double getEquinox() const { return getD("Equinox"); }
148 
150  bool getIsLatAxis(int axis) const { return getB(detail::formatAxisAttr("IsLatAxis", axis)); }
151 
153  bool getIsLonAxis(int axis) const { return getB(detail::formatAxisAttr("IsLonAxis", axis)); }
154 
156  int getLatAxis() const { return getI("LatAxis"); }
157 
159  int getLonAxis() const { return getI("LonAxis"); }
160 
162  bool getNegLon() const { return getB("NegLon"); }
163 
165  std::string getProjection() const { return getC("Projection"); }
166 
171  for (int axis = 1; axis < 3; ++axis) {
172  ret.push_back(getD(detail::formatAxisAttr("SkyRef", axis)));
173  }
174  return ret;
175  }
176 
178  std::string getSkyRefIs() const { return getC("SkyRefIs"); }
179 
184  for (int axis = 1; axis < 3; ++axis) {
185  ret.push_back(getD(detail::formatAxisAttr("SkyRefP", axis)));
186  }
187  return ret;
188  }
189 
191  double getSkyTol() const { return getD("SkyTol"); }
192 
194  void setAlignOffset(bool alignOffset) { setB("AlignOffset", alignOffset); }
195 
197  void setAsTime(int axis, bool asTime) { setB(detail::formatAxisAttr("AsTime", axis), asTime); }
198 
200  void setEquinox(double equinox) { setD("Equinox", equinox); }
201 
203  void setNegLon(bool negLon) { setB("NegLon", negLon); }
204 
206  void setProjection(std::string const &projection) { setC("Projection", projection); }
207 
209  void setSkyRef(std::vector<double> const &skyRef) {
210  detail::assertEqual(skyRef.size(), "skyRef length", 2u, "number of axes");
211  for (int i = 0; i < 2; ++i) {
212  setD(detail::formatAxisAttr("SkyRef", i + 1), skyRef[i]);
213  }
214  }
215 
217  void setSkyRefIs(std::string const &skyRefIs) { setC("SkyRefIs", skyRefIs); }
218 
220  void setSkyRefP(std::vector<double> const &skyRefP) {
221  detail::assertEqual(skyRefP.size(), "skyRefP length", 2u, "number of axes");
222  for (int i = 0; i < 2; ++i) {
223  setD(detail::formatAxisAttr("SkyRefP", i + 1), skyRefP[i]);
224  }
225  }
226 
228  void setSkyTol(double skyTol) { setD("SkyTol", skyTol); }
229 
239  auto *rawMap = reinterpret_cast<AstObject *>(astSkyOffsetMap(getRawPtr()));
240  assertOK();
241  return Object::fromAstObject<Mapping>(rawMap, false);
242  }
243 
244 protected:
245  virtual std::shared_ptr<Object> copyPolymorphic() const override {
246  return copyImpl<SkyFrame, AstSkyFrame>();
247  }
248 
250  explicit SkyFrame(AstSkyFrame *rawptr) : Frame(reinterpret_cast<AstFrame *>(rawptr)) {
251  if (!astIsASkyFrame(getRawPtr())) {
253  os << "this is a " << getClassName() << ", which is not a SkyFrame";
254  throw std::invalid_argument(os.str());
255  }
256  }
257 };
258 
259 } // namespace ast
260 
261 #endif
table::Key< double > equinox
Definition: OldWcs.cc:133
std::ostream * os
Definition: Schema.cc:557
Frame is used to represent a coordinate system.
Definition: Frame.h:157
Abstract base class for all AST objects.
Definition: Object.h:51
void setD(std::string const &attrib, double value)
Set the value of an attribute as a double.
Definition: Object.h:476
double getD(std::string const &attrib) const
Get the value of an attribute as a double.
Definition: Object.h:374
std::string const getC(std::string const &attrib) const
Get the value of an attribute as a string.
Definition: Object.h:361
std::string getClassName() const
Get Class: the name of the class (e.g.
Definition: Object.h:139
bool getB(std::string const &attrib) const
Get the value of an attribute as a bool.
Definition: Object.h:348
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
void setC(std::string const &attrib, std::string const &value)
Set the value of an attribute as a string.
Definition: Object.h:464
void setB(std::string const &attrib, bool value)
Set the value of an attribute as a bool.
Definition: Object.h:452
SkyFrame is a specialised form of Frame which describes celestial longitude/latitude coordinate syste...
Definition: SkyFrame.h:66
std::shared_ptr< Mapping > skyOffsetMap()
Get a sky offset map.
Definition: SkyFrame.h:238
SkyFrame & operator=(SkyFrame const &)=delete
bool getNegLon() const
Get NegLon: display longitude values in the range [-pi,pi]?
Definition: SkyFrame.h:162
void setNegLon(bool negLon)
Set NegLon: display longitude values in the range [-pi,pi]?
Definition: SkyFrame.h:203
bool getAsTime(int axis) const
Get AsTime(axis) for one axis: format celestial coordinates as times?
Definition: SkyFrame.h:144
SkyFrame(std::string const &options="")
Construct a SkyFrame.
Definition: SkyFrame.h:124
SkyFrame(SkyFrame &&)=default
std::string getProjection() const
Get Projection: sky projection description.
Definition: SkyFrame.h:165
virtual std::shared_ptr< Object > copyPolymorphic() const override
Return a deep copy of this object.
Definition: SkyFrame.h:245
void setSkyRef(std::vector< double > const &skyRef)
Set SkyRef: position defining location of the offset coordinate system.
Definition: SkyFrame.h:209
void setProjection(std::string const &projection)
Set Projection: sky projection description.
Definition: SkyFrame.h:206
std::vector< double > getSkyRefP() const
Get SkyRefP for both axes: position defining orientation of the offset coordinate system.
Definition: SkyFrame.h:182
double getSkyTol() const
Get SkyTol: smallest significant shift in sky coordinates.
Definition: SkyFrame.h:191
virtual ~SkyFrame()
Definition: SkyFrame.h:129
void setEquinox(double equinox)
Set Equinox: epoch of the mean equinox.
Definition: SkyFrame.h:200
SkyFrame & operator=(SkyFrame &&)=default
int getLatAxis() const
Get LatAxis: index of the latitude axis.
Definition: SkyFrame.h:156
bool getIsLonAxis(int axis) const
Get IsLonAxis(axis) for one axis: is the specified axis the longitude axis?
Definition: SkyFrame.h:153
bool getIsLatAxis(int axis) const
Get IsLatAxis(axis) for one axis: is the specified axis the latitude axis?
Definition: SkyFrame.h:150
SkyFrame(AstSkyFrame *rawptr)
Construct a SkyFrame from a raw AST pointer.
Definition: SkyFrame.h:250
void setSkyRefP(std::vector< double > const &skyRefP)
Set SkyRefP: position defining orientation of the offset coordinate system.
Definition: SkyFrame.h:220
void setSkyRefIs(std::string const &skyRefIs)
Set SkyRefIs: selects the nature of the offset coordinate system.
Definition: SkyFrame.h:217
SkyFrame(SkyFrame const &)=default
Copy constructor: make a deep copy.
void setAsTime(int axis, bool asTime)
Set AsTime(axis) for one axis: format celestial coordinates as times?
Definition: SkyFrame.h:197
void setSkyTol(double skyTol)
Set SkyTol: smallest significant shift in sky coordinates.
Definition: SkyFrame.h:228
int getLonAxis() const
Get LonAxis: index of the longitude axis.
Definition: SkyFrame.h:159
std::shared_ptr< SkyFrame > copy() const
Return a deep copy of this object.
Definition: SkyFrame.h:138
bool getAlignOffset() const
Get AlignOffset: align SkyFrames using the offset coordinate system?
Definition: SkyFrame.h:141
void setAlignOffset(bool alignOffset)
Set AlignOffset: align SkyFrames using the offset coordinate system?
Definition: SkyFrame.h:194
double getEquinox() const
Get Equinox: epoch of the mean equinox.
Definition: SkyFrame.h:147
std::string getSkyRefIs() const
Get SkyRefIs: selects the nature of the offset coordinate system.
Definition: SkyFrame.h:178
std::vector< double > getSkyRef() const
Get SkyRef for both axes: position defining location of the offset coordinate system.
Definition: SkyFrame.h:169
std::string formatAxisAttr(std::string const &name, int axis)
Format an axis-specific attribute by appending the axis index.
Definition: utils.h:79
void assertEqual(T1 val1, std::string const &descr1, T2 val2, std::string const &descr2)
Definition: utils.h:48
AST wrapper classes and functions.
void assertOK(AstObject *rawPtr1=nullptr, AstObject *rawPtr2=nullptr)
Throw std::runtime_error if AST's state is bad.
Definition: base.cc:49
T push_back(T... args)
T size(T... args)