lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig Class Reference
Inheritance diagram for lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig:
Public Member Functions | |
| setDefaults (self) | |
| fiducialMagnitudeLimit (self, band, pixelScale, gain) | |
Detailed Description
Config for ComputeExposureSummaryTask
Definition at line 43 of file computeExposureSummaryStats.py.
Member Function Documentation
◆ fiducialMagnitudeLimit()
| lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig.fiducialMagnitudeLimit | ( | self, | |
| band, | |||
| pixelScale, | |||
| gain ) |
Compute the fiducial point-source magnitude limit based on config values.
This follows the conventions laid out in SMTN-002, LSE-40, and DMTN-296.
Parameters
----------
band : `str`
The band of interest
pixelScale : `float`
The pixel scale [arcsec/pix]
gain : `float`
The instrumental gain for the exposure [e-/ADU]. The gain should
be 1.0 if the image units are [e-].
Returns
-------
magnitude_limit : `float`
The fiducial magnitude limit calculated from fiducial values.
Definition at line 222 of file computeExposureSummaryStats.py.
◆ setDefaults()
| lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsConfig.setDefaults | ( | self | ) |
Definition at line 184 of file computeExposureSummaryStats.py.
Member Data Documentation
◆ 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 55 of file computeExposureSummaryStats.py.
◆ clipIter
|
static |
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of iterations of outlier rejection for sky noise.",
default=2,
)
Definition at line 50 of file computeExposureSummaryStats.py.
◆ fiducialExpTime
|
static |
Initial value:
= pexConfig.DictField(
keytype=str,
itemtype=float,
doc="Fiducial exposure time (seconds). "
"Keyed by band.",
default={"u": 30.0, "g": 30.0, "r": 30.0, "i": 30.0, "z": 30.0, "y": 30.0},
)
Definition at line 143 of file computeExposureSummaryStats.py.
◆ fiducialMagLim
|
static |
Initial value:
= pexConfig.DictField(
keytype=str,
itemtype=float,
doc="Fiducial magnitude limit depth at SNR=5. "
"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 150 of file computeExposureSummaryStats.py.
◆ 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 122 of file computeExposureSummaryStats.py.
◆ fiducialReadNoise
|
static |
Initial value:
= pexConfig.DictField(
keytype=str,
itemtype=float,
doc="Fiducial readnoise (electrons) assumed when calculating effective exposure time. "
"Keyed by band.",
default={"u": 9.0, "g": 9.0, "r": 9.0, "i": 9.0, "z": 9.0, "y": 9.0},
)
Definition at line 136 of file computeExposureSummaryStats.py.
◆ 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 115 of file computeExposureSummaryStats.py.
◆ 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 129 of file computeExposureSummaryStats.py.
◆ 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 162 of file computeExposureSummaryStats.py.
◆ 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 157 of file computeExposureSummaryStats.py.
◆ 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 96 of file computeExposureSummaryStats.py.
◆ 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 103 of file computeExposureSummaryStats.py.
◆ 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 109 of file computeExposureSummaryStats.py.
◆ 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 90 of file computeExposureSummaryStats.py.
◆ 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 84 of file computeExposureSummaryStats.py.
◆ 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 74 of file computeExposureSummaryStats.py.
◆ psfTE1
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=ComputeExPsfTask,
doc="Use treecorr for computing scalar value of TE1.",
)
Definition at line 167 of file computeExposureSummaryStats.py.
◆ psfTE2
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=ComputeExPsfTask,
doc="Use treecorr for computing scalar value of TE2.",
)
Definition at line 171 of file computeExposureSummaryStats.py.
◆ psfTE3
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=ComputeExPsfTask,
doc="Use treecorr for computing scalar value of TE3.",
)
Definition at line 175 of file computeExposureSummaryStats.py.
◆ psfTE4
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=ComputeExPsfTask,
doc="Use treecorr for computing scalar value of TE4.",
)
Definition at line 179 of file computeExposureSummaryStats.py.
◆ sigmaClip
|
static |
Initial value:
= pexConfig.Field(
dtype=float,
doc="Sigma for outlier rejection for sky noise.",
default=3.0,
)
Definition at line 45 of file computeExposureSummaryStats.py.
◆ starHigherOrderMomentBase
|
static |
Initial value:
= pexConfig.Field(
doc="Base name of the columns from which to obtain the higher-order moments.",
dtype=str,
default="ext_shapeHSM_HigherOrderMomentsSource",
)
Definition at line 79 of file computeExposureSummaryStats.py.
◆ 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 60 of file computeExposureSummaryStats.py.
◆ starSelector
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=ScienceSourceSelectorTask,
doc="Selection of sources to compute PSF star statistics.",
)
Definition at line 65 of file computeExposureSummaryStats.py.
◆ 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 69 of file computeExposureSummaryStats.py.
The documentation for this class was generated from the following file:
- python/lsst/pipe/tasks/computeExposureSummaryStats.py
Generated on for lsst.pipe.tasks by
1.17.0