LSSTApplications  19.0.0+10,19.0.0+80,19.0.0-1-g20d9b18+31,19.0.0-1-g49a97f9+4,19.0.0-1-g8c57eb9+31,19.0.0-1-g9a028c0+13,19.0.0-1-ga72da6b+3,19.0.0-1-gb77924a+15,19.0.0-1-gbfe0924+66,19.0.0-1-gc3516c3,19.0.0-1-gefe1d0d+49,19.0.0-1-gf8cb8b4+3,19.0.0-14-g7511ce4+6,19.0.0-16-g3dc1a33c+6,19.0.0-17-g59f0e8a+4,19.0.0-17-g9c22e3c+9,19.0.0-18-g35bb99870+2,19.0.0-19-g2772d4a+9,19.0.0-2-g260436e+53,19.0.0-2-g31cdcee,19.0.0-2-g9675b69+3,19.0.0-2-gaa2795f,19.0.0-2-gbcc4de1,19.0.0-2-gd6f004e+6,19.0.0-2-gde8e5e3+5,19.0.0-2-gff6972b+15,19.0.0-21-ge306cd8,19.0.0-21-gf122e69+2,19.0.0-3-g2d43a51+2,19.0.0-3-gf3b1435+6,19.0.0-4-g56feb96,19.0.0-4-gac56cce+17,19.0.0-49-gce872c1+1,19.0.0-5-g66946eb+6,19.0.0-5-gd8897ba+6,19.0.0-51-gfc4a647e,19.0.0-7-g686a884+5,19.0.0-7-g886f805+5,19.0.0-8-g305ff64,w.2020.17
LSSTDataManagementBasePackage
python.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 /*
3  * LSST Data Management System
4  * See COPYRIGHT file at the top of the source tree.
5  *
6  * This product includes software developed by the
7  * LSST Project (http://www.lsst.org/).
8  *
9  * This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the LSST License Statement and
20  * the GNU General Public License along with this program. If not,
21  * see <http://www.lsstcorp.org/LegalNotices/>.
22  */
23 
24 #ifndef LSST_AFW_TABLE_IO_PYTHON_H
25 #define LSST_AFW_TABLE_IO_PYTHON_H
26 
27 #include "pybind11/pybind11.h"
28 
29 #include <memory>
30 #include <string>
31 
32 #include "lsst/afw/fits.h"
34 
35 namespace py = pybind11;
36 using namespace py::literals;
37 
38 namespace lsst {
39 namespace afw {
40 namespace table {
41 namespace io {
42 namespace python {
43 
62 template <typename T>
63 [[deprecated("Use `addPersistableMethods` instead. To be removed after 20.0.0.")]] // DM-22814
64  void
66  using namespace pybind11::literals;
67 
68  pybind11::class_<PersistableFacade<T>, std::shared_ptr<PersistableFacade<T>>> cls(
69  module, ("PersistableFacade" + suffix).c_str());
70  cls.def_static("readFits",
72  "fileName"_a, "hdu"_a = fits::DEFAULT_HDU);
73  cls.def_static("readFits",
74  (std::shared_ptr<T>(*)(fits::MemFileManager &, int)) & PersistableFacade<T>::readFits,
75  "manager"_a, "hdu"_a = fits::DEFAULT_HDU);
76 }
77 
89 template <typename Class, typename... Args>
90 void addPersistableMethods(pybind11::class_<Class, Args...> &cls) {
91  cls.def_static("readFits",
93  "fileName"_a, "hdu"_a = fits::DEFAULT_HDU);
94  cls.def_static(
95  "readFits",
96  (std::shared_ptr<Class>(*)(fits::MemFileManager &, int)) & PersistableFacade<Class>::readFits,
97  "manager"_a, "hdu"_a = fits::DEFAULT_HDU);
98  cls.def("writeFits", (void (Class::*)(std::string const &, std::string const &) const) & Class::writeFits,
99  "fileName"_a, "mode"_a = "w");
100  cls.def("writeFits",
101  (void (Class::*)(fits::MemFileManager &, std::string const &) const) & Class::writeFits,
102  "manager"_a, "mode"_a = "w");
103  cls.def("isPersistable", &Class::isPersistable);
104 }
105 } // namespace python
106 } // namespace io
107 } // namespace table
108 } // namespace afw
109 } // namespace lsst
110 
111 #endif
void declarePersistableFacade(pybind11::module &module, std::string const &suffix)
Wraps an instantiation of PersistableFacade.
Definition: python.h:65
void addPersistableMethods(pybind11::class_< Class, Args... > &cls)
Add table::io::Persistable and PersistableFacade methods to the pybind11 wrapper for a class...
Definition: python.h:90
STL class.
A base class for image defects.
Lifetime-management for memory that goes into FITS memory files.
Definition: fits.h:121
A CRTP facade class for subclasses of Persistable.
Definition: Persistable.h:176
const int DEFAULT_HDU
Specify that the default HDU should be read.
Definition: fitsDefaults.h:18