LSST Applications g2079a07aa2+86d27d4dc4,g2305ad1205+a659bff248,g2bbee38e9b+3c60f8fe34,g337abbeb29+3c60f8fe34,g33d1c0ed96+3c60f8fe34,g3502564af9+d77d6d1350,g3a166c0a6a+3c60f8fe34,g487adcacf7+25d9892218,g4be5004598+d77d6d1350,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+4d81263f9a,g5cd07815a0+980d2b1c3b,g607f77f49a+d77d6d1350,g858d7b2824+d77d6d1350,g88963caddf+83e433e629,g99cad8db69+a4d3c48eeb,g9ddcbc5298+9a081db1e4,ga1e77700b3+bcf1af89ad,ga57fefb910+9a39d7b2d7,gae0086650b+585e252eca,gb065fddaf9+4f9fd82a2c,gb0e22166c9+60f28cb32d,gb363559e06+d84b1d3d07,gb3b7280ab2+4563d032e1,gb4b16eec92+babe958938,gba4ed39666+c2a2e4ac27,gbb8dafda3b+ed6854b564,gc120e1dc64+b72d212f87,gc28159a63d+3c60f8fe34,gc3e9b769f7+921dbcd359,gcf0d15dbbd+9a39d7b2d7,gdaeeff99f8+f9a426f77a,gddc38dedce+585e252eca,ge79ae78c31+3c60f8fe34,w.2024.21
LSST Data Management Base Package
Loading...
Searching...
No Matches
baselineUtils.cc
Go to the documentation of this file.
1/*
2 * LSST Data Management System
3 *
4 * This product includes software developed by the
5 * LSST Project (http://www.lsst.org/).
6 * See the COPYRIGHT file
7 *
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the LSST License Statement and
19 * the GNU General Public License along with this program. If not,
20 * see <https://www.lsstcorp.org/LegalNotices/>.
21 */
22#include "pybind11/pybind11.h"
23#include "pybind11/stl.h"
24
29
31
32namespace py = pybind11;
33using namespace pybind11::literals;
34
35namespace lsst {
36namespace meas {
37namespace deblender {
38
39namespace {
40
41template <typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel,
42 typename VariancePixelT = lsst::afw::image::VariancePixel>
43void declareBaselineUtils(py::module& mod, const std::string& suffix) {
47 using Class = BaselineUtils<ImagePixelT, MaskPixelT, VariancePixelT>;
48
49 py::class_<Class, std::shared_ptr<Class>> cls(mod, ("BaselineUtils" + suffix).c_str());
50 cls.def_static("symmetrizeFootprint", &Class::symmetrizeFootprint, "foot"_a, "cx"_a, "cy"_a);
51 // The C++ function returns a std::pair return value but also takes a referenced boolean
52 // (patchedEdges) that is modified by the function and used by the python API,
53 // so we wrap this in a lambda to combine the std::pair and patchedEdges in a tuple
54 // that is returned to python.
55 cls.def_static("buildSymmetricTemplate", [](MaskedImageT const& img,
58 bool minZero, bool patchEdges) {
59 bool patchedEdges;
61
62 result = Class::buildSymmetricTemplate(img, foot, pk, sigma1, minZero, patchEdges, &patchedEdges);
63 return py::make_tuple(result.first, result.second, patchedEdges);
64 });
65 cls.def_static("medianFilter", &Class::medianFilter, "img"_a, "outimg"_a, "halfsize"_a);
66 cls.def_static("makeMonotonic", &Class::makeMonotonic, "img"_a, "pk"_a);
67 // apportionFlux expects an empty vector containing HeavyFootprint pointers that is modified
68 // in the function. But when a list is passed to pybind11 in place of the vector,
69 // the changes are not passed back to python. So instead we create the vector in this lambda and
70 // include it in the return value.
71 cls.def_static("apportionFlux", [](MaskedImageT const& img, lsst::afw::detection::Footprint const& foot,
73 templates,
75 templ_footprints,
76 ImagePtrT templ_sum, std::vector<bool> const& ispsf,
77 std::vector<int> const& pkx, std::vector<int> const& pky,
78 int strayFluxOptions, double clipStrayFluxFraction) {
79 using HeavyFootprintPtrList = std::vector<std::shared_ptr<
81
83 result;
84 HeavyFootprintPtrList strays;
85 result = Class::apportionFlux(img, foot, templates, templ_footprints, templ_sum, ispsf, pkx, pky,
86 strays, strayFluxOptions, clipStrayFluxFraction);
87
88 return py::make_tuple(result, strays);
89 });
90 cls.def_static("hasSignificantFluxAtEdge", &Class::hasSignificantFluxAtEdge, "img"_a, "sfoot"_a,
91 "thresh"_a);
92 cls.def_static("getSignificantEdgePixels", &Class::getSignificantEdgePixels, "img"_a, "sfoot"_a,
93 "thresh"_a);
94 // There appears to be an issue binding to a static const member of a templated type, so for now
95 // we just use the values constants
96 cls.attr("ASSIGN_STRAYFLUX") = py::cast(Class::ASSIGN_STRAYFLUX);
97 cls.attr("STRAYFLUX_TO_POINT_SOURCES_WHEN_NECESSARY") =
98 py::cast(Class::STRAYFLUX_TO_POINT_SOURCES_WHEN_NECESSARY);
99 cls.attr("STRAYFLUX_TO_POINT_SOURCES_ALWAYS") = py::cast(Class::STRAYFLUX_TO_POINT_SOURCES_ALWAYS);
100 cls.attr("STRAYFLUX_R_TO_FOOTPRINT") = py::cast(Class::STRAYFLUX_R_TO_FOOTPRINT);
101 cls.attr("STRAYFLUX_NEAREST_FOOTPRINT") = py::cast(Class::STRAYFLUX_NEAREST_FOOTPRINT);
102 cls.attr("STRAYFLUX_TRIM") = py::cast(Class::STRAYFLUX_TRIM);
103};
104
105} // <anonymous>
106
107PYBIND11_MODULE(baselineUtils, mod) {
108 py::module::import("lsst.afw.image");
109 py::module::import("lsst.afw.detection");
110
111 declareBaselineUtils<float>(mod, "F");
112}
113
114} // deblender
115} // meas
116} // lsst
117
py::object result
Definition _schema.cc:429
table::Key< double > sigma1
Class to describe the properties of a detected object from an image.
Definition Footprint.h:63
A set of pixels in an Image, including those pixels' actual values.
Record class that represents a peak in a Footprint.
Definition Peak.h:42
A class to represent a 2-dimensional array of pixels.
Definition Image.h:51
A class to manipulate images, masks, and variance as a single object.
Definition MaskedImage.h:74
std::int32_t MaskPixel
default type for Masks and MaskedImage Masks
float VariancePixel
default type for MaskedImage variance images
PYBIND11_MODULE(baselineUtils, mod)