lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig Class Reference

Inheritance diagram for lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig:

Public Member Functions
	setDefaults (self)

Static Public Attributes
	sigmaClip
	clipIter
	badMaskPlanes
	starSelection
	starSelector
	starShape
	psfShape
	psfSampling
	psfGridSampling
	minPsfApRadiusPix
	psfApCorrFieldName
	psfBadMaskPlanes
	fiducialSkyBackground
	fiducialPsfSigma
	fiducialZeroPoint
	maxEffectiveTransparency
	magLimSnr

Detailed Description

Config for ComputeExposureSummaryTask

Definition at line 42 of file computeExposureSummaryStats.py.

Member Function Documentation

setDefaults()

lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig.setDefaults

(

self

)

Definition at line 141 of file computeExposureSummaryStats.py.

    def setDefaults(self):
        super().setDefaults()
 
        self.starSelector.setDefaults()
        self.starSelector.doFlags = True
        self.starSelector.doSignalToNoise = True
        self.starSelector.doUnresolved = False
        self.starSelector.doIsolated = False
        self.starSelector.doRequireFiniteRaDec = False
        self.starSelector.doRequirePrimary = False
 
        self.starSelector.signalToNoise.minimum = 50.0
        self.starSelector.signalToNoise.maximum = 1000.0
 
        self.starSelector.flags.bad = ["slot_Shape_flag", "slot_PsfFlux_flag"]
        # Select stars used for PSF modeling.
        self.starSelector.flags.good = ["calib_psf_used"]
 
        self.starSelector.signalToNoise.fluxField = "slot_PsfFlux_instFlux"
        self.starSelector.signalToNoise.errField = "slot_PsfFlux_instFluxErr"
 
 

Member Data Documentation

badMaskPlanes

lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig.badMaskPlanes

static

Initial value:

=  pexConfig.ListField(
        dtype=str,
        doc="Mask planes that, if set, the associated pixel should not be included sky noise calculation.",
        default=("NO_DATA", "SUSPECT"),
    )

Definition at line 54 of file computeExposureSummaryStats.py.

clipIter

lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig.clipIter

static

Initial value:

=  pexConfig.Field(
        dtype=int,
        doc="Number of iterations of outlier rejection for sky noise.",
        default=2,
    )

Definition at line 49 of file computeExposureSummaryStats.py.

fiducialPsfSigma

lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig.fiducialPsfSigma

static

Initial value:

=  pexConfig.DictField(
        keytype=str,
        itemtype=float,
        doc="Fiducial PSF sigma (pixels) assumed when calculating effective exposure time. "
        "Keyed by band.",
        default={'u': 1.0, 'g': 1.0, 'r': 1.0, 'i': 1.0, 'z': 1.0, 'y': 1.0},
    )

Definition at line 116 of file computeExposureSummaryStats.py.

fiducialSkyBackground

lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig.fiducialSkyBackground

static

Initial value:

=  pexConfig.DictField(
        keytype=str,
        itemtype=float,
        doc="Fiducial sky background level (ADU/s) assumed when calculating effective exposure time. "
        "Keyed by band.",
        default={'u': 1.0, 'g': 1.0, 'r': 1.0, 'i': 1.0, 'z': 1.0, 'y': 1.0},
    )

Definition at line 109 of file computeExposureSummaryStats.py.

fiducialZeroPoint

lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig.fiducialZeroPoint

static

Initial value:

=  pexConfig.DictField(
        keytype=str,
        itemtype=float,
        doc="Fiducial zero point assumed when calculating effective exposure time. "
        "Keyed by band.",
        default={'u': 25.0, 'g': 25.0, 'r': 25.0, 'i': 25.0, 'z': 25.0, 'y': 25.0},
    )

Definition at line 123 of file computeExposureSummaryStats.py.

magLimSnr

lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig.magLimSnr

static

Initial value:

=  pexConfig.Field(
        dtype=float,
        doc="Signal-to-noise ratio for computing the magnitude limit depth.",
        default=5.0
    )

Definition at line 135 of file computeExposureSummaryStats.py.

maxEffectiveTransparency

lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig.maxEffectiveTransparency

static

Initial value:

=  pexConfig.Field(
        dtype=float,
        doc="Maximum value allowed for effective transparency scale factor (often inf or 1.0).",
        default=float('inf')
    )

Definition at line 130 of file computeExposureSummaryStats.py.

minPsfApRadiusPix

lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig.minPsfApRadiusPix

static

Initial value:

=  pexConfig.Field(
        dtype=float,
        doc="Minimum radius in pixels of the aperture within which to measure the flux of "
        "the PSF model for the psfApFluxDelta metric calculation (the radius is computed as "
        "max(``minPsfApRadius``, 3*psfSigma)).",
        default=2.0,
    )

Definition at line 90 of file computeExposureSummaryStats.py.

psfApCorrFieldName

lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig.psfApCorrFieldName

static

Initial value:

=  pexConfig.Field(
        doc="Name of the flux column associated with the aperture correction of the PSF model "
        "to use for the psfApCorrSigmaScaledDelta metric calculation.",
        dtype=str,
        default="base_PsfFlux_instFlux"
    )

Definition at line 97 of file computeExposureSummaryStats.py.

psfBadMaskPlanes

lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig.psfBadMaskPlanes

static

Initial value:

=  pexConfig.ListField(
        dtype=str,
        doc="Mask planes that, if set, the associated pixel should not be included in the PSF model "
        "robutsness metric calculations (namely, maxDistToNearestPsf and psfTraceRadiusDelta).",
        default=("BAD", "CR", "EDGE", "INTRP", "NO_DATA", "SAT", "SUSPECT"),
    )

Definition at line 103 of file computeExposureSummaryStats.py.

psfGridSampling

lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig.psfGridSampling

static

Initial value:

=  pexConfig.Field(
        dtype=int,
        doc="Sampling rate in pixels in each dimension for PSF model robustness metric "
        "caclulations grid (the tradeoff is between adequate sampling versus speed).",
        default=96,
    )

Definition at line 84 of file computeExposureSummaryStats.py.

psfSampling

lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig.psfSampling

static

Initial value:

=  pexConfig.Field(
        dtype=int,
        doc="Sampling rate in pixels in each dimension for the maxDistToNearestPsf metric "
        "caclulation grid (the tradeoff is between adequate sampling versus speed).",
        default=8,
    )

Definition at line 78 of file computeExposureSummaryStats.py.

psfShape

lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig.psfShape

static

Initial value:

=  pexConfig.Field(
        doc="Base name of columns to use for the PSF shape in the PSF statistics computation.",
        dtype=str,
        default="slot_PsfShape"
    )

Definition at line 73 of file computeExposureSummaryStats.py.

sigmaClip

lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig.sigmaClip

static

Initial value:

=  pexConfig.Field(
        dtype=float,
        doc="Sigma for outlier rejection for sky noise.",
        default=3.0,
    )

Definition at line 44 of file computeExposureSummaryStats.py.

starSelection

lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig.starSelection

static

Initial value:

=  pexConfig.Field(
        doc="Field to select full list of sources used for PSF modeling.",
        dtype=str,
        default="calib_psf_used",
    )

Definition at line 59 of file computeExposureSummaryStats.py.

starSelector

lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig.starSelector

static

Initial value:

=  pexConfig.ConfigurableField(
        target=ScienceSourceSelectorTask,
        doc="Selection of sources to compute PSF star statistics.",
    )

Definition at line 64 of file computeExposureSummaryStats.py.

starShape

lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig.starShape

static

Initial value:

=  pexConfig.Field(
        doc="Base name of columns to use for the source shape in the PSF statistics computation.",
        dtype=str,
        default="slot_Shape"
    )

Definition at line 68 of file computeExposureSummaryStats.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-10.0.0/Linux64/pipe_tasks/g7ac00fbb6c+b938379438/python/lsst/pipe/tasks/computeExposureSummaryStats.py