LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
frameDict.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 
24 #include <pybind11/pybind11.h>
25 #include <pybind11/stl.h>
26 
27 namespace py = pybind11;
28 using namespace pybind11::literals;
29 
30 #include "astshim/Channel.h"
31 #include "astshim/Frame.h"
32 #include "astshim/FrameSet.h"
33 #include "astshim/FrameDict.h"
34 #include "astshim/Mapping.h"
35 #include "astshim/Stream.h"
36 
37 namespace ast {
38 namespace {
39 
40 /*
41 Make a FrameDict from a string output by Object.show()
42 
43 Use this instead of the standard ObjectMaker for FrameDict
44 because ObjectMaker would return a FrameSet (since the serialization
45 is the same for both).
46 */
47 class FrameDictMaker {
48 public:
49  FrameDictMaker() = default;
50  ~FrameDictMaker() = default;
51  std::shared_ptr<Object> operator()(std::string const &state) {
52  ast::StringStream stream(state);
53  ast::Channel chan(stream);
54  auto objPtr = chan.read();
55  auto frameSetPtr = std::dynamic_pointer_cast<ast::FrameSet>(objPtr);
56  if (!frameSetPtr) {
57  throw std::runtime_error("Object being unpickled is a " + objPtr->getClassName() +
58  " not a FrameSet");
59  }
60  return std::make_shared<ast::FrameDict>(*frameSetPtr);
61  }
62 };
63 
64 PYBIND11_MODULE(frameDict, mod) {
65  py::module::import("astshim.frameSet");
66 
67  py::class_<FrameDictMaker, std::shared_ptr<FrameDictMaker>> makerCls(mod, "FrameDictMaker");
68  makerCls.def(py::init<>());
69  makerCls.def("__call__", &FrameDictMaker::operator());
70  makerCls.def("__reduce__",
71  [makerCls](FrameDictMaker const &self) { return py::make_tuple(makerCls, py::tuple()); });
72 
73  py::class_<FrameDict, std::shared_ptr<FrameDict>, FrameSet> cls(mod, "FrameDict");
74 
75  cls.def(py::init<Frame const &, std::string const &>(), "frame"_a, "options"_a = "");
76  cls.def(py::init<Frame const &, Mapping const &, Frame const &, std::string const &>(), "baseFrame"_a,
77  "mapping"_a, "currentFrame"_a, "options"_a = "");
78  cls.def(py::init<FrameSet const &>(), "frameSet"_a);
79  cls.def(py::init<FrameDict const &>());
80 
81  cls.def("copy", &FrameDict::copy);
82 
83  cls.def("addFrame", py::overload_cast<int, Mapping const &, Frame const &>(&FrameDict::addFrame),
84  "iframe"_a, "map"_a, "frame"_a);
85  cls.def("addFrame",
86  py::overload_cast<std::string const &, Mapping const &, Frame const &>(&FrameDict::addFrame),
87  "domain"_a, "map"_a, "frame"_a);
88  cls.def("getAllDomains", &FrameDict::getAllDomains);
89  cls.def("getFrame", py::overload_cast<int, bool>(&FrameDict::getFrame, py::const_), "index"_a,
90  "copy"_a = true);
91  cls.def("getFrame", py::overload_cast<std::string const &, bool>(&FrameDict::getFrame, py::const_),
92  "domain"_a, "copy"_a = true);
93  cls.def("getMapping", py::overload_cast<int, int>(&FrameDict::getMapping, py::const_),
94  "from"_a = FrameDict::BASE, "to"_a = FrameDict::CURRENT);
95  cls.def("getMapping", py::overload_cast<int, std::string const &>(&FrameDict::getMapping, py::const_),
96  "from"_a = FrameDict::BASE, "to"_a = FrameDict::CURRENT);
97  cls.def("getMapping", py::overload_cast<std::string const &, int>(&FrameDict::getMapping, py::const_),
98  "from"_a = FrameDict::BASE, "to"_a = FrameDict::CURRENT);
99  cls.def("getMapping",
100  py::overload_cast<std::string const &, std::string const &>(&FrameDict::getMapping, py::const_),
101  "from"_a = FrameDict::BASE, "to"_a = FrameDict::CURRENT);
102  cls.def("getIndex", &FrameDict::getIndex, "domain"_a);
103  cls.def("hasDomain", &FrameDict::hasDomain, "domain"_a);
104  cls.def("mirrorVariants", py::overload_cast<int>(&FrameDict::mirrorVariants), "index"_a);
105  cls.def("mirrorVariants", py::overload_cast<std::string const &>(&FrameDict::mirrorVariants), "domain"_a);
106  cls.def("remapFrame", py::overload_cast<int, Mapping &>(&FrameDict::remapFrame), "index"_a, "map"_a);
107  cls.def("remapFrame", py::overload_cast<std::string const &, Mapping &>(&FrameDict::remapFrame),
108  "domain"_a, "map"_a);
109  cls.def("removeFrame", py::overload_cast<int>(&FrameDict::removeFrame), "index"_a);
110  cls.def("removeFrame", py::overload_cast<std::string const &>(&FrameDict::removeFrame), "domain"_a);
111  cls.def("setBase", py::overload_cast<int>(&FrameDict::setBase), "index"_a);
112  cls.def("setBase", py::overload_cast<std::string const &>(&FrameDict::setBase), "domain"_a);
113  cls.def("setCurrent", py::overload_cast<int>(&FrameDict::setCurrent), "index"_a);
114  cls.def("setCurrent", py::overload_cast<std::string const &>(&FrameDict::setCurrent), "domain"_a);
115  cls.def("setDomain", &FrameDict::setDomain, "domain"_a);
116 
118  cls.def("__reduce__", [makerCls](Object const &self) {
119  std::string state = self.show(false);
120  auto unpickleArgs = py::make_tuple(state);
121  return py::make_tuple(makerCls(), unpickleArgs);
122  });
123 }
124 
125 } // namespace
126 } // namespace ast
Channel provides input/output of AST objects.
Definition: Channel.h:60
String-based source and sink for channels.
Definition: Stream.h:180
AST wrapper classes and functions.
PYBIND11_MODULE(_cameraGeom, mod)
Definition: _cameraGeom.cc:38