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
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
30namespace ast {
31
66class SkyFrame : public Frame {
67 friend class Object;
68
69public:
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;
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
244protected:
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: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
int getI(std::string const &attrib) const
Get the value of an attribute as an int.
Definition Object.cc:178
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
bool getNegLon() const
Get NegLon: display longitude values in the range [-pi,pi]?
Definition SkyFrame.h:162
virtual std::shared_ptr< Object > copyPolymorphic() const override
Return a deep copy of this object.
Definition SkyFrame.h:245
SkyFrame & operator=(SkyFrame const &)=delete
std::vector< double > getSkyRefP() const
Get SkyRefP for both axes: position defining orientation of the offset coordinate system.
Definition SkyFrame.h:182
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
std::shared_ptr< SkyFrame > copy() const
Return a deep copy of this object.
Definition SkyFrame.h:138
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
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
std::vector< double > getSkyRef() const
Get SkyRef for both axes: position defining location of the offset coordinate system.
Definition SkyFrame.h:169
int getLatAxis() const
Get LatAxis: index of the latitude axis.
Definition SkyFrame.h:156
SkyFrame & operator=(SkyFrame &&)=default
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
std::shared_ptr< Mapping > skyOffsetMap()
Get a sky offset map.
Definition SkyFrame.h:238
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
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::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)