lsst.astshim  15.0-3-gaec6799
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 
127  virtual ~SkyFrame() {}
128 
130  SkyFrame(SkyFrame const &) = default;
131  SkyFrame(SkyFrame &&) = default;
132  SkyFrame &operator=(SkyFrame const &) = delete;
133  SkyFrame &operator=(SkyFrame &&) = default;
134 
136  std::shared_ptr<SkyFrame> copy() const { return std::static_pointer_cast<SkyFrame>(copyPolymorphic()); }
137 
139  bool getAlignOffset() const { return getB("AlignOffset"); }
140 
142  bool getAsTime(int axis) const { return getB(detail::formatAxisAttr("AsTime", axis)); }
143 
145  double getEquinox() const { return getD("Equinox"); }
146 
148  bool getIsLatAxis(int axis) const { return getB(detail::formatAxisAttr("IsLatAxis", axis)); }
149 
151  bool getIsLonAxis(int axis) const { return getB(detail::formatAxisAttr("IsLonAxis", axis)); }
152 
154  int getLatAxis() const { return getI("LatAxis"); }
155 
157  int getLonAxis() const { return getI("LonAxis"); }
158 
160  bool getNegLon() const { return getB("NegLon"); }
161 
163  std::string getProjection() const { return getC("Projection"); }
164 
167  std::vector<double> getSkyRef() const {
168  std::vector<double> ret;
169  for (int axis = 1; axis < 3; ++axis) {
170  ret.push_back(getD(detail::formatAxisAttr("SkyRef", axis)));
171  }
172  return ret;
173  }
174 
176  std::string getSkyRefIs() const { return getC("SkyRefIs"); }
177 
180  std::vector<double> getSkyRefP() const {
181  std::vector<double> ret;
182  for (int axis = 1; axis < 3; ++axis) {
183  ret.push_back(getD(detail::formatAxisAttr("SkyRefP", axis)));
184  }
185  return ret;
186  }
187 
189  double getSkyTol() const { return getD("SkyTol"); }
190 
192  void setAlignOffset(bool alignOffset) { setB("AlignOffset", alignOffset); }
193 
195  void setAsTime(int axis, bool asTime) { setB(detail::formatAxisAttr("AsTime", axis), asTime); }
196 
198  void setEquinox(double equinox) { setD("Equinox", equinox); }
199 
201  void setNegLon(bool negLon) { setB("NegLon", negLon); }
202 
204  void setProjection(std::string const &projection) { setC("Projection", projection); }
205 
207  void setSkyRef(std::vector<double> const &skyRef) {
208  detail::assertEqual(skyRef.size(), "skyRef length", 2u, "number of axes");
209  for (int i = 0; i < 2; ++i) {
210  setD(detail::formatAxisAttr("SkyRef", i + 1), skyRef[i]);
211  }
212  }
213 
215  void setSkyRefIs(std::string const &skyRefIs) { setC("SkyRefIs", skyRefIs); }
216 
218  void setSkyRefP(std::vector<double> const &skyRefP) {
219  detail::assertEqual(skyRefP.size(), "skyRefP length", 2u, "number of axes");
220  for (int i = 0; i < 2; ++i) {
221  setD(detail::formatAxisAttr("SkyRefP", i + 1), skyRefP[i]);
222  }
223  }
224 
226  void setSkyTol(double skyTol) { setD("SkyTol", skyTol); }
227 
236  std::shared_ptr<Mapping> skyOffsetMap() {
237  auto *rawMap = reinterpret_cast<AstObject *>(astSkyOffsetMap(getRawPtr()));
238  return Object::fromAstObject<Mapping>(rawMap, false);
239  }
240 
241 protected:
242  virtual std::shared_ptr<Object> copyPolymorphic() const override {
243  return copyImpl<SkyFrame, AstSkyFrame>();
244  }
245 
247  explicit SkyFrame(AstSkyFrame *rawptr) : Frame(reinterpret_cast<AstFrame *>(rawptr)) {
248  if (!astIsASkyFrame(getRawPtr())) {
249  std::ostringstream os;
250  os << "this is a " << getClassName() << ", which is not a SkyFrame";
251  throw std::invalid_argument(os.str());
252  }
253  }
254 };
255 
256 } // namespace ast
257 
258 #endif
virtual std::shared_ptr< Object > copyPolymorphic() const override
Definition: SkyFrame.h:242
SkyFrame & operator=(SkyFrame const &)=delete
std::shared_ptr< SkyFrame > copy() const
Return a deep copy of this object.
Definition: SkyFrame.h:136
bool getIsLatAxis(int axis) const
Get IsLatAxis(axis) for one axis: is the specified axis the latitude axis?
Definition: SkyFrame.h:148
AstObject const * getRawPtr() const
Definition: Object.h:291
bool getNegLon() const
Get NegLon: display longitude values in the range [-pi,pi]?
Definition: SkyFrame.h:160
void setB(std::string const &attrib, bool value)
Definition: Object.h:448
void setAlignOffset(bool alignOffset)
Set AlignOffset: align SkyFrames using the offset coordinate system?
Definition: SkyFrame.h:192
int getI(std::string const &attrib) const
Definition: Object.h:399
AST wrapper classes and functions.
Definition: attributes_channel.dox:1
std::string getClassName() const
Definition: Object.h:138
std::string getSkyRefIs() const
Get SkyRefIs: selects the nature of the offset coordinate system.
Definition: SkyFrame.h:176
void setSkyTol(double skyTol)
Set SkyTol: smallest significant shift in sky coordinates.
Definition: SkyFrame.h:226
double getSkyTol() const
Get SkyTol: smallest significant shift in sky coordinates.
Definition: SkyFrame.h:189
void setNegLon(bool negLon)
Set NegLon: display longitude values in the range [-pi,pi]?
Definition: SkyFrame.h:201
int getLatAxis() const
Get LatAxis: index of the latitude axis.
Definition: SkyFrame.h:154
double getEquinox() const
Get Equinox: epoch of the mean equinox.
Definition: SkyFrame.h:145
SkyFrame(std::string const &options="")
Definition: SkyFrame.h:124
std::vector< double > getSkyRefP() const
Definition: SkyFrame.h:180
Definition: SkyFrame.h:66
bool getB(std::string const &attrib) const
Definition: Object.h:347
Definition: Frame.h:157
bool getAsTime(int axis) const
Get AsTime(axis) for one axis: format celestial coordinates as times?
Definition: SkyFrame.h:142
void setC(std::string const &attrib, std::string const &value)
Definition: Object.h:460
bool getIsLonAxis(int axis) const
Get IsLonAxis(axis) for one axis: is the specified axis the longitude axis?
Definition: SkyFrame.h:151
void setAsTime(int axis, bool asTime)
Set AsTime(axis) for one axis: format celestial coordinates as times?
Definition: SkyFrame.h:195
virtual ~SkyFrame()
Definition: SkyFrame.h:127
void setEquinox(double equinox)
Set Equinox: epoch of the mean equinox.
Definition: SkyFrame.h:198
int getLonAxis() const
Get LonAxis: index of the longitude axis.
Definition: SkyFrame.h:157
void setProjection(std::string const &projection)
Set Projection: sky projection description.
Definition: SkyFrame.h:204
void setD(std::string const &attrib, double value)
Definition: Object.h:472
std::string formatAxisAttr(std::string const &name, int axis)
Definition: utils.h:78
void setSkyRefP(std::vector< double > const &skyRefP)
Set SkyRefP: position defining orientation of the offset coordinate system.
Definition: SkyFrame.h:218
double getD(std::string const &attrib) const
Definition: Object.h:373
std::shared_ptr< Mapping > skyOffsetMap()
Definition: SkyFrame.h:236
void assertEqual(T1 val1, std::string const &descr1, T2 val2, std::string const &descr2)
Definition: utils.h:47
SkyFrame(AstSkyFrame *rawptr)
Construct a SkyFrame from a raw AST pointer.
Definition: SkyFrame.h:247
std::string const getC(std::string const &attrib) const
Definition: Object.h:360
void setSkyRefIs(std::string const &skyRefIs)
Set SkyRefIs: selects the nature of the offset coordinate system.
Definition: SkyFrame.h:215
Definition: Object.h:51
void setSkyRef(std::vector< double > const &skyRef)
Set SkyRef: position defining location of the offset coordinate system.
Definition: SkyFrame.h:207
std::vector< double > getSkyRef() const
Definition: SkyFrame.h:167
std::string getProjection() const
Get Projection: sky projection description.
Definition: SkyFrame.h:163
bool getAlignOffset() const
Get AlignOffset: align SkyFrames using the offset coordinate system?
Definition: SkyFrame.h:139