LSSTApplications  20.0.0
LSSTDataManagementBasePackage
Public Member Functions | Public Attributes | List of all members
lsst::meas::base::LocalBackgroundControl Class Reference

Configuration of LocalBackgroundAlgorithm. More...

#include <LocalBackground.h>

Public Member Functions

 LocalBackgroundControl ()
 

Public Attributes

std::vector< std::stringbadMaskPlanes
 "Mask planes that indicate pixels that should be excluded from the measurement" ; More...
 
float annulusInner
 "Inner radius for background annulus as a multiple of the PSF sigma" ; More...
 
float annulusOuter
 "Outer radius for background annulus as a multiple of the PSF sigma" ; More...
 
float bgRej
 "Rejection threshold (in standard deviations) for background measurement" ; More...
 
int bgIter
 "Number of sigma-clipping iterations for background measurement" ; More...
 

Detailed Description

Configuration of LocalBackgroundAlgorithm.

Definition at line 40 of file LocalBackground.h.

Constructor & Destructor Documentation

◆ LocalBackgroundControl()

lsst::meas::base::LocalBackgroundControl::LocalBackgroundControl ( )
inline

Definition at line 52 of file LocalBackground.h.

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) {}

Member Data Documentation

◆ annulusInner

float lsst::meas::base::LocalBackgroundControl::annulusInner

"Inner radius for background annulus as a multiple of the PSF sigma" ;

Definition at line 45 of file LocalBackground.h.

◆ annulusOuter

float lsst::meas::base::LocalBackgroundControl::annulusOuter

"Outer radius for background annulus as a multiple of the PSF sigma" ;

Definition at line 47 of file LocalBackground.h.

◆ badMaskPlanes

std::vector<std::string> lsst::meas::base::LocalBackgroundControl::badMaskPlanes

"Mask planes that indicate pixels that should be excluded from the measurement" ;

Definition at line 43 of file LocalBackground.h.

◆ bgIter

int lsst::meas::base::LocalBackgroundControl::bgIter

"Number of sigma-clipping iterations for background measurement" ;

Definition at line 50 of file LocalBackground.h.

◆ bgRej

float lsst::meas::base::LocalBackgroundControl::bgRej

"Rejection threshold (in standard deviations) for background measurement" ;

Definition at line 49 of file LocalBackground.h.


The documentation for this class was generated from the following file:
lsst::meas::base::LocalBackgroundControl::badMaskPlanes
std::vector< std::string > badMaskPlanes
"Mask planes that indicate pixels that should be excluded from the measurement" ;
Definition: LocalBackground.h:43
lsst::meas::base::LocalBackgroundControl::bgRej
float bgRej
"Rejection threshold (in standard deviations) for background measurement" ;
Definition: LocalBackground.h:49
lsst::meas::base::LocalBackgroundControl::annulusOuter
float annulusOuter
"Outer radius for background annulus as a multiple of the PSF sigma" ;
Definition: LocalBackground.h:47
lsst::meas::base::LocalBackgroundControl::annulusInner
float annulusInner
"Inner radius for background annulus as a multiple of the PSF sigma" ;
Definition: LocalBackground.h:45
lsst::meas::base::LocalBackgroundControl::bgIter
int bgIter
"Number of sigma-clipping iterations for background measurement" ;
Definition: LocalBackground.h:50