LSSTApplications: lsst.meas.algorithms.detection.BackgroundConfig Class Reference

LSSTApplications 10.0+286,10.0+36,10.0+46,10.0-2-g4f67435,10.1+152,10.1+37,11.0,11.0+1,11.0-1-g47edd16,11.0-1-g60db491,11.0-1-g7418c06,11.0-2-g04d2804,11.0-2-g68503cd,11.0-2-g818369d,11.0-2-gb8b8ce7

LSSTDataManagementBasePackage

Config for background estimation. More...

Inheritance diagram for lsst.meas.algorithms.detection.BackgroundConfig:

Public Member Functions
def	validate

Public Attributes
	algorithm

Static Public Attributes
tuple	statisticsProperty

tuple	undersampleStyle

tuple	binSize

tuple	algorithm

tuple	ignoredPixelMask

tuple	isNanSafe

tuple	useApprox

tuple	approxOrderX

tuple	approxOrderY

tuple	weighting

Detailed Description

Config for background estimation.

Definition at line 38 of file detection.py.

Member Function Documentation

def lsst.meas.algorithms.detection.BackgroundConfig.validate ( self )

Definition at line 104 of file detection.py.

 
     def validate(self):
         pexConfig.Config.validate(self)
         # Allow None to be used as an equivalent for "NONE", even though C++ expects the latter.
         if self.algorithm is None:
             self.algorithm = "NONE"

lsst::meas::algorithms.detection.BackgroundConfig.algorithm

tuple algorithm

Definition: detection.py:63

lsst::meas::algorithms.detection.BackgroundConfig.validate

def validate

Definition: detection.py:104

Member Data Documentation

tuple lsst.meas.algorithms.detection.BackgroundConfig.algorithm

static

Initial value:

 = pexConfig.ChoiceField(
         doc="how to interpolate the background values. This maps to an enum; see afw::math::Background",
         dtype=str, default="NATURAL_SPLINE", optional=True,
         allowed={
             "CONSTANT" : "Use a single constant value",
             "LINEAR" : "Use linear interpolation",
             "NATURAL_SPLINE" : "cubic spline with zero second derivative at endpoints",
             "AKIMA_SPLINE": "higher-level nonlinear spline that is more robust to outliers",
             "NONE": "No background estimation is to be attempted",
             }
         )

Definition at line 63 of file detection.py.

tuple lsst.meas.algorithms.detection.BackgroundConfig.approxOrderX

static

Initial value:

 = pexConfig.Field(
         doc="Approximation order in X for background Chebyshev (valid only with useApprox=True)",
         dtype=int, default=6,
     )

Definition at line 88 of file detection.py.

tuple lsst.meas.algorithms.detection.BackgroundConfig.approxOrderY

static

Initial value:

 = pexConfig.Field(
         doc="Approximation order in Y for background Chebyshev (valid only with useApprox=True)",
         dtype=int, default=-1,
     )

Definition at line 95 of file detection.py.

tuple lsst.meas.algorithms.detection.BackgroundConfig.binSize

static

Initial value:

 = pexConfig.RangeField(
         doc="how large a region of the sky should be used for each background point",
         dtype=int, default=256, min=10
         )

Definition at line 59 of file detection.py.

tuple lsst.meas.algorithms.detection.BackgroundConfig.ignoredPixelMask

static

Initial value:

 = pexConfig.ListField(
         doc="Names of mask planes to ignore while estimating the background",
         dtype=str, default = ["BAD", "EDGE", "DETECTED", "DETECTED_NEGATIVE", "NO_DATA",],
         itemCheck = lambda x: x in afwImage.MaskU().getMaskPlaneDict().keys(),
         )

Definition at line 74 of file detection.py.

tuple lsst.meas.algorithms.detection.BackgroundConfig.isNanSafe

static

Initial value:

 = pexConfig.Field(
         doc="Ignore NaNs when estimating the background",
         dtype=bool, default=False,
     )

Definition at line 79 of file detection.py.

tuple lsst.meas.algorithms.detection.BackgroundConfig.statisticsProperty

static

Initial value:

 = pexConfig.ChoiceField(
         doc="type of statistic to use for grid points",
         dtype=str, default="MEANCLIP",
         allowed={
             "MEANCLIP": "clipped mean",
             "MEAN": "unclipped mean",
             "MEDIAN": "median",
             }
         )

Definition at line 41 of file detection.py.

tuple lsst.meas.algorithms.detection.BackgroundConfig.undersampleStyle

static

Initial value:

 = pexConfig.ChoiceField(
         doc="behaviour if there are too few points in grid for requested interpolation style",
         dtype=str, default="REDUCE_INTERP_ORDER",
         allowed={
             "THROW_EXCEPTION": "throw an exception if there are too few points",
             "REDUCE_INTERP_ORDER": "use an interpolation style with a lower order.",
             "INCREASE_NXNYSAMPLE": "Increase the number of samples used to make the interpolation grid.",
             }
         )

Definition at line 50 of file detection.py.

tuple lsst.meas.algorithms.detection.BackgroundConfig.useApprox

static

Initial value:

 = pexConfig.Field(
         doc="Use Approximate (Chebyshev) to model background.",
         dtype=bool, default=False,
     )

Definition at line 84 of file detection.py.

tuple lsst.meas.algorithms.detection.BackgroundConfig.weighting

static

Initial value:

 = pexConfig.Field(
         doc="Use inverse variance weighting in calculation (valid only with useApprox=True)",
         dtype=bool, default=True,
     )

Definition at line 99 of file detection.py.

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation