LSSTApplications  18.1.0
LSSTDataManagementBasePackage
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"
31 #include "lsst/afw/table/Source.h"
32 #include "lsst/afw/image/Image.h"
35 
36 namespace lsst {
37 namespace meas {
38 namespace base {
39 
41 public:
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 
67 public:
68  // Structures and routines to manage flaghandler
69  static FlagDefinitionList const& getFlagDefinitions();
70  static FlagDefinition const FAILURE;
72  static FlagDefinition const NO_SHAPE;
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 
114  void measureChildPixels(afw::image::MaskedImage<float> const& image,
115  afw::table::SourceRecord& child) const;
116 
117  void measureParentPixels(afw::image::MaskedImage<float> const& image,
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 
125 private:
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
Defines the fields and offsets for a table.
Definition: Schema.h:50
static FlagDefinition const NO_CENTROID
Definition: Blendedness.h:71
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...
Definition: Blendedness.h:123
afw::table::Key< afw::table::Array< VariancePixelT > > variance
Simple class used to define and document flags The name and doc constitute the identity of the FlagDe...
Definition: FlagHandler.h:40
Exception to be thrown when a measurement algorithm experiences a known failure mode.
Definition: exceptions.h:48
#define LSST_CONTROL_FIELD(NAME, TYPE, DOC)
A preprocessor macro used to define fields in C++ "control object" structs.
Definition: config.h:36
static FlagDefinition const FAILURE
Definition: Blendedness.h:70
A FunctorKey for ShapeResult.
STL class.
Utility class for handling flag fields that indicate the failure modes of an algorithm.
Definition: FlagHandler.h:148
static FlagDefinition const NO_SHAPE
Definition: Blendedness.h:72
A base class for image defects.
char * data
Definition: BaseRecord.cc:62
A class to manipulate images, masks, and variance as a single object.
Definition: MaskedImage.h:74
table::Schema schema
Definition: Camera.cc:161
double nSigmaWeightMax
"Radius factor that sets the maximum extent of the weight function (and hence the " "flux measurement...
Definition: Blendedness.h:52
bool doShape
"Whether to compute quantities related to the Gaussian-weighted shape" ;
Definition: Blendedness.h:48
virtual void measure(afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure) const
Called to measure a single child source in an image.
Definition: Blendedness.h:120
This defines the base of measurement transformations.
An abstract base classes for which the same implementation can be used for both SingleFrameAlgorithm ...
Definition: Algorithm.h:170
Record class that contains measurements made on a single exposure.
Definition: Source.h:82
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects...
vector-type utility class to build a collection of FlagDefinitions
Definition: FlagHandler.h:60
bool doFlux
"Whether to compute quantities related to the Gaussian-weighted flux" ;
Definition: Blendedness.h:46
bool doOld
"Whether to compute HeavyFootprint dot products (the old deblend.blendedness parameter)" ; ...
Definition: Blendedness.h:44
Compute metrics that measure how blended objects are.
Definition: Blendedness.h:66