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
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>
26#include <pybind11/stl.h>
27
28namespace py = pybind11;
29using namespace pybind11::literals;
30
31#include "astshim/Channel.h"
32#include "astshim/Frame.h"
33#include "astshim/FrameSet.h"
34#include "astshim/FrameDict.h"
35#include "astshim/Mapping.h"
36#include "astshim/Stream.h"
37
38namespace ast {
39namespace {
40
41/*
42Make a FrameDict from a string output by Object.show()
43
44Use this instead of the standard ObjectMaker for FrameDict
45because ObjectMaker would return a FrameSet (since the serialization
46is the same for both).
47*/
48class FrameDictMaker {
49public:
50 FrameDictMaker() = default;
51 ~FrameDictMaker() = default;
52 std::shared_ptr<Object> operator()(std::string const &state) {
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
66void wrapFrameDict(lsst::utils::python::WrapperCollection &wrappers) {
67 using PyFrameDictMaker = py::class_<FrameDictMaker, std::shared_ptr<FrameDictMaker>>;
68 static auto clsMaker = wrappers.wrapType(PyFrameDictMaker(wrappers.module, "FrameDictMaker"), [](auto &mod, auto &cls) {
69 cls.def(py::init<>());
70 cls.def("__call__", &FrameDictMaker::operator());
71 cls.def("__reduce__",
72 [cls](FrameDictMaker const &self) { return py::make_tuple(cls, py::tuple()); });
73 });
74
75 using PyFrameDict = py::class_<FrameDict, std::shared_ptr<FrameDict>, FrameSet>;
76 wrappers.wrapType(PyFrameDict(wrappers.module, "FrameDict"), [](auto &mod, auto &cls) {
77
78 cls.def(py::init<Frame const &, std::string const &>(), "frame"_a, "options"_a = "");
79 cls.def(py::init<Frame const &, Mapping const &, Frame const &, std::string const &>(), "baseFrame"_a,
80 "mapping"_a, "currentFrame"_a, "options"_a = "");
81 cls.def(py::init<FrameSet const &>(), "frameSet"_a);
82 cls.def(py::init<FrameDict const &>());
83
84 cls.def("copy", &FrameDict::copy);
85
86 cls.def("addFrame", py::overload_cast<int, Mapping const &, Frame const &>(&FrameDict::addFrame),
87 "iframe"_a, "map"_a, "frame"_a);
88 cls.def("addFrame",
89 py::overload_cast<std::string const &, Mapping const &, Frame const &>(&FrameDict::addFrame),
90 "domain"_a, "map"_a, "frame"_a);
91 cls.def("getAllDomains", &FrameDict::getAllDomains);
92 cls.def("getFrame", py::overload_cast<int, bool>(&FrameDict::getFrame, py::const_), "index"_a,
93 "copy"_a = true);
94 cls.def("getFrame", py::overload_cast<std::string const &, bool>(&FrameDict::getFrame, py::const_),
95 "domain"_a, "copy"_a = true);
96 cls.def("getMapping", py::overload_cast<int, int>(&FrameDict::getMapping, py::const_),
97 "from"_a = FrameDict::BASE, "to"_a = FrameDict::CURRENT);
98 cls.def("getMapping", py::overload_cast<int, std::string const &>(&FrameDict::getMapping, py::const_),
99 "from"_a = FrameDict::BASE, "to"_a = FrameDict::CURRENT);
100 cls.def("getMapping", py::overload_cast<std::string const &, int>(&FrameDict::getMapping, py::const_),
101 "from"_a = FrameDict::BASE, "to"_a = FrameDict::CURRENT);
102 cls.def("getMapping",
103 py::overload_cast<std::string const &, std::string const &>(&FrameDict::getMapping, py::const_),
104 "from"_a = FrameDict::BASE, "to"_a = FrameDict::CURRENT);
105 cls.def("getIndex", &FrameDict::getIndex, "domain"_a);
106 cls.def("hasDomain", &FrameDict::hasDomain, "domain"_a);
107 cls.def("mirrorVariants", py::overload_cast<int>(&FrameDict::mirrorVariants), "index"_a);
108 cls.def("mirrorVariants", py::overload_cast<std::string const &>(&FrameDict::mirrorVariants), "domain"_a);
109 cls.def("remapFrame", py::overload_cast<int, Mapping &>(&FrameDict::remapFrame), "index"_a, "map"_a);
110 cls.def("remapFrame", py::overload_cast<std::string const &, Mapping &>(&FrameDict::remapFrame),
111 "domain"_a, "map"_a);
112 cls.def("removeFrame", py::overload_cast<int>(&FrameDict::removeFrame), "index"_a);
113 cls.def("removeFrame", py::overload_cast<std::string const &>(&FrameDict::removeFrame), "domain"_a);
114 cls.def("setBase", py::overload_cast<int>(&FrameDict::setBase), "index"_a);
115 cls.def("setBase", py::overload_cast<std::string const &>(&FrameDict::setBase), "domain"_a);
116 cls.def("setCurrent", py::overload_cast<int>(&FrameDict::setCurrent), "index"_a);
117 cls.def("setCurrent", py::overload_cast<std::string const &>(&FrameDict::setCurrent), "domain"_a);
118 cls.def("setDomain", &FrameDict::setDomain, "domain"_a);
119
121 cls.def("__reduce__", [](Object const &self) {
122 std::string state = self.show(false);
123 auto unpickleArgs = py::make_tuple(state);
124 return py::make_tuple(clsMaker(), unpickleArgs);
125 });
126 });
127}
128
129} // namespace ast
Channel provides input/output of AST objects.
Definition Channel.h:60
void addFrame(int iframe, Mapping const &map, Frame const &frame) override
Add a new Frame and an associated Mapping to this FrameSet so as to define a new coordinate system,...
Definition FrameDict.cc:32
void mirrorVariants(std::string const &domain)
Variant of mirrorVariants(int) with the frame specified by domain.
Definition FrameDict.h:210
bool hasDomain(std::string const &domain) const
Return True if a frame in this FrameDict has the specified domain.
Definition FrameDict.h:201
std::shared_ptr< Mapping > getMapping(int from, std::string const &to) const
Variant of FrameSet::getMapping with the second frame specified by domain.
Definition FrameDict.h:162
std::shared_ptr< FrameDict > copy() const
Return a deep copy of this object.
Definition FrameDict.h:123
void setCurrent(std::string const &domain)
Variant of setCurrent(int) with the frame specified by domain.
Definition FrameDict.h:247
std::set< std::string > getAllDomains() const
Get the domain names for all contained Frames (excluding frames with empty or defaulted domain names)...
Definition FrameDict.cc:45
void removeFrame(int iframe) override
Remove a Frame from a FrameSet.
Definition FrameDict.cc:53
void remapFrame(std::string const &domain, Mapping &map)
Variant of remapFrame(int, Mapping&) with the frame specified by domain.
Definition FrameDict.h:219
std::shared_ptr< Frame > getFrame(std::string const &domain, bool copy=true) const
Variant of getFrame(int, bool) where the frame is specified by domain name.
Definition FrameDict.h:151
int getIndex(std::string const &domain) const
Get the index of a frame specified by domain.
Definition FrameDict.h:189
void setBase(std::string const &domain)
Variant of setBase(int) with the frame specified by domain.
Definition FrameDict.h:238
void setDomain(std::string const &domain) override
Set the domain of the current frame (and update the internal dict).
Definition FrameDict.cc:61
static int constexpr CURRENT
index of current frame
Definition FrameSet.h:105
static int constexpr BASE
index of base frame
Definition FrameSet.h:104
String-based source and sink for channels.
Definition Stream.h:180
AST wrapper classes and functions.
void wrapFrameDict(WrapperCollection &)