LSST Applications  21.0.0+04719a4bac,21.0.0-1-ga51b5d4+f5e6047307,21.0.0-11-g2b59f77+a9c1acf22d,21.0.0-11-ga42c5b2+86977b0b17,21.0.0-12-gf4ce030+76814010d2,21.0.0-13-g1721dae+760e7a6536,21.0.0-13-g3a573fe+768d78a30a,21.0.0-15-g5a7caf0+f21cbc5713,21.0.0-16-g0fb55c1+b60e2d390c,21.0.0-19-g4cded4ca+71a93a33c0,21.0.0-2-g103fe59+bb20972958,21.0.0-2-g45278ab+04719a4bac,21.0.0-2-g5242d73+3ad5d60fb1,21.0.0-2-g7f82c8f+8babb168e8,21.0.0-2-g8f08a60+06509c8b61,21.0.0-2-g8faa9b5+616205b9df,21.0.0-2-ga326454+8babb168e8,21.0.0-2-gde069b7+5e4aea9c2f,21.0.0-2-gecfae73+1d3a86e577,21.0.0-2-gfc62afb+3ad5d60fb1,21.0.0-25-g1d57be3cd+e73869a214,21.0.0-3-g357aad2+ed88757d29,21.0.0-3-g4a4ce7f+3ad5d60fb1,21.0.0-3-g4be5c26+3ad5d60fb1,21.0.0-3-g65f322c+e0b24896a3,21.0.0-3-g7d9da8d+616205b9df,21.0.0-3-ge02ed75+a9c1acf22d,21.0.0-4-g591bb35+a9c1acf22d,21.0.0-4-g65b4814+b60e2d390c,21.0.0-4-gccdca77+0de219a2bc,21.0.0-4-ge8a399c+6c55c39e83,21.0.0-5-gd00fb1e+05fce91b99,21.0.0-6-gc675373+3ad5d60fb1,21.0.0-64-g1122c245+4fb2b8f86e,21.0.0-7-g04766d7+cd19d05db2,21.0.0-7-gdf92d54+04719a4bac,21.0.0-8-g5674e7b+d1bd76f71f,master-gac4afde19b+a9c1acf22d,w.2021.13
LSST Data Management Base Package
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 
35 namespace lsst {
36 namespace meas {
37 namespace base {
38 
41 public:
43  "Mask planes that indicate pixels that should be excluded from the measurement");
45  "Inner radius for background annulus as a multiple of the PSF sigma");
47  "Outer radius for background annulus as a multiple of the PSF sigma");
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 
66 public:
67  static FlagDefinitionList const& getFlagDefinitions();
68  static FlagDefinition const FAILURE;
70  static FlagDefinition const NO_PSF;
71 
73 
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 
82 private:
83  Control _ctrl;
84  FluxResultKey _resultKey;
85  FlagHandler _flagHandler;
86  SafeCentroidExtractor _centroidExtractor;
88 };
89 
91 public:
94 };
95 
96 } // namespace base
97 } // namespace meas
98 } // namespace lsst
99 
100 #endif // !LSST_MEAS_BASE_LocalBackground_h_INCLUDED
table::Key< std::string > name
Definition: Amplifier.cc:116
SchemaMapper * mapper
Definition: SchemaMapper.cc:78
table::Schema schema
Definition: python.h:134
Pass parameters to a Statistics object.
Definition: Statistics.h:93
Defines the fields and offsets for a table.
Definition: Schema.h:50
A mapping between the keys of two Schemas, used to copy data between them.
Definition: SchemaMapper.h:21
Record class that contains measurements made on a single exposure.
Definition: Source.h:80
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
#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.
A base class for image defects.
Simple class used to define and document flags The name and doc constitute the identity of the FlagDe...
Definition: FlagHandler.h:40