LSSTApplications  19.0.0-14-gb0260a2+72efe9b372,20.0.0+7927753e06,20.0.0+8829bf0056,20.0.0+995114c5d2,20.0.0+b6f4b2abd1,20.0.0+bddc4f4cbe,20.0.0-1-g253301a+8829bf0056,20.0.0-1-g2b7511a+0d71a2d77f,20.0.0-1-g5b95a8c+7461dd0434,20.0.0-12-g321c96ea+23efe4bbff,20.0.0-16-gfab17e72e+fdf35455f6,20.0.0-2-g0070d88+ba3ffc8f0b,20.0.0-2-g4dae9ad+ee58a624b3,20.0.0-2-g61b8584+5d3db074ba,20.0.0-2-gb780d76+d529cf1a41,20.0.0-2-ged6426c+226a441f5f,20.0.0-2-gf072044+8829bf0056,20.0.0-2-gf1f7952+ee58a624b3,20.0.0-20-geae50cf+e37fec0aee,20.0.0-25-g3dcad98+544a109665,20.0.0-25-g5eafb0f+ee58a624b3,20.0.0-27-g64178ef+f1f297b00a,20.0.0-3-g4cc78c6+e0676b0dc8,20.0.0-3-g8f21e14+4fd2c12c9a,20.0.0-3-gbd60e8c+187b78b4b8,20.0.0-3-gbecbe05+48431fa087,20.0.0-38-ge4adf513+a12e1f8e37,20.0.0-4-g97dc21a+544a109665,20.0.0-4-gb4befbc+087873070b,20.0.0-4-gf910f65+5d3db074ba,20.0.0-5-gdfe0fee+199202a608,20.0.0-5-gfbfe500+d529cf1a41,20.0.0-6-g64f541c+d529cf1a41,20.0.0-6-g9a5b7a1+a1cd37312e,20.0.0-68-ga3f3dda+5fca18c6a4,20.0.0-9-g4aef684+e18322736b,w.2020.45
LSSTDataManagementBasePackage
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 
25 #include "lsst/afw/image/Image.h"
29 
31 
32 namespace py = pybind11;
33 using namespace pybind11::literals;
34 
35 namespace lsst {
36 namespace meas {
37 namespace deblender {
38 
39 namespace {
40 
41 template <typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel,
42  typename VariancePixelT = lsst::afw::image::VariancePixel>
43 void 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,
57  lsst::afw::detection::PeakRecord const& pk, double sigma1,
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 
107 PYBIND11_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 
std::string
STL class.
std::shared_ptr
STL class.
lsst::afw::detection::PeakRecord
Record class that represents a peak in a Footprint.
Definition: Peak.h:42
BaselineUtils.h
std::pair
MaskedImage.h
std::vector
STL class.
Image.h
lsst::afw::geom.transform.transformContinued.cls
cls
Definition: transformContinued.py:33
lsst::meas::deblender::PYBIND11_MODULE
PYBIND11_MODULE(baselineUtils, mod)
Definition: baselineUtils.cc:107
lsst::afw::image::MaskedImage
A class to manipulate images, masks, and variance as a single object.
Definition: MaskedImage.h:73
lsst::afw::detection::HeavyFootprint
A set of pixels in an Image, including those pixels' actual values.
Definition: HeavyFootprint.h:49
lsst::afw::image::VariancePixel
float VariancePixel
default type for MaskedImage variance images
Definition: LsstImageTypes.h:35
sigma1
table::Key< double > sigma1
Definition: FunctionLibrary.cc:20
Footprint.h
lsst::afw::image::MaskPixel
std::int32_t MaskPixel
default type for Masks and MaskedImage Masks
Definition: LsstImageTypes.h:34
result
py::object result
Definition: _schema.cc:429
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
Peak.h
pybind11
Definition: _GenericMap.cc:40
lsst::meas::deblender.plugins.apportionFlux
def apportionFlux(debResult, log, assignStrayFlux=True, strayFluxAssignment='r-to-peak', strayFluxToPointSources='necessary', clipStrayFluxFraction=0.001, getTemplateSum=False)
Definition: plugins.py:1216
lsst::afw::detection::Footprint
Class to describe the properties of a detected object from an image.
Definition: Footprint.h:63
lsst::afw::image::Image< ImagePixelT >
lsst::meas::modelfit.psf.psfContinued.module
module
Definition: psfContinued.py:42