lsst.meas.base 22.0.1-27-gd28f579+846c297299
LocalBackground.h
Go to the documentation of this file.
1// -*- lsst-c++ -*-
2/*
3 * LSST Data Management System
4 * Copyright 2008-2018 AURA/LSST.
5 *
6 * This product includes software developed by the
7 * LSST Project (http://www.lsst.org/).
8 *
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the LSST License Statement and
20 * the GNU General Public License along with this program. If not,
21 * see <http://www.lsstcorp.org/LegalNotices/>.
22 */
23
24#ifndef LSST_MEAS_BASE_LocalBackground_h_INCLUDED
25#define LSST_MEAS_BASE_LocalBackground_h_INCLUDED
26
27#include "lsst/pex/config.h"
34
35namespace lsst {
36namespace meas {
37namespace base {
38
41public:
42 LSST_CONTROL_FIELD(badMaskPlanes, std::vector<std::string>,
43 "Mask planes that indicate pixels that should be excluded from the measurement");
44 LSST_CONTROL_FIELD(annulusInner, float,
45 "Inner radius for background annulus as a multiple of the PSF sigma");
46 LSST_CONTROL_FIELD(annulusOuter, float,
47 "Outer radius for background annulus as a multiple of the PSF sigma");
48 LSST_CONTROL_FIELD(bgRej, float,
49 "Rejection threshold (in standard deviations) for background measurement");
50 LSST_CONTROL_FIELD(bgIter, int, "Number of sigma-clipping iterations for background measurement");
51
53 : // deliberately omitting DETECTED: objects shouldn't be present if we're deblending, and by
54 // including DETECTED we wouldn't get any pixels for the background if we're on something
55 // extended and over threshold which is exactly the case when we do want to measure the
56 // background.
57 badMaskPlanes({"BAD", "SAT", "NO_DATA"}),
58 annulusInner(7.0),
59 annulusOuter(15.0),
60 bgRej(3.0),
61 bgIter(3) {}
62};
63
66public:
68 static FlagDefinition const FAILURE;
70 static FlagDefinition const NO_PSF;
71
73
74 LocalBackgroundAlgorithm(Control const& ctrl, std::string const& name, afw::table::Schema& schema,
75 std::string const& logName = "");
76
77 virtual void measure(afw::table::SourceRecord& measRecord,
78 afw::image::Exposure<float> const& exposure) const;
79
80 virtual void fail(afw::table::SourceRecord& measRecord, MeasurementError* error = nullptr) const;
81
82private:
83 Control _ctrl;
84 FluxResultKey _resultKey;
85 FlagHandler _flagHandler;
86 SafeCentroidExtractor _centroidExtractor;
88};
89
91public:
94};
95
96} // namespace base
97} // namespace meas
98} // namespace lsst
99
100#endif // !LSST_MEAS_BASE_LocalBackground_h_INCLUDED
This defines the base of measurement transformations.
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.
Definition: FlagHandler.h:148
A FunctorKey for FluxResult.
Definition: FluxUtilities.h:59
Base for instFlux measurement transformations.
A measurement algorithm that estimates the local background value per pixel.
LocalBackgroundAlgorithm(Control const &ctrl, std::string const &name, afw::table::Schema &schema, std::string const &logName="")
virtual void measure(afw::table::SourceRecord &measRecord, afw::image::Exposure< float > const &exposure) const
Called to measure a single child source in an image.
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 FlagDefinitionList const & getFlagDefinitions()
static FlagDefinition const NO_GOOD_PIXELS
Configuration of LocalBackgroundAlgorithm.
std::vector< std::string > badMaskPlanes
"Mask planes that indicate pixels that should be excluded from the measurement" ;
float annulusInner
"Inner radius for background annulus as a multiple of the PSF sigma" ;
float bgRej
"Rejection threshold (in standard deviations) for background measurement" ;
int bgIter
"Number of sigma-clipping iterations for background measurement" ;
float annulusOuter
"Outer radius for background annulus as a multiple of the PSF sigma" ;
LocalBackgroundTransform(Control const &ctrl, std::string const &name, afw::table::SchemaMapper &mapper)
Exception to be thrown when a measurement algorithm experiences a known failure mode.
Definition: exceptions.h:48
Utility class for measurement algorithms that extracts a position from the Centroid slot and handles ...
An abstract base classes for which the same implementation can be used for both SingleFrameAlgorithm ...
Definition: Algorithm.h:170
Simple class used to define and document flags The name and doc constitute the identity of the FlagDe...
Definition: FlagHandler.h:40