lsst::sphgeom::python Namespace Reference

Functions
ptrdiff_t	convertIndex (ptrdiff_t len, pybind11::int_ i)
	Convert a Python index i over a sequence with length len to a non-negative (C++ style) index, and perform a bounds-check.
pybind11::bytes	encode (Region const &self)
	Encode a Region as a pybind11 bytes object.
template<typename R>
std::unique_ptr< R >	decode (pybind11::bytes bytes)
	Decode a Region from a pybind11 bytes object.
template<typename S>
std::vector< std::unique_ptr< Region > >	convert_region_sequence (S const &seq)
	Create a vector of Region (or Region-subclass) pointers by copying the regions from a sized Python iterable (e.g.

Function Documentation

convert_region_sequence()

template<typename S>

std::vector< std::unique_ptr< Region > > lsst::sphgeom::python::convert_region_sequence ( S const & seq )

inline

Create a vector of Region (or Region-subclass) pointers by copying the regions from a sized Python iterable (e.g.

S == py::tuple).

Note that the pybind11 built-in STL conversions don't work, because they use unique_ptr - we can't transfer ownership out of Python, and those converters don't know about our clone methods.

Definition at line 83 of file utils.h.

                                                                               {
    std::vector<std::unique_ptr<Region>> result;
    result.reserve(seq.size());
    for (pybind11::handle py_region : seq) {
        result.push_back(py_region.cast<Region const &>().clone());
    }
    return result;
}

convertIndex()

ptrdiff_t lsst::sphgeom::python::convertIndex ( ptrdiff_t len, pybind11::int_ i )

inline

Convert a Python index i over a sequence with length len to a non-negative (C++ style) index, and perform a bounds-check.

Definition at line 48 of file utils.h.

                                                             {
    auto j = static_cast<ptrdiff_t>(i);
    if ((j == -1 && PyErr_Occurred()) || j < -len || j >= len) {
        PyErr_Clear();
        throw pybind11::index_error(
                pybind11::str("Index {} not in range({}, {})")
                        .format(i, -len, len));
    }
    return (j < 0) ? j + len : j;
}

decode()

template<typename R>

std::unique_ptr< R > lsst::sphgeom::python::decode

(

pybind11::bytes

bytes

)

Decode a Region from a pybind11 bytes object.

Definition at line 69 of file utils.h.

                                             {
    std::uint8_t const *buffer = reinterpret_cast<std::uint8_t const *>(
            PYBIND11_BYTES_AS_STRING(bytes.ptr()));
    size_t n = static_cast<size_t>(PYBIND11_BYTES_SIZE(bytes.ptr()));
    return R::decode(buffer, n);
}

encode()

pybind11::bytes lsst::sphgeom::python::encode ( Region const & self )

inline

Encode a Region as a pybind11 bytes object.

Definition at line 61 of file utils.h.

                                                {
    std::vector<std::uint8_t> bytes = self.encode();
    return pybind11::bytes(reinterpret_cast<char const *>(bytes.data()),
                     bytes.size());
}