LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
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"
30#include "astshim/Frame.h"
31
32namespace ast {
33
107class SpecFrame : public Frame {
108 friend class Object;
109
110public:
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;
126
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
160 std::vector<double> ret(2);
161 astGetRefPos(getRawPtr(), frm.getRawPtr(), &ret[0], &ret[1]);
162 assertOK();
164 return ret;
165 }
166
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();
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
273protected:
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())) {
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
double dec
Definition Match.cc:41
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:472
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
void setC(std::string const &attrib, std::string const &value)
Set the value of an attribute as a string.
Definition Object.h:460
void setB(std::string const &attrib, bool value)
Set the value of an attribute as a bool.
Definition Object.h:448
AstObject const * getRawPtr() const
Get the raw AST pointer.
Definition Object.h:292
SkyFrame is a specialised form of Frame which describes celestial longitude/latitude coordinate syste...
Definition SkyFrame.h:66
A specialised form of one-dimensional Frame which represents various coordinate systems used to descr...
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)
Set the reference position (RefRA and RefDec) from FK5 J2000 RA and Dec (radians).
Definition SpecFrame.h:243
bool getAlignSpecOffset() const
Get AlignSpecOffset: align SpecFrames using the offset coordinate system?
Definition SpecFrame.h:136
std::vector< double > getRefPos(SkyFrame const &frm) const
Get the reference position (specified by RefRA and RefDec) converted to the celestial coordinate syst...
Definition SpecFrame.h:159
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 &&)=default
SpecFrame & operator=(SpecFrame const &)=delete
virtual std::shared_ptr< Object > copyPolymorphic() const override
Return a deep copy of this object.
Definition SpecFrame.h:274
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
void setSourceSys(std::string const &system)
Set SourceSys: source velocity spectral system.
Definition SpecFrame.h:256
void setSourceVel(double vel)
Set SourceVel: source velocity (in the system specified by SourceSys).
Definition SpecFrame.h:262
void setRefPos(SkyFrame const &frm, double lon, double lat)
Set the reference position (RefRA and RefDec) using axis values (in radians) supplied within the cele...
Definition SpecFrame.h:231
SpecFrame(std::string const &options="")
Construct a SpecFrame.
Definition SpecFrame.h:116
std::vector< double > getRefPos() const
Return the reference position (specified by RefRA and RefDec) as FK5 J2000 RA, Dec (radians).
Definition SpecFrame.h:171
void setAlignStdOfRest(std::string const &stdOfRest)
Set AlignStdOfRest: standard of rest in which to align SpecFrames.
Definition SpecFrame.h:211
double getSourceVel() const
Get SourceVel: source velocity (in the system specified by SourceSys).
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::string getAlignStdOfRest() const
Get AlignStdOfRest: standard of rest in which to align SpecFrames.
Definition SpecFrame.h:142
std::string getStdOfRest() const
Get StdOfRest: standard of rest.
Definition SpecFrame.h:199
std::shared_ptr< SpecFrame > copy() const
Return a deep copy of this object.
Definition SpecFrame.h:128
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)
Set AlignSpecOffset: align SpecFrames using the offset coordinate system?
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)
Replace AST__BAD with a quiet NaN in a vector.
Definition utils.h:59
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