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
keyMap.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#include "astshim/base.h"
28#include "astshim/KeyMap.h"
29#include "astshim/Object.h"
30
31namespace py = pybind11;
32using namespace pybind11::literals;
33
34namespace ast {
35namespace {
36
37PYBIND11_MODULE(keyMap, mod) {
38 py::module::import("astshim.object");
39
40 py::class_<KeyMap, std::shared_ptr<KeyMap>, Object> cls(mod, "KeyMap");
41
42 cls.def(py::init<std::string const &>(), "options"_a = "");
43
44 cls.def("copy", &KeyMap::copy);
45 cls.def("defined", &KeyMap::defined, "key"_a);
46 cls.def("key", &KeyMap::key, "ind"_a);
47 cls.def("hasKey", &KeyMap::hasKey, "key"_a);
48 cls.def("length", &KeyMap::length);
49 cls.def("__len__", &KeyMap::size);
50
51 cls.def("getD", py::overload_cast<std::string const &, int>(&KeyMap::getD, py::const_), "key"_a, "ind"_a);
52 cls.def("getD", py::overload_cast<std::string const &>(&KeyMap::getD, py::const_), "key"_a);
53 cls.def("getF", py::overload_cast<std::string const &, int>(&KeyMap::getF, py::const_), "key"_a, "ind"_a);
54 cls.def("getF", py::overload_cast<std::string const &>(&KeyMap::getF, py::const_), "key"_a);
55 cls.def("getI", py::overload_cast<std::string const &, int>(&KeyMap::getI, py::const_), "key"_a, "ind"_a);
56 cls.def("getI", py::overload_cast<std::string const &>(&KeyMap::getI, py::const_), "key"_a);
57 cls.def("getS", py::overload_cast<std::string const &, int>(&KeyMap::getS, py::const_), "key"_a, "ind"_a);
58 cls.def("getS", py::overload_cast<std::string const &>(&KeyMap::getS, py::const_), "key"_a);
59 cls.def("getB", py::overload_cast<std::string const &, int>(&KeyMap::getB, py::const_), "key"_a, "ind"_a);
60 cls.def("getB", py::overload_cast<std::string const &>(&KeyMap::getB, py::const_), "key"_a);
61 cls.def("getC", py::overload_cast<std::string const &, int>(&KeyMap::getC, py::const_), "key"_a, "ind"_a);
62 cls.def("getC", py::overload_cast<std::string const &>(&KeyMap::getC, py::const_), "key"_a);
63 cls.def("getA", py::overload_cast<std::string const &, int>(&KeyMap::getA, py::const_), "key"_a, "ind"_a);
64 cls.def("getA", py::overload_cast<std::string const &>(&KeyMap::getA, py::const_), "key"_a);
65
66 cls.def("putD", py::overload_cast<std::string const &, double, std::string const &>(&KeyMap::putD),
67 "key"_a, "value"_a, "comment"_a = "");
68 cls.def("putD",
69 py::overload_cast<std::string const &, std::vector<double> const &, std::string const &>(
70 &KeyMap::putD),
71 "key"_a, "vec"_a, "comment"_a = "");
72 cls.def("putF", py::overload_cast<std::string const &, float, std::string const &>(&KeyMap::putF),
73 "key"_a, "value"_a, "comment"_a = "");
74 cls.def("putF",
75 py::overload_cast<std::string const &, std::vector<float> const &, std::string const &>(
76 &KeyMap::putF),
77 "key"_a, "vec"_a, "comment"_a = "");
78 cls.def("putI", py::overload_cast<std::string const &, int, std::string const &>(&KeyMap::putI), "key"_a,
79 "value"_a, "comment"_a = "");
80 cls.def("putI",
81 py::overload_cast<std::string const &, std::vector<int> const &, std::string const &>(
82 &KeyMap::putI),
83 "key"_a, "vec"_a, "comment"_a = "");
84 cls.def("putS", py::overload_cast<std::string const &, short int, std::string const &>(&KeyMap::putS),
85 "key"_a, "value"_a, "comment"_a = "");
86 cls.def("putS",
87 py::overload_cast<std::string const &, std::vector<short int> const &, std::string const &>(
88 &KeyMap::putS),
89 "key"_a, "vec"_a, "comment"_a = "");
90 cls.def("putB", py::overload_cast<std::string const &, char unsigned, std::string const &>(&KeyMap::putB),
91 "key"_a, "value"_a, "comment"_a = "");
92 cls.def("putB",
93 py::overload_cast<std::string const &, std::vector<char unsigned> const &, std::string const &>(
94 &KeyMap::putB),
95 "key"_a, "vec"_a, "comment"_a = "");
96 cls.def("putC",
97 py::overload_cast<std::string const &, std::string const &, std::string const &>(&KeyMap::putC),
98 "key"_a, "value"_a, "comment"_a = "");
99 cls.def("putC",
100 py::overload_cast<std::string const &, std::vector<std::string> const &, std::string const &>(
101 &KeyMap::putC),
102 "key"_a, "vec"_a, "comment"_a = "");
103 cls.def("putA",
104 py::overload_cast<std::string const &, Object const &, std::string const &>(&KeyMap::putA),
105 "key"_a, "value"_a, "comment"_a = "");
106 cls.def("putA",
107 py::overload_cast<std::string const &, std::vector<std::shared_ptr<Object const>> const &,
108 std::string const &>(&KeyMap::putA),
109 "key"_a, "vec"_a, "comment"_a = "");
110
111 cls.def("putU", py::overload_cast<std::string const &, std::string const &>(&KeyMap::putU), "key"_a,
112 "comment"_a = "");
113
114 // there no need to wrap float, short int and unsigned char versions since the type of the key
115 // is already known and the data will be cast
116 // list int first, then float because the first match is used
117 cls.def("append", py::overload_cast<std::string const &, int>(&KeyMap::append), "key"_a, "value"_a);
118 cls.def("append", py::overload_cast<std::string const &, double>(&KeyMap::append), "key"_a, "value"_a);
119 cls.def("append", py::overload_cast<std::string const &, std::string const &>(&KeyMap::append), "key"_a,
120 "value"_a);
121 cls.def("append", py::overload_cast<std::string const &, Object const &>(&KeyMap::append), "key"_a,
122 "value"_a);
123
124 // there no need to wrap float, short int and unsigned char versions since the type of the key
125 // is already known and the data will be cast
126 // list int first, then float because the first match is used
127 cls.def("replace", py::overload_cast<std::string const &, int, int>(&KeyMap::replace), "key"_a, "ind"_a,
128 "value"_a);
129 cls.def("replace", py::overload_cast<std::string const &, int, double>(&KeyMap::replace), "key"_a,
130 "ind"_a, "value"_a);
131 cls.def("replace", py::overload_cast<std::string const &, int, std::string const &>(&KeyMap::replace),
132 "key"_a, "ind"_a, "value"_a);
133 cls.def("replace", py::overload_cast<std::string const &, int, Object const &>(&KeyMap::replace), "key"_a,
134 "ind"_a, "value"_a);
135
136 cls.def("remove", &KeyMap::remove, "key"_a);
137 cls.def("rename", &KeyMap::rename, "oldKey"_a, "newKey"_a);
138 cls.def("type", &KeyMap::type, "key"_a);
139}
140
141} // namespace
142} // namespace ast
ast::KeyMap::getD
double getD(std::string const &key, int ind) const
Get one double value for a given key.
Definition: KeyMap.h:164
ast::KeyMap::hasKey
bool hasKey(std::string const &key) const
Does this map contain the specified key?
Definition: KeyMap.h:142
ast::KeyMap::getI
int getI(std::string const &key, int ind) const
Get one int value for a given key.
Definition: KeyMap.h:210
ast::KeyMap::length
int length(std::string const &key) const
Get the size of the vector for the specified key; return 0 if key not found or value is undefined.
Definition: KeyMap.h:150
ast::KeyMap::putC
void putC(std::string const &key, std::string const &value, std::string const &comment="")
Add a string.
Definition: KeyMap.h:402
ast::KeyMap::putB
void putB(std::string const &key, char unsigned value, std::string const &comment="")
Add a char.
Definition: KeyMap.h:387
ast::KeyMap::remove
void remove(std::string const &key)
Remove the specified entry.
Definition: KeyMap.h:558
ast::KeyMap::getF
float getF(std::string const &key, int ind) const
Get one float value for a given key.
Definition: KeyMap.h:187
ast::KeyMap::defined
bool defined(std::string const &key) const
Does this map contain the specified key, and if so, does it have a defined value?
Definition: KeyMap.h:117
ast::KeyMap::putS
void putS(std::string const &key, short int value, std::string const &comment="")
Add a short int.
Definition: KeyMap.h:373
ast::KeyMap::putU
void putU(std::string const &key, std::string const &comment="")
Add a new entry, but no value is stored with the entry.
Definition: KeyMap.h:448
ast::KeyMap::rename
void rename(std::string const &oldKey, std::string const &newKey)
Rename the specified entry.
Definition: KeyMap.h:568
ast::KeyMap::getS
short int getS(std::string const &key, int ind) const
Get one short int value for a given key.
Definition: KeyMap.h:233
ast::KeyMap::key
std::string key(int ind) const
Get the key at the specified index.
Definition: KeyMap.h:125
ast::KeyMap::size
int size() const
Get the number of keys.
Definition: KeyMap.h:157
ast::KeyMap::getA
std::shared_ptr< Object > getA(std::string const &key, int ind) const
Get one Object for a given key; the object is deep copied.
Definition: KeyMap.h:310
ast::KeyMap::replace
void replace(std::string const &key, int i, double value)
Replace an element of a vector of doubles in a KeyMap.
Definition: KeyMap.h:504
ast::KeyMap::putF
void putF(std::string const &key, float value, std::string const &comment="")
Add a float.
Definition: KeyMap.h:345
ast::KeyMap::append
void append(std::string const &key, double value)
Append an element to a vector of doubles in a KeyMap.
Definition: KeyMap.h:454
ast::KeyMap::getC
std::string getC(std::string const &key, int ind) const
Get one std::string value for a given key.
Definition: KeyMap.h:279
ast::KeyMap::putI
void putI(std::string const &key, int value, std::string const &comment="")
Add an int.
Definition: KeyMap.h:359
ast::KeyMap::getB
char unsigned getB(std::string const &key, int ind) const
Get one char value for a given key.
Definition: KeyMap.h:256
ast::KeyMap::copy
std::shared_ptr< KeyMap > copy() const
Return a deep copy of this object.
Definition: KeyMap.h:107
ast::KeyMap::putA
void putA(std::string const &key, Object const &obj, std::string const &comment="")
Add an Object, which is deep copied.
Definition: KeyMap.h:421
ast::KeyMap::type
DataType type(std::string const &key)
Get the type suffix for a given key.
Definition: KeyMap.h:576
ast::KeyMap::putD
void putD(std::string const &key, double value, std::string const &comment="")
Add a double value.
Definition: KeyMap.h:331
ast
AST wrapper classes and functions.
Definition: attributes_channel.dox:1
lsst::afw::cameraGeom::PYBIND11_MODULE
PYBIND11_MODULE(_cameraGeom, mod)
Definition: _cameraGeom.cc:38
Generated on Thu Jul 7 2022 08:23:01 for LSST Applications by doxygen 1.9.2