LSSTApplications  17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
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) {}
float annulusInner
"Inner radius for background annulus as a multiple of the PSF sigma" ;
std::vector< std::string > badMaskPlanes
"Mask planes that indicate pixels that should be excluded from the measurement" ; ...
float annulusOuter
"Outer 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" ;

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: