Loading [MathJax]/extensions/tex2jax.js
LSST Applications g0fba68d861+05816baf74,g1ec0fe41b4+f536777771,g1fd858c14a+a9301854fb,g35bb328faa+fcb1d3bbc8,g4af146b050+a5c07d5b1d,g4d2262a081+6e5fcc2a4e,g53246c7159+fcb1d3bbc8,g56a49b3a55+9c12191793,g5a012ec0e7+3632fc3ff3,g60b5630c4e+ded28b650d,g67b6fd64d1+ed4b5058f4,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g8352419a5c+fcb1d3bbc8,g87b7deb4dc+7b42cf88bf,g8852436030+e5453db6e6,g89139ef638+ed4b5058f4,g8e3bb8577d+d38d73bdbd,g9125e01d80+fcb1d3bbc8,g94187f82dc+ded28b650d,g989de1cb63+ed4b5058f4,g9d31334357+ded28b650d,g9f33ca652e+50a8019d8c,gabe3b4be73+1e0a283bba,gabf8522325+fa80ff7197,gb1101e3267+d9fb1f8026,gb58c049af0+f03b321e39,gb665e3612d+2a0c9e9e84,gb89ab40317+ed4b5058f4,gcf25f946ba+e5453db6e6,gd6cbbdb0b4+bb83cc51f8,gdd1046aedd+ded28b650d,gde0f65d7ad+941d412827,ge278dab8ac+d65b3c2b70,ge410e46f29+ed4b5058f4,gf23fb2af72+b7cae620c0,gf5e32f922b+fcb1d3bbc8,gf67bdafdda+ed4b5058f4,w.2025.16
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
_heavyFootprint.cc
Go to the documentation of this file.
1/*
2 * This file is part of afw.
3 *
4 * Developed for the LSST Data Management System.
5 * This product includes software developed by the LSST Project
6 * (https://www.lsst.org).
7 * See the COPYRIGHT file at the top-level directory of this distribution
8 * for details of code ownership.
9 *
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation, either version 3 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 */
23
24#include <pybind11/pybind11.h>
25#include <pybind11/stl.h>
26
27#include "ndarray/pybind11.h"
28
30
34
35namespace py = pybind11;
36using namespace py::literals;
37
38namespace lsst {
39namespace afw {
40namespace detection {
41
42using cpputils::python::WrapperCollection;
43
44namespace {
45template <typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel,
46 typename VariancePixelT = lsst::afw::image::VariancePixel>
47void declareHeavyFootprint(WrapperCollection &wrappers, std::string const &suffix) {
48 using Class = HeavyFootprint<ImagePixelT>;
49 wrappers.wrapType(
50 py::class_<Class, std::shared_ptr<Class>, Footprint>(wrappers.module,
51 ("HeavyFootprint" + suffix).c_str()),
52 [](auto &mod, auto &cls) {
53 cls.def(py::init<Footprint const &,
54 lsst::afw::image::MaskedImage<ImagePixelT, MaskPixelT, VariancePixelT> const
55 &,
56 HeavyFootprintCtrl const *>(),
57 "foot"_a, "mimage"_a, "ctrl"_a = nullptr);
58 cls.def(py::init<Footprint const &, HeavyFootprintCtrl const *>(), "foot"_a,
59 "ctrl"_a = nullptr);
60
61 cls.def("isHeavy", &Class::isHeavy);
62 cls.def("insert", (void (Class::*)(lsst::afw::image::MaskedImage<ImagePixelT> &) const) &
63 Class::insert);
64 cls.def("insert",
65 (void (Class::*)(lsst::afw::image::Image<ImagePixelT> &) const) & Class::insert);
66 cls.def("getImageArray",
67 (ndarray::Array<ImagePixelT, 1, 1>(Class::*)()) & Class::getImageArray);
68 cls.def("getMaskArray", (ndarray::Array<MaskPixelT, 1, 1>(Class::*)()) & Class::getMaskArray);
69 cls.def("getVarianceArray",
70 (ndarray::Array<VariancePixelT, 1, 1>(Class::*)()) & Class::getVarianceArray);
71 cls.def("getMaskBitsSet", &Class::getMaskBitsSet);
72 cls.def("dot", &Class::dot);
73 });
74
75 wrappers.wrap([](auto &mod) {
76 mod.def("makeHeavyFootprint",
77 (Class(*)(Footprint const &,
78 lsst::afw::image::MaskedImage<ImagePixelT, MaskPixelT, VariancePixelT> const &,
79 HeavyFootprintCtrl const *))
81 "foot"_a, "img"_a, "ctrl"_a = nullptr);
82
84 });
85}
86} // namespace
87
89 wrappers.addSignatureDependency("lsst.afw.image");
90
91 declareHeavyFootprint<int>(wrappers, "I");
92 declareHeavyFootprint<std::uint16_t>(wrappers, "U");
93 declareHeavyFootprint<float>(wrappers, "F");
94 declareHeavyFootprint<double>(wrappers, "D");
95}
96
97} // namespace detection
98} // namespace afw
99} // namespace lsst
void wrap(WrapperCallback function)
Add a set of wrappers without defining a class.
Definition python.h:369
PyType wrapType(PyType cls, ClassWrapperCallback function, bool setModuleName=true)
Add a type (class or enum) wrapper, deferring method and other attribute definitions until finish() i...
Definition python.h:391
pybind11::module module
The module object passed to the PYBIND11_MODULE block that contains this WrapperCollection.
Definition python.h:448
Class to describe the properties of a detected object from an image.
Definition Footprint.h:63
A control object for HeavyFootprints.
A set of pixels in an Image, including those pixels' actual values.
A helper class for subdividing pybind11 module across multiple translation units (i....
Definition python.h:242
void addSignatureDependency(std::string const &name)
Indicate an external module that provides a type used in function/method signatures.
Definition python.h:357
std::shared_ptr< HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > > mergeHeavyFootprints(HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > const &h1, HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > const &h2)
Sum the two given HeavyFootprints h1 and h2, returning a HeavyFootprint with the union footprint,...
void wrapHeavyFootprint(WrapperCollection &)
HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > makeHeavyFootprint(Footprint const &foot, lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > const &img, HeavyFootprintCtrl const *ctrl=nullptr)
Create a HeavyFootprint with footprint defined by the given Footprint and pixel values from the given...
std::int32_t MaskPixel
default type for Masks and MaskedImage Masks
float VariancePixel
default type for MaskedImage variance images