LSSTApplications  19.0.0-14-gb0260a2+72efe9b372,20.0.0+7927753e06,20.0.0+8829bf0056,20.0.0+995114c5d2,20.0.0+b6f4b2abd1,20.0.0+bddc4f4cbe,20.0.0-1-g253301a+8829bf0056,20.0.0-1-g2b7511a+0d71a2d77f,20.0.0-1-g5b95a8c+7461dd0434,20.0.0-12-g321c96ea+23efe4bbff,20.0.0-16-gfab17e72e+fdf35455f6,20.0.0-2-g0070d88+ba3ffc8f0b,20.0.0-2-g4dae9ad+ee58a624b3,20.0.0-2-g61b8584+5d3db074ba,20.0.0-2-gb780d76+d529cf1a41,20.0.0-2-ged6426c+226a441f5f,20.0.0-2-gf072044+8829bf0056,20.0.0-2-gf1f7952+ee58a624b3,20.0.0-20-geae50cf+e37fec0aee,20.0.0-25-g3dcad98+544a109665,20.0.0-25-g5eafb0f+ee58a624b3,20.0.0-27-g64178ef+f1f297b00a,20.0.0-3-g4cc78c6+e0676b0dc8,20.0.0-3-g8f21e14+4fd2c12c9a,20.0.0-3-gbd60e8c+187b78b4b8,20.0.0-3-gbecbe05+48431fa087,20.0.0-38-ge4adf513+a12e1f8e37,20.0.0-4-g97dc21a+544a109665,20.0.0-4-gb4befbc+087873070b,20.0.0-4-gf910f65+5d3db074ba,20.0.0-5-gdfe0fee+199202a608,20.0.0-5-gfbfe500+d529cf1a41,20.0.0-6-g64f541c+d529cf1a41,20.0.0-6-g9a5b7a1+a1cd37312e,20.0.0-68-ga3f3dda+5fca18c6a4,20.0.0-9-g4aef684+e18322736b,w.2020.45
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