LSSTApplications  19.0.0-14-gb0260a2+72efe9b372,20.0.0+7927753e06,20.0.0+8829bf0056,20.0.0+995114c5d2,20.0.0+b6f4b2abd1,20.0.0+bddc4f4cbe,20.0.0-1-g253301a+8829bf0056,20.0.0-1-g2b7511a+0d71a2d77f,20.0.0-1-g5b95a8c+7461dd0434,20.0.0-12-g321c96ea+23efe4bbff,20.0.0-16-gfab17e72e+fdf35455f6,20.0.0-2-g0070d88+ba3ffc8f0b,20.0.0-2-g4dae9ad+ee58a624b3,20.0.0-2-g61b8584+5d3db074ba,20.0.0-2-gb780d76+d529cf1a41,20.0.0-2-ged6426c+226a441f5f,20.0.0-2-gf072044+8829bf0056,20.0.0-2-gf1f7952+ee58a624b3,20.0.0-20-geae50cf+e37fec0aee,20.0.0-25-g3dcad98+544a109665,20.0.0-25-g5eafb0f+ee58a624b3,20.0.0-27-g64178ef+f1f297b00a,20.0.0-3-g4cc78c6+e0676b0dc8,20.0.0-3-g8f21e14+4fd2c12c9a,20.0.0-3-gbd60e8c+187b78b4b8,20.0.0-3-gbecbe05+48431fa087,20.0.0-38-ge4adf513+a12e1f8e37,20.0.0-4-g97dc21a+544a109665,20.0.0-4-gb4befbc+087873070b,20.0.0-4-gf910f65+5d3db074ba,20.0.0-5-gdfe0fee+199202a608,20.0.0-5-gfbfe500+d529cf1a41,20.0.0-6-g64f541c+d529cf1a41,20.0.0-6-g9a5b7a1+a1cd37312e,20.0.0-68-ga3f3dda+5fca18c6a4,20.0.0-9-g4aef684+e18322736b,w.2020.45
LSSTDataManagementBasePackage
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  std::cout << "FrameDictMaker() called\n";
53  ast::StringStream stream(state);
54  ast::Channel chan(stream);
55  auto objPtr = chan.read();
56  auto frameSetPtr = std::dynamic_pointer_cast<ast::FrameSet>(objPtr);
57  if (!frameSetPtr) {
58  throw std::runtime_error("Object being unpickled is a " + objPtr->getClassName() +
59  " not a FrameSet");
60  }
61  return std::make_shared<ast::FrameDict>(*frameSetPtr);
62  }
63 };
64 
65 PYBIND11_MODULE(frameDict, mod) {
66  py::module::import("astshim.frameSet");
67 
68  py::class_<FrameDictMaker, std::shared_ptr<FrameDictMaker>> makerCls(mod, "FrameDictMaker");
69  makerCls.def(py::init<>());
70  makerCls.def("__call__", &FrameDictMaker::operator());
71  makerCls.def("__reduce__",
72  [makerCls](FrameDictMaker const &self) { return py::make_tuple(makerCls, py::tuple()); });
73 
74  py::class_<FrameDict, std::shared_ptr<FrameDict>, FrameSet> cls(mod, "FrameDict");
75 
76  cls.def(py::init<Frame const &, std::string const &>(), "frame"_a, "options"_a = "");
77  cls.def(py::init<Frame const &, Mapping const &, Frame const &, std::string const &>(), "baseFrame"_a,
78  "mapping"_a, "currentFrame"_a, "options"_a = "");
79  cls.def(py::init<FrameSet const &>(), "frameSet"_a);
80  cls.def(py::init<FrameDict const &>());
81 
82  cls.def("copy", &FrameDict::copy);
83 
84  cls.def("addFrame", py::overload_cast<int, Mapping const &, Frame const &>(&FrameDict::addFrame),
85  "iframe"_a, "map"_a, "frame"_a);
86  cls.def("addFrame",
87  py::overload_cast<std::string const &, Mapping const &, Frame const &>(&FrameDict::addFrame),
88  "domain"_a, "map"_a, "frame"_a);
89  cls.def("getAllDomains", &FrameDict::getAllDomains);
90  cls.def("getFrame", py::overload_cast<int, bool>(&FrameDict::getFrame, py::const_), "index"_a,
91  "copy"_a = true);
92  cls.def("getFrame", py::overload_cast<std::string const &, bool>(&FrameDict::getFrame, py::const_),
93  "domain"_a, "copy"_a = true);
94  cls.def("getMapping", py::overload_cast<int, int>(&FrameDict::getMapping, py::const_),
95  "from"_a = FrameDict::BASE, "to"_a = FrameDict::CURRENT);
96  cls.def("getMapping", py::overload_cast<int, std::string const &>(&FrameDict::getMapping, py::const_),
97  "from"_a = FrameDict::BASE, "to"_a = FrameDict::CURRENT);
98  cls.def("getMapping", py::overload_cast<std::string const &, int>(&FrameDict::getMapping, py::const_),
99  "from"_a = FrameDict::BASE, "to"_a = FrameDict::CURRENT);
100  cls.def("getMapping",
101  py::overload_cast<std::string const &, std::string const &>(&FrameDict::getMapping, py::const_),
102  "from"_a = FrameDict::BASE, "to"_a = FrameDict::CURRENT);
103  cls.def("getIndex", &FrameDict::getIndex, "domain"_a);
104  cls.def("hasDomain", &FrameDict::hasDomain, "domain"_a);
105  cls.def("mirrorVariants", py::overload_cast<int>(&FrameDict::mirrorVariants), "index"_a);
106  cls.def("mirrorVariants", py::overload_cast<std::string const &>(&FrameDict::mirrorVariants), "domain"_a);
107  cls.def("remapFrame", py::overload_cast<int, Mapping &>(&FrameDict::remapFrame), "index"_a, "map"_a);
108  cls.def("remapFrame", py::overload_cast<std::string const &, Mapping &>(&FrameDict::remapFrame),
109  "domain"_a, "map"_a);
110  cls.def("removeFrame", py::overload_cast<int>(&FrameDict::removeFrame), "index"_a);
111  cls.def("removeFrame", py::overload_cast<std::string const &>(&FrameDict::removeFrame), "domain"_a);
112  cls.def("setBase", py::overload_cast<int>(&FrameDict::setBase), "index"_a);
113  cls.def("setBase", py::overload_cast<std::string const &>(&FrameDict::setBase), "domain"_a);
114  cls.def("setCurrent", py::overload_cast<int>(&FrameDict::setCurrent), "index"_a);
115  cls.def("setCurrent", py::overload_cast<std::string const &>(&FrameDict::setCurrent), "domain"_a);
116  cls.def("setDomain", &FrameDict::setDomain, "domain"_a);
117 
119  cls.def("__reduce__", [makerCls](Object const &self) {
120  std::string state = self.show(false);
121  auto unpickleArgs = py::make_tuple(state);
122  return py::make_tuple(makerCls(), unpickleArgs);
123  });
124 }
125 
126 } // namespace
127 } // namespace ast
FrameSet.h
std::string
STL class.
std::shared_ptr
STL class.
Frame.h
lsst::afw::geom.transform.transformContinued.cls
cls
Definition: transformContinued.py:33
ast::Channel
Channel provides input/output of AST objects.
Definition: Channel.h:60
std::cout
Channel.h
lsst::ip::isr.fringe.getFrame
def getFrame()
Definition: fringe.py:35
std::runtime_error
STL class.
ast::StringStream
String-based source and sink for channels.
Definition: Stream.h:180
ast
AST wrapper classes and functions.
Definition: attributes_channel.dox:1
Mapping.h
pybind11
Definition: _GenericMap.cc:40
lsst::afw::cameraGeom::PYBIND11_MODULE
PYBIND11_MODULE(camera, mod)
Definition: camera.cc:133
FrameDict.h
Stream.h