LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
Blendedness.h
Go to the documentation of this file.
1// -*- LSST-C++ -*-
2/*
3 * This file is part of meas_base.
4 *
5 * Developed for the LSST Data Management System.
6 * This product includes software developed by the LSST Project
7 * (https://www.lsst.org).
8 * See the COPYRIGHT file at the top-level directory of this distribution
9 * for details of code ownership.
10 *
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <https://www.gnu.org/licenses/>.
23 */
24
25#ifndef LSST_MEAS_BASE_Blendedness_h_INCLUDED
26#define LSST_MEAS_BASE_Blendedness_h_INCLUDED
27
28#include "lsst/pex/config.h"
35
36namespace lsst {
37namespace meas {
38namespace base {
39
41public:
43 doOld, bool,
44 "Whether to compute HeavyFootprint dot products (the old deblend.blendedness parameter)");
45
46 LSST_CONTROL_FIELD(doFlux, bool, "Whether to compute quantities related to the Gaussian-weighted flux");
47
48 LSST_CONTROL_FIELD(doShape, bool, "Whether to compute quantities related to the Gaussian-weighted shape");
49
51 "Radius factor that sets the maximum extent of the weight function (and hence the "
52 "flux measurements)");
53
54 BlendednessControl() : doOld(true), doFlux(true), doShape(true), nSigmaWeightMax(3.0) {}
55};
56
67public:
68 // Structures and routines to manage flaghandler
70 static FlagDefinition const FAILURE;
73
75
76 BlendednessAlgorithm(Control const& ctrl, std::string const& name, afw::table::Schema& schema);
77
94 static float computeAbsExpectation(float data, float variance);
95
112 static float computeAbsBias(float mu, float variance);
113
115 afw::table::SourceRecord& child) const;
116
118 afw::table::SourceRecord& child) const;
119
120 virtual void measure(afw::table::SourceRecord& measRecord,
121 afw::image::Exposure<float> const& exposure) const {}
122
123 virtual void fail(afw::table::SourceRecord& measRecord, MeasurementError* error = nullptr) const {}
124
125private:
126 void _measureMoments(afw::image::MaskedImage<float> const& image, afw::table::SourceRecord& child,
127 afw::table::Key<double> const& instFluxRawKey,
128 afw::table::Key<double> const& instFluxAbsKey, ShapeResultKey const& _shapeRawKey,
129 ShapeResultKey const& _shapeAbsKey) const;
130
131 Control const _ctrl;
134 afw::table::Key<double> _instFluxChildRaw;
135 afw::table::Key<double> _instFluxParentRaw;
137 afw::table::Key<double> _instFluxChildAbs;
138 afw::table::Key<double> _instFluxParentAbs;
139 ShapeResultKey _shapeChildRaw;
140 ShapeResultKey _shapeParentRaw;
141 ShapeResultKey _shapeChildAbs;
142 ShapeResultKey _shapeParentAbs;
143 FlagHandler _flagHandler;
144};
145
146} // namespace base
147} // namespace meas
148} // namespace lsst
149
150#endif // LSST_MEAS_BASE_Blendedness_h_INCLUDED
char * data
Definition BaseRecord.cc:61
afw::table::Key< afw::table::Array< VariancePixelT > > variance
A class to contain the data, WCS, and other information needed to describe an image of the sky.
Definition Exposure.h:72
A class to manipulate images, masks, and variance as a single object.
Definition MaskedImage.h:74
Tag types used to declare specialized field types.
Definition misc.h:31
Defines the fields and offsets for a table.
Definition Schema.h:51
Record class that contains measurements made on a single exposure.
Definition Source.h:78
Compute metrics that measure how blended objects are.
Definition Blendedness.h:66
static float computeAbsExpectation(float data, float variance)
Compute the posterior expectation value of the true instrumental flux in a pixel from its (Gaussian) ...
void measureChildPixels(afw::image::MaskedImage< float > const &image, afw::table::SourceRecord &child) const
static FlagDefinitionList const & getFlagDefinitions()
static float computeAbsBias(float mu, float variance)
Compute the bias induced by using the absolute value of a pixel instead of its value.
static FlagDefinition const NO_SHAPE
Definition Blendedness.h:72
virtual void fail(afw::table::SourceRecord &measRecord, MeasurementError *error=nullptr) const
Handle an exception thrown by the current algorithm by setting flags in the given record.
static FlagDefinition const NO_CENTROID
Definition Blendedness.h:71
virtual void measure(afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure) const
Called to measure a single child source in an image.
static FlagDefinition const FAILURE
Definition Blendedness.h:70
void measureParentPixels(afw::image::MaskedImage< float > const &image, afw::table::SourceRecord &child) const
double nSigmaWeightMax
"Radius factor that sets the maximum extent of the weight function (and hence the " "flux measurement...
Definition Blendedness.h:52
bool doOld
"Whether to compute HeavyFootprint dot products (the old deblend.blendedness parameter)" ;
Definition Blendedness.h:44
bool doShape
"Whether to compute quantities related to the Gaussian-weighted shape" ;
Definition Blendedness.h:48
bool doFlux
"Whether to compute quantities related to the Gaussian-weighted flux" ;
Definition Blendedness.h:46
vector-type utility class to build a collection of FlagDefinitions
Definition FlagHandler.h:60
Utility class for handling flag fields that indicate the failure modes of an algorithm.
Exception to be thrown when a measurement algorithm experiences a known failure mode.
Definition exceptions.h:48
A FunctorKey for ShapeResult.
An abstract base classes for which the same implementation can be used for both SingleFrameAlgorithm ...
Definition Algorithm.h:170
#define LSST_CONTROL_FIELD(NAME, TYPE, DOC)
A preprocessor macro used to define fields in C++ "control object" structs.
Definition config.h:43
This defines the base of measurement transformations.
Simple class used to define and document flags The name and doc constitute the identity of the FlagDe...
Definition FlagHandler.h:40