LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
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
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 {
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
Frame(int naxes, std::string const &options="")
Construct a Frame.
Definition Frame.h:168
static std::shared_ptr< Class > fromAstObject(AstObject *rawObj, bool copy)
Given a bare AST object pointer return a shared pointer to an ast::Object of the correct type.
Definition Object.cc:138
std::shared_ptr< T > copyImpl() const
Implementation of deep copy.
Definition Object.h:320
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
friend class Object
Definition SkyFrame.h:67
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 static_pointer_cast(T... args)
T push_back(T... args)
T size(T... args)
T str(T... args)