lsst::meas::base::LocalBackgroundControl Class Reference

Configuration of LocalBackgroundAlgorithm. More...

#include <LocalBackground.h>

Public Member Functions
	LocalBackgroundControl ()

Public Attributes
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	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" ;

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.

            :  // deliberately omitting DETECTED: objects shouldn't be present if we're deblending, and by
               // including DETECTED we wouldn't get any pixels for the background if we're on something
               // extended and over threshold which is exactly the case when we do want to measure the
               // background.
              badMaskPlanes({"BAD", "SAT", "NO_DATA"}),
              annulusInner(7.0),
              annulusOuter(15.0),
              bgRej(3.0),
              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:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_base/gf18bd8381d+7268b93478/include/lsst/meas/base/LocalBackground.h