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

)

Subclass hook for computing defaults.

Notes
-----
Derived `~lsst.pex.config.Config` classes that must compute defaults
rather than using the `~lsst.pex.config.Field` instances's defaults
should do so here. To correctly use inherited defaults,
implementations of ``setDefaults`` must call their base class's
``setDefaults``.

Reimplemented from lsst.pex.config.config.Config.

Definition at line 88 of file noise_covariance.py.

    def setDefaults(self):
        self.background.binSize = 32
        self.background.useApprox = False
        self.background.undersampleStyle = "REDUCE_INTERP_ORDER"
        self.background.ignoredPixelMask = [
            "DETECTED",
            "DETECTED_NEGATIVE",
            "BAD",
            "SAT",
            "NO_DATA",
            "INTRP",
        ]
 
 

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:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_algorithms/ge6526c86ff+3a7c1ac5f1/python/lsst/meas/algorithms/noise_covariance.py