lsst::afw::table::io::python Namespace Reference

Functions
template<typename Class , typename... Args>
void	addPersistableMethods (pybind11::class_< Class, Args... > &cls)
	Add table::io::Persistable and PersistableFacade methods to the pybind11 wrapper for a class.

Function Documentation

addPersistableMethods()

template<typename Class , typename... Args>

void lsst::afw::table::io::python::addPersistableMethods

(

pybind11::class_< Class, Args... > &

cls

)

Add table::io::Persistable and PersistableFacade methods to the pybind11 wrapper for a class.

This allows your class to be used without importing lsst.afw.table in Python.

Use as follows:

• When declaring the pybind11 class that wraps your Class in afw, do not list table::io::PersistableFacade<Class> and table::io::Persistable as base classes unless you have to, and in that case be prepared for possible trouble.
• Call this function to wrap the methods that make your object persistable.

Definition at line 56 of file python.h.

                                                                {
    cls.def_static("readFits",
                   (std::shared_ptr<Class>(*)(std::string const &, int)) & PersistableFacade<Class>::readFits,
                   "fileName"_a, "hdu"_a = fits::DEFAULT_HDU);
    cls.def_static(
            "readFits",
            (std::shared_ptr<Class>(*)(fits::MemFileManager &, int)) & PersistableFacade<Class>::readFits,
            "manager"_a, "hdu"_a = fits::DEFAULT_HDU);
    cls.def("writeFits", (void (Class::*)(std::string const &, std::string const &) const) & Class::writeFits,
            "fileName"_a, "mode"_a = "w");
    cls.def("writeFits",
            (void (Class::*)(fits::MemFileManager &, std::string const &) const) & Class::writeFits,
            "manager"_a, "mode"_a = "w");
    cls.def("isPersistable", &Class::isPersistable);
}