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

Namespaces
namespace	python

Classes
struct	ArchiveIndexSchema
	Schema for the index catalog that specifies where objects are stored in the data catalogs. More...
class	CatalogVector
	A vector of catalogs used by Persistable. More...
class	FitsColumnReader
	Polymorphic reader interface used to read different kinds of objects from one or more FITS binary table columns. More...
class	FitsReader
	A utility class for reading FITS binary tables. More...
class	FitsSchemaInputMapper
	A class that describes a mapping from a FITS binary table to an afw::table Schema. More...
struct	FitsSchemaItem
	A structure that describes a field as a collection of related strings read from the FITS header. More...
class	FitsWriter
	Writer object for FITS binary tables. More...
class	InputArchive
	A multi-catalog archive object used to load table::io::Persistable objects. More...
class	MalformedArchiveError
	An exception thrown when an InputArchive's contents do not make sense. More...
class	OutputArchive
	A multi-catalog archive object used to save table::io::Persistable objects. More...
class	OutputArchiveHandle
	An object passed to Persistable::write to allow it to persist itself. More...
class	Persistable
	A base class for objects that can be persisted via afw::table::io Archive classes. More...
class	PersistableFacade
	A CRTP facade class for subclasses of Persistable. More...
class	PersistableFactory
	A base class for factory classes used to reconstruct objects from records. More...
class	PersistenceError
	An exception thrown when problems occur during persistence. More...
class	WrapperCollection
	A helper class for subdividing pybind11 module across multiple translation units (i.e. More...

Typedefs
using	PyInputArchive = py::class_<InputArchive, std::shared_ptr<InputArchive>>
using	PyOutputArchive = py::class_<OutputArchive, std::shared_ptr<OutputArchive>>
using	PyPersistable = py::class_<Persistable, std::shared_ptr<Persistable>>

Functions
void	wrapFits (cpputils::python::WrapperCollection &wrappers)
void	wrapInputArchive (cpputils::python::WrapperCollection &wrappers)
void	wrapPersistable (WrapperCollection &)
void	wrapOutputArchive (WrapperCollection &)
	PYBIND11_MODULE (_io, mod)
void	erase (int column)

Typedef Documentation

PyInputArchive

using lsst::afw::table::io::PyInputArchive = py::class_<InputArchive, std::shared_ptr<InputArchive>>

Definition at line 37 of file _inputArchive.cc.

PyOutputArchive

using lsst::afw::table::io::PyOutputArchive = py::class_<OutputArchive, std::shared_ptr<OutputArchive>>

Definition at line 38 of file _outputArchive.cc.

PyPersistable

using lsst::afw::table::io::PyPersistable = py::class_<Persistable, std::shared_ptr<Persistable>>

Definition at line 37 of file _persistable.cc.

Function Documentation

erase()

void lsst::afw::table::io::erase

(

int

column

)

PYBIND11_MODULE()

lsst::afw::table::io::PYBIND11_MODULE	(	_io	,
		mod	)

Definition at line 43 of file _io.cc.

                          {
    WrapperCollection wrappers(mod, "lsst.afw.table.io");
    wrapPersistable(wrappers);
    wrapFits(wrappers);
    wrapInputArchive(wrappers);
    wrapOutputArchive(wrappers);
    wrappers.finish();
}

wrapFits()

void lsst::afw::table::io::wrapFits

(

cpputils::python::WrapperCollection &

wrappers

)

Definition at line 36 of file _fits.cc.

                                                         {
    wrappers.wrap([](auto& mod) {
        mod.def("setPreppedRowsFactor",
                [](std::size_t n) { FitsSchemaInputMapper::PREPPED_ROWS_FACTOR = n; });
        mod.def("getPreppedRowsFactor", []() { return FitsSchemaInputMapper::PREPPED_ROWS_FACTOR; });
    });
}

wrapInputArchive()

void lsst::afw::table::io::wrapInputArchive

(

cpputils::python::WrapperCollection &

wrappers

)

Definition at line 39 of file _inputArchive.cc.

                                                                 {
    wrappers.wrapType(PyInputArchive(wrappers.module, "InputArchive"), [](auto &mod, auto &cls) {
        cls.def("get", &InputArchive::get<Persistable>);
        cls.def("readFits", &InputArchive::readFits);
    });
}

wrapOutputArchive()

void lsst::afw::table::io::wrapOutputArchive

(

WrapperCollection &

wrappers

)

Definition at line 40 of file _outputArchive.cc.

                                                                  {
    wrappers.wrapType(PyOutputArchive(wrappers.module, "OutputArchive"), [](auto &mod, auto &cls) {
        cls.def(py::init<>());
        cls.def("put",
                py::overload_cast<std::shared_ptr<Persistable const>, bool>(&OutputArchive::put),
                "obj"_a, "permissive"_a=false
                );
        cls.def("writeFits", &OutputArchive::writeFits);
    });
}

wrapPersistable()

void lsst::afw::table::io::wrapPersistable

(

WrapperCollection &

wrappers

)

Definition at line 39 of file _persistable.cc.

                                                                {
    // TODO: uncomment once afw.fits uses WrapperCollection
    // wrappers.addSignatureDependency("lsst.afw.fits");
 
    wrappers.wrapType(PyPersistable(wrappers.module, "Persistable"), [](auto &mod, auto &cls) {
        cls.def("writeFits",
                (void (Persistable::*)(std::string const &, std::string const &) const) &
                        Persistable::writeFits,
                "fileName"_a, "mode"_a = "w");
        cls.def("writeFits",
                (void (Persistable::*)(fits::MemFileManager &, std::string const &) const) &
                        Persistable::writeFits,
                "manager"_a, "mode"_a = "w");
        cls.def("isPersistable", &Persistable::isPersistable);
    });
}