_baseColumnView.cc

Go to the documentation of this file.

/*
 * This file is part of afw.
 *
 * Developed for the LSST Data Management System.
 * This product includes software developed by the LSST Project
 * (https://www.lsst.org).
 * See the COPYRIGHT file at the top-level directory of this distribution
 * for details of code ownership.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#include "pybind11/pybind11.h"
#include "pybind11/stl.h"
 
#include "ndarray/pybind11.h"
 
#include "lsst/cpputils/python.h"
 
#include "lsst/afw/table/Key.h"
#include "lsst/afw/table/BaseColumnView.h"
 
namespace py = pybind11;
using namespace py::literals;
 
namespace lsst {
namespace afw {
namespace table {
 
using cpputils::python::WrapperCollection;
 
namespace {
 
using PyBaseColumnView = py::class_<BaseColumnView, std::shared_ptr<BaseColumnView>>;
 
using PyBitsColumn = py::class_<BitsColumn, std::shared_ptr<BitsColumn>>;
 
template <typename T, typename PyClass>
static void declareBaseColumnViewOverloads(PyClass &cls) {
    cls.def("_basicget", [](BaseColumnView & self, Key<T> const &key) -> typename ndarray::Array<T, 1> const {
        return self[key];
    });
};
 
template <typename U, typename PyClass>
static void declareBaseColumnViewArrayOverloads(PyClass &cls) {
    cls.def("_basicget",
            [](BaseColumnView & self, Key<lsst::afw::table::Array<U>> const &key) ->
            typename ndarray::Array<U, 2, 1> const { return self[key]; });
};
 
// TODO: remove this method and any calls to it on DM-32980.
template <typename PyClass>
static void declareBaseColumnViewFlagOverloads(PyClass &cls) {
    cls.def("_basicget",
            [](BaseColumnView &self, Key<Flag> const &key) -> ndarray::Array<bool const, 1, 1> const {
                PyErr_WarnEx(
                    PyExc_FutureWarning,
                    "Flag/bool access via ColumnView objects is deprecated in favor of more complete support "
                    "on Catalog.  Will be removed after v26.",
                    2  // stack level
                );
                return ndarray::copy(self[key]);
            });
};
 
static void declareBaseColumnView(WrapperCollection &wrappers) {
    // We can't call this "BaseColumnView" because that's the typedef for "ColumnViewT<BaseRecord>".
    // This is just a mostly-invisible implementation base class, so we use the same naming convention
    // we use for those.
    wrappers.wrapType(PyBaseColumnView(wrappers.module, "_BaseColumnViewBase"), [](auto &mod, auto &cls) {
        cls.def("getTable", &BaseColumnView::getTable);
        cls.def_property_readonly("table", &BaseColumnView::getTable);
        cls.def("getSchema", &BaseColumnView::getSchema);
        cls.def_property_readonly("schema", &BaseColumnView::getSchema);
        // _getBits supports a Python version of getBits that accepts None and field names as keys
        cls.def("_getBits", &BaseColumnView::getBits);
        cls.def("getAllBits", &BaseColumnView::getAllBits);
        declareBaseColumnViewOverloads<std::uint8_t>(cls);
        declareBaseColumnViewOverloads<std::uint16_t>(cls);
        declareBaseColumnViewOverloads<std::int32_t>(cls);
        declareBaseColumnViewOverloads<std::int64_t>(cls);
        declareBaseColumnViewOverloads<float>(cls);
        declareBaseColumnViewOverloads<double>(cls);
        declareBaseColumnViewFlagOverloads(cls);
        // std::string columns are not supported, because numpy string arrays
        // do not have the same memory model as ours.
        declareBaseColumnViewArrayOverloads<std::uint8_t>(cls);
        declareBaseColumnViewArrayOverloads<std::uint16_t>(cls);
        declareBaseColumnViewArrayOverloads<int>(cls);
        declareBaseColumnViewArrayOverloads<float>(cls);
        declareBaseColumnViewArrayOverloads<double>(cls);
        // lsst::geom::Angle requires custom wrappers, because ndarray doesn't
        // recognize it natively; we just return a double view
        // (e.g. radians).
        cls.def("_basicget", &BaseColumnView::get_radians_array);
    });
}
 
static void declareBitsColumn(WrapperCollection &wrappers) {
    wrappers.wrapType(PyBitsColumn(wrappers.module, "BitsColumn"), [](auto &mod, auto &cls) {
        cls.def("getArray", &BitsColumn::getArray);
        cls.def_property_readonly("array", &BitsColumn::getArray);
        cls.def("getBit", (BitsColumn::SizeT(BitsColumn::*)(Key<Flag> const &) const) & BitsColumn::getBit,
                "key"_a);
        cls.def("getBit", (BitsColumn::SizeT(BitsColumn::*)(std::string const &) const) & BitsColumn::getBit,
                "name"_a);
        cls.def("getMask", (BitsColumn::SizeT(BitsColumn::*)(Key<Flag> const &) const) & BitsColumn::getMask,
                "key"_a);
        cls.def("getMask", (BitsColumn::SizeT(BitsColumn::*)(std::string const &) const) & BitsColumn::getMask,
                "name"_a);
    });
}
 
}  // namespace
 
void wrapBaseColumnView(WrapperCollection &wrappers) {
    declareBaseColumnView(wrappers);
    declareBitsColumn(wrappers);
}
 
}  // namespace table
}  // namespace afw
}  // namespace lsst