LSST Applications g013ef56533+7c9321ec0f,g042eb84c57+c6cfa41bc3,g199a45376c+0ba108daf9,g1fd858c14a+fcad0d0313,g210f2d0738+c0f94c6586,g262e1987ae+a7e710680e,g29ae962dfc+fb55f2edb0,g2ac17093b6+61d6563b1e,g2b1d02342f+df6f932764,g2cef7863aa+aef1011c0b,g2f7ad74990+c0f94c6586,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53cf87ae69,g47891489e3+4316d04fff,g511e8cfd20+baa56acf6c,g53246c7159+8c5ae1fdc5,g54cd7ddccb+fd7ad03fde,g64539dfbff+c0f94c6586,g67b6fd64d1+4316d04fff,g67fd3c3899+c0f94c6586,g6985122a63+4316d04fff,g74acd417e5+ca833bee28,g786e29fd12+668abc6043,g81db2e9a8d+b2ec8e584f,g87389fa792+8856018cbb,g89139ef638+4316d04fff,g8d7436a09f+0a24083b20,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+11eb8fd5b8,gbf99507273+8c5ae1fdc5,gcdda8b9158+e4c84c9d5c,gce8aa8abaa+8c5ae1fdc5,gd7ef33dd92+4316d04fff,gdab6d2f7ff+ca833bee28,ge410e46f29+4316d04fff,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.40
LSST Data Management Base Package
Loading...
Searching...
No Matches
apertureFlux.cc
Go to the documentation of this file.
1/*
2 * LSST Data Management System
3 * Copyright 2008-2017 AURA/LSST.
4 *
5 * This product includes software developed by the
6 * LSST Project (http://www.lsst.org/).
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
23#include "pybind11/pybind11.h"
24#include "pybind11/stl.h"
26
27#include <memory>
28
31
34
35namespace py = pybind11;
36using namespace pybind11::literals;
37
38namespace lsst {
39namespace meas {
40namespace base {
41namespace {
42
43using PyFluxAlgorithm =
44 py::classh<ApertureFluxAlgorithm, SimpleAlgorithm>;
45using PyFluxControl = py::class_<ApertureFluxControl>;
46using PyFluxResult = py::classh<ApertureFluxResult, FluxResult>;
47using PyFluxTransform =
48 py::classh<ApertureFluxTransform, BaseTransform>;
49
50PyFluxControl declareFluxControl(lsst::cpputils::python::WrapperCollection &wrappers) {
51 return wrappers.wrapType(PyFluxControl(wrappers.module, "ApertureFluxControl"), [](auto &mod, auto &cls) {
52 LSST_DECLARE_CONTROL_FIELD(cls, ApertureFluxControl, radii);
53 LSST_DECLARE_CONTROL_FIELD(cls, ApertureFluxControl, maxSincRadius);
54 LSST_DECLARE_CONTROL_FIELD(cls, ApertureFluxControl, shiftKernel);
55
56 cls.def(py::init<>());
57 });
58}
59
60template <typename Image, class PyClass>
61void declareComputeFluxes(PyClass &cls) {
63 using Result = ApertureFluxAlgorithm::Result;
64 cls.def_static("computeSincFlux",
65 (Result(*)(Image const &, afw::geom::ellipses::Ellipse const &, Control const &)) &
67 "image"_a, "ellipse"_a, "ctrl"_a = Control());
68 cls.def_static("computeNaiveFlux",
69 (Result(*)(Image const &, afw::geom::ellipses::Ellipse const &, Control const &)) &
71 "image"_a, "ellipse"_a, "ctrl"_a = Control());
72 cls.def_static("computeFlux",
73 (Result(*)(Image const &, afw::geom::ellipses::Ellipse const &, Control const &)) &
75 "image"_a, "ellipse"_a, "ctrl"_a = Control());
76}
77
78PyFluxAlgorithm declareFluxAlgorithm(lsst::cpputils::python::WrapperCollection &wrappers) {
79 return wrappers.wrapType(PyFluxAlgorithm(wrappers.module, "ApertureFluxAlgorithm"), [](auto &mod, auto &cls) {
80 cls.attr("FAILURE") = py::cast(ApertureFluxAlgorithm::FAILURE);
81 cls.attr("APERTURE_TRUNCATED") = py::cast(ApertureFluxAlgorithm::APERTURE_TRUNCATED);
82 cls.attr("SINC_COEFFS_TRUNCATED") = py::cast(ApertureFluxAlgorithm::SINC_COEFFS_TRUNCATED);
83
84 // constructor not wrapped because class is abstract
85
86 declareComputeFluxes<afw::image::Image<double>>(cls);
87 declareComputeFluxes<afw::image::MaskedImage<double>>(cls);
88 declareComputeFluxes<afw::image::Image<float>>(cls);
89 declareComputeFluxes<afw::image::MaskedImage<float>>(cls);
90
91 cls.def("measure", &ApertureFluxAlgorithm::measure, "measRecord"_a, "exposure"_a);
92 cls.def("fail", &ApertureFluxAlgorithm::fail, "measRecord"_a, "error"_a = nullptr);
93 cls.def_static("makeFieldPrefix", &ApertureFluxAlgorithm::makeFieldPrefix, "name"_a, "radius"_a);
94 });
95}
96
97void declareFluxResult(lsst::cpputils::python::WrapperCollection &wrappers) {
98 wrappers.wrapType(PyFluxResult(wrappers.module, "ApertureFluxResult"), [](auto &mod, auto &cls) {
99 cls.def("getFlag", (bool (ApertureFluxResult::*)(unsigned int) const) &ApertureFluxResult::getFlag,
100 "bit"_a);
101 cls.def("getFlag",
102 (bool (ApertureFluxResult::*)(std::string const &name) const) &ApertureFluxResult::getFlag,
103 "name"_a);
104 cls.def("setFlag", &ApertureFluxResult::setFlag, "index"_a, "value"_a);
105 cls.def("unsetFlag", &ApertureFluxResult::unsetFlag, "index"_a);
106 });
107}
108
109PyFluxTransform declareFluxTransform(lsst::cpputils::python::WrapperCollection &wrappers) {
110 return wrappers.wrapType(PyFluxTransform(wrappers.module, "ApertureFluxTransform"), [](auto &mod, auto &cls) {
111 cls.def(py::init<ApertureFluxTransform::Control const &, std::string const &,
112 afw::table::SchemaMapper &>(),
113 "ctrl"_a, "name"_a, "mapper"_a);
114
115 cls.def("__call__", &ApertureFluxTransform::operator(), "inputCatalog"_a, "outputCatalog"_a, "wcs"_a,
116 "photoCalib"_a);
117 });
118}
119
120} // namespace
121
123 auto clsFluxControl = declareFluxControl(wrappers);
124 auto clsFluxAlgorithm = declareFluxAlgorithm(wrappers);
125 declareFluxResult(wrappers);
126 auto clsFluxTransform = declareFluxTransform(wrappers);
127
128 clsFluxAlgorithm.attr("Control") = clsFluxControl;
129 // no need to make ApertureFluxControl::Result visible to Python
130 clsFluxTransform.attr("Control") = clsFluxControl;
131
133 clsFluxAlgorithm, clsFluxControl, clsFluxTransform);
134}
135
136} // namespace base
137} // namespace meas
138} // namespace lsst
A helper class for subdividing pybind11 module across multiple translation units (i....
Definition python.h:242
static Result computeSincFlux(afw::image::Image< T > const &image, afw::geom::ellipses::Ellipse const &ellipse, Control const &ctrl=Control())
Compute the instFlux (and optionally, uncertanties) within an aperture using Sinc photometry.
static Result computeFlux(afw::image::Image< T > const &image, afw::geom::ellipses::Ellipse const &ellipse, Control const &ctrl=Control())
Compute the instFlux (and optionally, uncertanties) within an aperture using the algorithm determined...
ApertureFluxResult Result
Result object returned by static methods.
static Result computeNaiveFlux(afw::image::Image< T > const &image, afw::geom::ellipses::Ellipse const &ellipse, Control const &ctrl=Control())
Compute the instFlux (and optionally, uncertanties) within an aperture using naive photometry.
void declareAlgorithm(PyAlg &clsAlgorithm)
Wrap the implicit API used by meas_base's algorithms.
Definition python.h:87
void wrapApertureFlow(WrapperCollection &)
g2d::python::Image< double > Image
Definition test_image.cc:14