LSST Applications g070148d5b3+33e5256705,g0d53e28543+25c8b88941,g0da5cf3356+2dd1178308,g1081da9e2a+62d12e78cb,g17e5ecfddb+7e422d6136,g1c76d35bf8+ede3a706f7,g295839609d+225697d880,g2e2c1a68ba+cc1f6f037e,g2ffcdf413f+853cd4dcde,g38293774b4+62d12e78cb,g3b44f30a73+d953f1ac34,g48ccf36440+885b902d19,g4b2f1765b6+7dedbde6d2,g5320a0a9f6+0c5d6105b6,g56b687f8c9+ede3a706f7,g5c4744a4d9+ef6ac23297,g5ffd174ac0+0c5d6105b6,g6075d09f38+66af417445,g667d525e37+2ced63db88,g670421136f+2ced63db88,g71f27ac40c+2ced63db88,g774830318a+463cbe8d1f,g7876bc68e5+1d137996f1,g7985c39107+62d12e78cb,g7fdac2220c+0fd8241c05,g96f01af41f+368e6903a7,g9ca82378b8+2ced63db88,g9d27549199+ef6ac23297,gabe93b2c52+e3573e3735,gb065e2a02a+3dfbe639da,gbc3249ced9+0c5d6105b6,gbec6a3398f+0c5d6105b6,gc9534b9d65+35b9f25267,gd01420fc67+0c5d6105b6,geee7ff78d7+a14128c129,gf63283c776+ede3a706f7,gfed783d017+0c5d6105b6,w.2022.47
LSST Data Management Base Package
Loading...
Searching...
No Matches
frameSet.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 <pybind11/pybind11.h>
23
24namespace py = pybind11;
25using namespace pybind11::literals;
26
27#include "astshim/Frame.h"
28#include "astshim/FrameSet.h"
29
30namespace ast {
31namespace {
32
33PYBIND11_MODULE(frameSet, mod) {
34 py::module::import("astshim.frame");
35
36 py::class_<FrameSet, std::shared_ptr<FrameSet>, Frame> cls(mod, "FrameSet");
37
38 cls.def(py::init<Frame const &, std::string const &>(), "frame"_a, "options"_a = "");
39 cls.def(py::init<Frame const &, Mapping const &, Frame const &, std::string const &>(), "baseFrame"_a,
40 "mapping"_a, "currentFrame"_a, "options"_a = "");
41 cls.def(py::init<Frame const &>());
42
43 // def_readonly_static makes in only available in the class, not instances, so...
44 cls.attr("BASE") = py::cast(AST__BASE);
45 cls.attr("CURRENT") = py::cast(AST__CURRENT);
46 cls.attr("NOFRAME") = py::cast(AST__NOFRAME);
47
48 cls.def_property("base", &FrameSet::getBase, &FrameSet::setBase);
49 cls.def_property("current", &FrameSet::getCurrent, &FrameSet::setCurrent);
50 cls.def_property_readonly("nFrame", &FrameSet::getNFrame);
51
52 cls.def("copy", &FrameSet::copy);
53 cls.def("addAxes", &FrameSet::addAxes);
54 cls.def("addFrame", &FrameSet::addFrame, "iframe"_a, "map"_a, "frame"_a);
55 cls.def("addVariant", &FrameSet::addVariant, "map"_a, "name"_a);
56 cls.def("getAllVariants", &FrameSet::getAllVariants);
57 cls.def("getFrame", &FrameSet::getFrame, "iframe"_a, "copy"_a = true);
58 cls.def("getMapping", &FrameSet::getMapping, "from"_a = FrameSet::BASE, "to"_a = FrameSet::CURRENT);
59 cls.def("getVariant", &FrameSet::getVariant);
60 cls.def("mirrorVariants", &FrameSet::mirrorVariants, "iframe"_a);
61 cls.def("remapFrame", &FrameSet::remapFrame, "iframe"_a, "map"_a);
62 cls.def("removeFrame", &FrameSet::removeFrame, "iframe"_a);
63 cls.def("renameVariant", &FrameSet::renameVariant, "name"_a);
64}
65
66} // namespace
67} // namespace ast
std::shared_ptr< FrameSet > copy() const
Return a deep copy of this object.
Definition: FrameSet.h:147
void setBase(int ind)
Set Base: index of base Frame.
Definition: FrameSet.h:471
virtual void addFrame(int iframe, Mapping const &map, Frame const &frame)
Add a new Frame and an associated Mapping to this FrameSet so as to define a new coordinate system,...
Definition: FrameSet.h:210
void setCurrent(int ind)
Set Current: index of current Frame, starting from 1.
Definition: FrameSet.h:476
std::string getAllVariants() const
Get AllVariants: a list of all variant mappings stored with the current Frame.
Definition: FrameSet.h:243
void mirrorVariants(int iframe)
Indicates that all access to the Variant attribute of the current Frame should should be forwarded to...
Definition: FrameSet.h:367
int getBase() const
Get Base: index of base Frame.
Definition: FrameSet.h:248
void renameVariant(std::string const &name)
Rename the current Variant of the current Mapping.
Definition: FrameSet.h:463
std::string getVariant() const
Variant: name of variant mapping in use by current Frame
Definition: FrameSet.h:323
void addAxes(Frame const &frame)
Append the axes from a specified Frame to every existing Frame in this FrameSet.
Definition: FrameSet.h:160
std::shared_ptr< Mapping > getMapping(int from=BASE, int to=CURRENT) const
Obtain a Mapping that converts between two Frames in a FrameSet.
Definition: FrameSet.h:304
void remapFrame(int iframe, Mapping &map)
Modify the relationship (i.e.
Definition: FrameSet.h:410
std::shared_ptr< Frame > getFrame(int iframe, bool copy=true) const
Obtain a deep copy of the specified Frame.
Definition: FrameSet.h:270
void addVariant(Mapping const &map, std::string const &name)
Store a new variant Mapping with the current Frame.
Definition: FrameSet.h:234
int getCurrent() const
Get Current: index of current Frame, starting from 1.
Definition: FrameSet.h:253
static int constexpr CURRENT
index of current frame
Definition: FrameSet.h:105
int getNFrame() const
Get FrameSet_NFrame "NFrame": number of Frames in the FrameSet, starting from 1.
Definition: FrameSet.h:316
virtual void removeFrame(int iframe)
Remove a Frame from a FrameSet.
Definition: FrameSet.h:442
static int constexpr BASE
index of base frame
Definition: FrameSet.h:104
AST wrapper classes and functions.
PYBIND11_MODULE(_cameraGeom, mod)
Definition: _cameraGeom.cc:38