LSST Applications g0265f82a02+093ff98f47,g02d81e74bb+10352d6f39,g1f3e9fa97e+40b0fc677d,g2079a07aa2+14824f138e,g2bbee38e9b+093ff98f47,g337abbeb29+093ff98f47,g3ddfee87b4+064c02c7ee,g487adcacf7+7e842ebf4b,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g568d43a26c+1d7ac31cb0,g591dd9f2cf+fb1f69e2ea,g858d7b2824+10352d6f39,g8a8a8dda67+a6fc98d2e7,g8cdfe0ae6a+66d966b544,g99cad8db69+7ce8a7c20a,g9ddcbc5298+d4bad12328,ga1e77700b3+246acaaf9c,ga2e4dd1c03+064c02c7ee,ga8c6da7877+04f6ba86dc,gae46bcf261+093ff98f47,gb0e22166c9+3863383f4c,gba4ed39666+9664299f35,gbb8dafda3b+db40f59a7d,gbeb006f7da+e6a448e96d,gbf5cecdb8a+10352d6f39,gc0f3af6251+10a3fd39cd,gc120e1dc64+5839e50a77,gc28159a63d+093ff98f47,gcf0d15dbbd+064c02c7ee,gd2a12a3803+0c2c227a2b,gdaeeff99f8+a38ce5ea23,ge79ae78c31+093ff98f47,gee10cc3b42+a6fc98d2e7,gf1cff7945b+10352d6f39,w.2024.15
LSST Data Management Base Package
Loading...
Searching...
No Matches
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" ;
 
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.

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

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: