lsst.astshim  21.0.0-2-g45278ab+04719a4bac
SpecFrame.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_SPECFRAME_H
23 #define ASTSHIM_SPECFRAME_H
24 
25 #include <memory>
26 #include <vector>
27 
28 #include "astshim/base.h"
29 #include "astshim/detail/utils.h"
30 #include "astshim/Frame.h"
31 
32 namespace ast {
33 
107 class SpecFrame : public Frame {
108  friend class Object;
109 
110 public:
116  explicit SpecFrame(std::string const &options = "")
117  : Frame(reinterpret_cast<AstFrame *>(astSpecFrame("%s", options.c_str()))) {}
118 
119  virtual ~SpecFrame() {}
120 
122  SpecFrame(SpecFrame const &) = default;
123  SpecFrame(SpecFrame &&) = default;
124  SpecFrame &operator=(SpecFrame const &) = delete;
125  SpecFrame &operator=(SpecFrame &&) = default;
126 
128  std::shared_ptr<SpecFrame> copy() const {
129  return std::static_pointer_cast<SpecFrame>(copyPolymorphic());
130  }
131 
136  bool getAlignSpecOffset() const { return getB("AlignSpecOffset"); }
137 
142  std::string getAlignStdOfRest() const { return getC("AlignStdOfRest"); }
143 
145  std::string getRefDec() const { return getC("RefDec"); }
146 
148  std::string getRefRA() const { return getC("RefRA"); }
149 
159  std::vector<double> getRefPos(SkyFrame const &frm) const {
160  std::vector<double> ret(2);
161  astGetRefPos(getRawPtr(), frm.getRawPtr(), &ret[0], &ret[1]);
162  assertOK();
163  detail::astBadToNan(ret);
164  return ret;
165  }
166 
171  std::vector<double> getRefPos() const {
172  std::vector<double> ret(2);
173  // using NULL instead of nullptr avoids a compiler warning about comparing NULL to nullptr_t
174  astGetRefPos(getRawPtr(), NULL, &ret[0], &ret[1]);
175  assertOK();
176  detail::astBadToNan(ret);
177  return ret;
178  }
179 
181  double getRestFreq() const { return getD("RestFreq"); }
182 
184  std::string getSourceSys() const { return getC("SourceSys"); }
185 
190  double getSourceVel() const { return getD("SourceVel"); }
191 
193  std::string getSourceVRF() const { return getC("SourceVRF"); }
194 
196  double getSpecOrigin() const { return getD("SpecOrigin"); }
197 
199  std::string getStdOfRest() const { return getC("StdOfRest"); }
200 
205  void setAlignSpecOffset(bool align) { setB("AlignSpecOffset", align); }
206 
211  void setAlignStdOfRest(std::string const &stdOfRest) { setC("AlignStdOfRest", stdOfRest); }
212 
214  void setRefDec(std::string const &refDec) { setC("RefDec", refDec); }
215 
217  void setRefRA(std::string const &refRA) { setC("RefRA", refRA); }
218 
231  void setRefPos(SkyFrame const &frm, double lon, double lat) {
232  astSetRefPos(getRawPtr(), frm.getRawPtr(), lon, lat);
233  assertOK();
234  }
235 
243  void setRefPos(double ra, double dec) {
244  // using NULL instead of nullptr avoids a compiler warning about comparing NULL to nullptr_t
245  astSetRefPos(getRawPtr(), NULL, ra, dec);
246  assertOK();
247  }
248 
250  void setRestFreq(double freq) { setD("RestFreq", freq); }
251 
253  void setRestFreq(std::string const &freq) { setC("RestFreq", freq); }
254 
256  void setSourceSys(std::string const &system) { setC("SourceSys", system); }
257 
262  void setSourceVel(double vel) { setD("SourceVel", vel); }
263 
265  void setSourceVRF(std::string const &vrf) { setC("SourceVRF", vrf); }
266 
268  void setSpecOrigin(double origin) { setD("SpecOrigin", origin); }
269 
271  void setStdOfRest(std::string const &stdOfRest) { setC("StdOfRest", stdOfRest); }
272 
273 protected:
274  virtual std::shared_ptr<Object> copyPolymorphic() const override {
275  return copyImpl<SpecFrame, AstSpecFrame>();
276  }
277 
279  explicit SpecFrame(AstSpecFrame *rawptr) : Frame(reinterpret_cast<AstFrame *>(rawptr)) {
280  if (!astIsASpecFrame(getRawPtr())) {
281  std::ostringstream os;
282  os << "this is a " << getClassName() << ", which is not a SpecFrame";
283  throw std::invalid_argument(os.str());
284  }
285  }
286 };
287 
288 } // namespace ast
289 
290 #endif
Definition: Frame.h:157
Definition: Object.h:51
void setD(std::string const &attrib, double value)
Definition: Object.h:476
double getD(std::string const &attrib) const
Definition: Object.h:374
std::string const getC(std::string const &attrib) const
Definition: Object.h:361
std::string getClassName() const
Definition: Object.h:139
bool getB(std::string const &attrib) const
Definition: Object.h:348
AstObject const * getRawPtr() const
Definition: Object.h:292
void setC(std::string const &attrib, std::string const &value)
Definition: Object.h:464
void setB(std::string const &attrib, bool value)
Definition: Object.h:452
Definition: SkyFrame.h:66
Definition: SpecFrame.h:107
void setStdOfRest(std::string const &stdOfRest)
Set StdOfRest: standard of rest.
Definition: SpecFrame.h:271
std::string getSourceVRF() const
Get SourceVRF: source velocity rest frame.
Definition: SpecFrame.h:193
void setRefPos(double ra, double dec)
Definition: SpecFrame.h:243
bool getAlignSpecOffset() const
Definition: SpecFrame.h:136
std::shared_ptr< SpecFrame > copy() const
Return a deep copy of this object.
Definition: SpecFrame.h:128
std::string getRefRA() const
Get RefRA: right ascension of the source (FK5 J2000, "hh:mm:ss.s").
Definition: SpecFrame.h:148
std::string getRefDec() const
Get RefDec: declination of the source (FK5 J2000, "dd:mm:ss.s").
Definition: SpecFrame.h:145
SpecFrame & operator=(SpecFrame const &)=delete
SpecFrame(SpecFrame const &)=default
Copy constructor: make a deep copy.
double getRestFreq() const
Get RestFreq: rest frequency (GHz).
Definition: SpecFrame.h:181
SpecFrame(SpecFrame &&)=default
virtual std::shared_ptr< Object > copyPolymorphic() const override
Definition: SpecFrame.h:274
void setSourceSys(std::string const &system)
Set SourceSys: source velocity spectral system.
Definition: SpecFrame.h:256
void setSourceVel(double vel)
Definition: SpecFrame.h:262
void setRefPos(SkyFrame const &frm, double lon, double lat)
Definition: SpecFrame.h:231
SpecFrame(std::string const &options="")
Definition: SpecFrame.h:116
SpecFrame & operator=(SpecFrame &&)=default
void setAlignStdOfRest(std::string const &stdOfRest)
Definition: SpecFrame.h:211
double getSourceVel() const
Definition: SpecFrame.h:190
void setRefRA(std::string const &refRA)
Set RefRA: right ascension of the source (FK5 J2000, "hh:mm:ss.s").
Definition: SpecFrame.h:217
std::vector< double > getRefPos(SkyFrame const &frm) const
Definition: SpecFrame.h:159
std::string getAlignStdOfRest() const
Definition: SpecFrame.h:142
std::string getStdOfRest() const
Get StdOfRest: standard of rest.
Definition: SpecFrame.h:199
std::vector< double > getRefPos() const
Definition: SpecFrame.h:171
void setRestFreq(double freq)
Set RestFreq: rest frequency in GHz.
Definition: SpecFrame.h:250
void setSourceVRF(std::string const &vrf)
Set SourceVRF: source velocity rest frame.
Definition: SpecFrame.h:265
SpecFrame(AstSpecFrame *rawptr)
Construct a SpecFrame from a raw AST pointer.
Definition: SpecFrame.h:279
virtual ~SpecFrame()
Definition: SpecFrame.h:119
void setRefDec(std::string const &refDec)
Set RefDec: declination of the source (FK5 J2000, "dd:mm:ss.s").
Definition: SpecFrame.h:214
double getSpecOrigin() const
Get SpecOrigin: the zero point for SpecFrame axis values.
Definition: SpecFrame.h:196
void setSpecOrigin(double origin)
Set SpecOrigin: the zero point for SpecFrame axis values.
Definition: SpecFrame.h:268
void setAlignSpecOffset(bool align)
Definition: SpecFrame.h:205
std::string getSourceSys() const
Get SourceSys: source velocity spectral system.
Definition: SpecFrame.h:184
void setRestFreq(std::string const &freq)
Set RestFreq: rest frequency in user-specified units.
Definition: SpecFrame.h:253
void astBadToNan(std::vector< double > &p)
Definition: utils.h:59
AST wrapper classes and functions.
Definition: attributes_channel.dox:1
void assertOK(AstObject *rawPtr1=nullptr, AstObject *rawPtr2=nullptr)
Definition: base.cc:49