lsst.ip.isr.ampOffset.AmpOffsetConfig Class Reference

Inheritance diagram for lsst.ip.isr.ampOffset.AmpOffsetConfig:

Public Member Functions
	setDefaults (self)

Static Public Attributes
	ampEdgeInset
	ampEdgeWidth
	ampEdgeMinFrac
	ampEdgeMaxOffset
	ampEdgeWindowFrac
	doBackground
	background
	backgroundFractionSample
	doDetection
	detection
	applyWeights

Detailed Description

Configuration parameters for AmpOffsetTask.

Definition at line 34 of file ampOffset.py.

Member Function Documentation

setDefaults()

lsst.ip.isr.ampOffset.AmpOffsetConfig.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 37 of file ampOffset.py.

    def setDefaults(self):
        self.background.algorithm = "AKIMA_SPLINE"
        self.background.useApprox = False
        self.background.ignoredPixelMask = [
            "BAD",
            "SAT",
            "INTRP",
            "CR",
            "EDGE",
            "DETECTED",
            "DETECTED_NEGATIVE",
            "SUSPECT",
            "NO_DATA",
        ]
        self.detection.reEstimateBackground = False
 
        # This maintains existing behavior and test values after DM-39796.
        self.detection.thresholdType = "stdev"
 

Member Data Documentation

ampEdgeInset

lsst.ip.isr.ampOffset.AmpOffsetConfig.ampEdgeInset

static

Initial value:

=  Field(
        doc="Number of pixels the amp edge strip is inset from the amp edge. A thin strip of pixels running "
        "parallel to the edge of the amp is used to characterize the average flux level at the amp edge.",
        dtype=int,
        default=5,
    )

Definition at line 56 of file ampOffset.py.

ampEdgeMaxOffset

lsst.ip.isr.ampOffset.AmpOffsetConfig.ampEdgeMaxOffset

static

Initial value:

=  Field(
        doc="Maximum allowed amp offset ADU value. If a measured amp offset value is larger than this, the "
        "result will be discarded and therefore not used to determine amp pedestal corrections.",
        dtype=float,
        default=5.0,
    )

Definition at line 73 of file ampOffset.py.

ampEdgeMinFrac

lsst.ip.isr.ampOffset.AmpOffsetConfig.ampEdgeMinFrac

static

Initial value:

=  Field(
        doc="Minimum allowed fraction of viable pixel rows along an amp edge. No amp offset estimate will be "
        "generated for amp edges that do not have at least this fraction of unmasked pixel rows.",
        dtype=float,
        default=0.5,
    )

Definition at line 67 of file ampOffset.py.

ampEdgeWidth

lsst.ip.isr.ampOffset.AmpOffsetConfig.ampEdgeWidth

static

Initial value:

=  Field(
        doc="Pixel width of the amp edge strip, starting at ampEdgeInset and extending inwards.",
        dtype=int,
        default=64,
    )

Definition at line 62 of file ampOffset.py.

ampEdgeWindowFrac

lsst.ip.isr.ampOffset.AmpOffsetConfig.ampEdgeWindowFrac

static

Initial value:

=  Field(
        doc="Fraction of the amp edge lengths utilized as the sliding window for generating rolling average "
        "amp offset values. It should be reconfigured for every instrument (HSC, LSSTCam, etc.) and should "
        "not exceed 1. If not provided, it defaults to the fraction that recovers the pixel size of the "
        "sliding window used in obs_subaru for compatibility with existing HSC data.",
        dtype=float,
        default=512 / 4176,
    )

Definition at line 79 of file ampOffset.py.

applyWeights

lsst.ip.isr.ampOffset.AmpOffsetConfig.applyWeights

static

Initial value:

=  Field(
        doc="Weights the amp offset calculation by the length of the interface between amplifiers. Applying "
        "weights does not affect outcomes for amplifiers in a 2D grid with square-shaped amplifiers or in "
        "any 1D layout on a detector, regardless of whether the amplifiers are square.",
        dtype=bool,
        default=True,
    )

Definition at line 110 of file ampOffset.py.

background

lsst.ip.isr.ampOffset.AmpOffsetConfig.background

static

Initial value:

=  ConfigurableField(
        doc="An initial background estimation step run prior to amp offset calculation.",
        target=SubtractBackgroundTask,
    )

Definition at line 92 of file ampOffset.py.

backgroundFractionSample

lsst.ip.isr.ampOffset.AmpOffsetConfig.backgroundFractionSample

static

Initial value:

=  Field(
        doc="The fraction of the shorter side of the amplifier used for background binning.",
        dtype=float,
        default=1.0,
    )

Definition at line 96 of file ampOffset.py.

detection

lsst.ip.isr.ampOffset.AmpOffsetConfig.detection

static

Initial value:

=  ConfigurableField(
        doc="Source detection to add temporary detection footprints prior to amp offset calculation.",
        target=SourceDetectionTask,
    )

Definition at line 106 of file ampOffset.py.

doBackground

lsst.ip.isr.ampOffset.AmpOffsetConfig.doBackground

static

Initial value:

=  Field(
        doc="Estimate and subtract background prior to amp offset estimation?",
        dtype=bool,
        default=True,
    )

Definition at line 87 of file ampOffset.py.

doDetection

lsst.ip.isr.ampOffset.AmpOffsetConfig.doDetection

static

Initial value:

=  Field(
        doc="Detect sources and update cloned exposure prior to amp offset estimation?",
        dtype=bool,
        default=True,
    )

Definition at line 101 of file ampOffset.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/ip_isr/g02d81e74bb+fa3a7a026e/python/lsst/ip/isr/ampOffset.py