LSST Applications g0b6bd0c080+a72a5dd7e6,g1182afd7b4+2a019aa3bb,g17e5ecfddb+2b8207f7de,g1d67935e3f+06cf436103,g38293774b4+ac198e9f13,g396055baef+6a2097e274,g3b44f30a73+6611e0205b,g480783c3b1+98f8679e14,g48ccf36440+89c08d0516,g4b93dc025c+98f8679e14,g5c4744a4d9+a302e8c7f0,g613e996a0d+e1c447f2e0,g6c8d09e9e7+25247a063c,g7271f0639c+98f8679e14,g7a9cd813b8+124095ede6,g9d27549199+a302e8c7f0,ga1cf026fa3+ac198e9f13,ga32aa97882+7403ac30ac,ga786bb30fb+7a139211af,gaa63f70f4e+9994eb9896,gabf319e997+ade567573c,gba47b54d5d+94dc90c3ea,gbec6a3398f+06cf436103,gc6308e37c7+07dd123edb,gc655b1545f+ade567573c,gcc9029db3c+ab229f5caf,gd01420fc67+06cf436103,gd877ba84e5+06cf436103,gdb4cecd868+6f279b5b48,ge2d134c3d5+cc4dbb2e3f,ge448b5faa6+86d1ceac1d,gecc7e12556+98f8679e14,gf3ee170dca+25247a063c,gf4ac96e456+ade567573c,gf9f5ea5b4d+ac198e9f13,gff490e6085+8c2580be5c,w.2022.27
LSST Data Management Base Package
specFrame.cc
Go to the documentation of this file.
1/*
2 * LSST Data Management System
3 *
4 * This product includes software developed by the
5 * LSST Project (http://www.lsst.org/).
6 * See the COPYRIGHT file
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#include <memory>
23#include <vector>
24
25#include <pybind11/pybind11.h>
26#include <pybind11/stl.h>
27
28#include "astshim/Frame.h"
29#include "astshim/Mapping.h"
30#include "astshim/SkyFrame.h"
31#include "astshim/SpecFrame.h"
32
33namespace py = pybind11;
34using namespace pybind11::literals;
35
36namespace ast {
37namespace {
38
39PYBIND11_MODULE(specFrame, mod) {
40 py::module::import("astshim.frame");
41
42 py::class_<SpecFrame, std::shared_ptr<SpecFrame>, Frame> cls(mod, "SpecFrame");
43
44 cls.def(py::init<std::string const &>(), "options"_a = "");
45 cls.def(py::init<SpecFrame const &>());
46
47 cls.def("copy", &SpecFrame::copy);
48
49 cls.def("getAlignSpecOffset", &SpecFrame::getAlignSpecOffset);
50 cls.def("getAlignStdOfRest", &SpecFrame::getAlignStdOfRest);
51 cls.def("getRefDec", &SpecFrame::getRefDec);
52 cls.def("getRefRA", &SpecFrame::getRefRA);
53 cls.def("getRefPos", py::overload_cast<SkyFrame const &>(&SpecFrame::getRefPos, py::const_), "frame"_a);
54 cls.def("getRefPos", py::overload_cast<>(&SpecFrame::getRefPos, py::const_));
55 cls.def("getRestFreq", &SpecFrame::getRestFreq);
56 cls.def("getSourceSys", &SpecFrame::getSourceSys);
57 cls.def("getSourceVel", &SpecFrame::getSourceVel);
58 cls.def("getSourceVRF", &SpecFrame::getSourceVRF);
59 cls.def("getSpecOrigin", &SpecFrame::getSpecOrigin);
60 cls.def("getStdOfRest", &SpecFrame::getStdOfRest);
61
62 cls.def("setAlignSpecOffset", &SpecFrame::setAlignSpecOffset, "align"_a);
63 cls.def("setAlignStdOfRest", &SpecFrame::setAlignStdOfRest, "stdOfRest"_a);
64 cls.def("setRefDec", &SpecFrame::setRefDec, "refDec"_a);
65 cls.def("setRefRA", &SpecFrame::setRefRA, "refRA"_a);
66 cls.def("setRefPos", py::overload_cast<SkyFrame const &, double, double>(&SpecFrame::setRefPos),
67 "frame"_a, "lon"_a, "lat"_a);
68 cls.def("setRefPos", py::overload_cast<double, double>(&SpecFrame::setRefPos), "ra"_a, "dec"_a);
69 cls.def("setRestFreq", py::overload_cast<double>(&SpecFrame::setRestFreq), "freq"_a);
70 cls.def("setRestFreq", py::overload_cast<std::string const &>(&SpecFrame::setRestFreq), "freq"_a);
71 cls.def("setSourceSys", &SpecFrame::setSourceSys, "system"_a);
72 cls.def("setSourceVel", &SpecFrame::setSourceVel, "vel"_a);
73 cls.def("setSourceVRF", &SpecFrame::setSourceVRF, "vrf"_a);
74 cls.def("setSpecOrigin", &SpecFrame::setSpecOrigin, "origin"_a);
75 cls.def("setStdOfRest", &SpecFrame::setStdOfRest, "stdOfRest"_a);
76}
77
78} // namespace
79} // namespace ast
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
bool getAlignSpecOffset() const
Get AlignSpecOffset: align SpecFrames using the offset coordinate system?
Definition: SpecFrame.h:136
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
double getRestFreq() const
Get RestFreq: rest frequency (GHz).
Definition: SpecFrame.h:181
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
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
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
AST wrapper classes and functions.
PYBIND11_MODULE(_cameraGeom, mod)
Definition: _cameraGeom.cc:38