lsst.meas.algorithms.noise_covariance.ComputeNoiseCorrelationConfig Class Reference

Inheritance diagram for lsst.meas.algorithms.noise_covariance.ComputeNoiseCorrelationConfig:

Public Member Functions
	setDefaults (self)

Static Public Attributes
	background
	maskPlanes
	size = Field[int](default=5, doc="Size of the correlation matrix to produce")
	scaleEmpiricalVariance
	subtractEmpiricalMean

Detailed Description

Definition at line 68 of file noise_covariance.py.

Member Function Documentation

setDefaults()

lsst.meas.algorithms.noise_covariance.ComputeNoiseCorrelationConfig.setDefaults

(

self

)

Definition at line 88 of file noise_covariance.py.

Member Data Documentation

background

lsst.meas.algorithms.noise_covariance.ComputeNoiseCorrelationConfig.background

static

Initial value:

=  ConfigurableField(
        target=SubtractBackgroundTask, doc="Background subtraction"
    )

Definition at line 69 of file noise_covariance.py.

maskPlanes

lsst.meas.algorithms.noise_covariance.ComputeNoiseCorrelationConfig.maskPlanes

static

Initial value:

=  ListField[str](
        default=["DETECTED", "DETECTED_NEGATIVE", "BAD", "SAT", "NO_DATA", "INTRP"],
        doc="Mask planes for pixels to ignore when calculating  correlations",
    )

Definition at line 72 of file noise_covariance.py.

scaleEmpiricalVariance

lsst.meas.algorithms.noise_covariance.ComputeNoiseCorrelationConfig.scaleEmpiricalVariance

static

Initial value:

=  Field[bool](
        default=False,
        doc=(
            "Scale down the correlation coefficients x by the empirical variance of the background "
            "in addition to the variance plane?"
        ),
    )

Definition at line 77 of file noise_covariance.py.

size

lsst.meas.algorithms.noise_covariance.ComputeNoiseCorrelationConfig.size = Field[int](default=5, doc="Size of the correlation matrix to produce")

static

Definition at line 76 of file noise_covariance.py.

subtractEmpiricalMean

lsst.meas.algorithms.noise_covariance.ComputeNoiseCorrelationConfig.subtractEmpiricalMean

static

Initial value:

=  Field[bool](
        default=False, doc="Subtract the empirical mean in addition to the background?"
    )

Definition at line 84 of file noise_covariance.py.

---

The documentation for this class was generated from the following file:

• python/lsst/meas/algorithms/noise_covariance.py