PhotonTransferCurveExtractConfig#

class lsst.cp.pipe.PhotonTransferCurveExtractConfig(*args, **kw)#

Bases: PhotonTransferCurveExtractConfigBase

Attributes Summary

`auxiliaryHeaderKeys`	Auxiliary header keys to store with the PTC dataset.
`binSize`	Bin the image by this factor in both dimensions.
`connections`	Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
`detectorMeasurementRegion`	Region of each exposure where to perform the calculations (amplifier or full image).
`doExtractPhotodiodeData`	Extract photodiode data? (`bool`, default `False`)
`doGain`	Calculate a gain per input flat pair.
`doKsHistMeasurement`	Do the Ks test of gaussianity? If False, kspValue will be filled with all 1.0s.
`doVignetteFunctionRegionSelection`	Use vignette function to select PTC region? (`bool`, default `False`)
`edgeMaskLevel`	Mask edge pixels in which coordinate frame: DETECTOR or AMP? (`str`, default `'DETECTOR'`)
`efdPhotodiodeSeries`	EFD series to use to get photodiode values.
`efdSalIndex`	EFD SAL Index to select electrometer.
`gainCorrectionType`	Correction type for the gain.
`ksHistLimitMultiplier`	Number of sigma (as predicted from the mean value) to compute KS test histogram.
`ksHistMinDataValues`	Minimum number of good data values to compute KS test histogram.
`ksHistNBins`	Number of bins for the KS test histogram.
`maskNameList`	Mask list to exclude from statistics calculations.
`matchExposuresByFluxKeyword`	Header keyword for flux if matchExposuresType is FLUX.
`matchExposuresType`	Match input exposures by time, flux, or expId (`str`, default `'TIME'`)
`maximumRangeCovariancesAstier`	Maximum range of covariances as in Astier+19 (`int`, default `10`)
`minNumberGoodPixelsForCovariance`	Minimum number of acceptable good pixels per amp to calculate the covariances (via FFT or direclty).
`nIterSigmaClipPtc`	Number of sigma-clipping iterations for afwMath.StatisticsControl() (`int`, default `3`)
`nSigmaClipPtc`	Sigma cut for afwMath.StatisticsControl() (`float`, default `5.5`)
`numEdgeSuspect`	Number of edge pixels to be flagged as untrustworthy.
`photodiodeCurrentScale`	Scale factor to apply to photodiode current values for the `CHARGE_SUM`, `TRIMMED_SUM`, and `MEAN` integration methods.
`photodiodeIntegrationMethod`	Integration method for photodiode monitoring data.
`saveLogOutput`	Flag to enable/disable saving of log output for a task, enabled by default.
`thresholdDiffAfwVarVsCov00`	If the absolute fractional differece between afwMath.VARIANCECLIP and Cov00 for a region of a difference image is greater than this threshold (percentage), a warning will be issued.
`useEfdPhotodiodeData`	Extract photodiode values from EFD? (`bool`, default `False`)
`vignetteFunctionPolynomialCoeffs`	Polynomial terms for radial vignetting function.
`vignetteFunctionRegionSelectionMinimumPixels`	Minumum number of pixels to select for vignette function region selection.
`vignetteFunctionRegionSelectionPercent`	Vignetting function variation over the focal plane that is determined to be satisfactory.

Attributes Documentation

auxiliaryHeaderKeys#: Auxiliary header keys to store with the PTC dataset. (List, default [])

binSize#: Bin the image by this factor in both dimensions. (int, default 1)

connections: pexConfig.ConfigField#: Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.

detectorMeasurementRegion#

Region of each exposure where to perform the calculations (amplifier or full image). (str, default 'AMP')

Allowed values:

'AMP': Amplifier of the detector.
'FULL': Full image.
'None': Field is optional

doExtractPhotodiodeData#: Extract photodiode data? (bool, default False)

doGain#: Calculate a gain per input flat pair. (bool, default True)

doKsHistMeasurement#: Do the Ks test of gaussianity? If False, kspValue will be filled with all 1.0s. (bool, default False)

doVignetteFunctionRegionSelection#: Use vignette function to select PTC region? (bool, default False)

edgeMaskLevel#

Mask edge pixels in which coordinate frame: DETECTOR or AMP? (str, default 'DETECTOR')

Allowed values:

'DETECTOR': Mask only the edges of the full detector.
'AMP': Mask edges of each amplifier.
'None': Field is optional

efdPhotodiodeSeries#: EFD series to use to get photodiode values. (str, default 'lsst.sal.Electrometer.logevent_logMessage')

efdSalIndex#: EFD SAL Index to select electrometer. This is 101 for mainTel, 201 for auxTel. (int, default 201)

gainCorrectionType#

Correction type for the gain. (str, default 'FULL')

Allowed values:

'NONE': No correction.
'SIMPLE': First order correction.
'FULL': Second order correction.
'None': Field is optional

ksHistLimitMultiplier#: Number of sigma (as predicted from the mean value) to compute KS test histogram. (float, default 8.0)

ksHistMinDataValues#: Minimum number of good data values to compute KS test histogram. (int, default 100)

ksHistNBins#: Number of bins for the KS test histogram. (int, default 100)

maskNameList#: Mask list to exclude from statistics calculations. (List, default ['SUSPECT', 'BAD', 'NO_DATA', 'SAT'])

matchExposuresByFluxKeyword#: Header keyword for flux if matchExposuresType is FLUX. (str, default 'CCOBFLUX')

matchExposuresType#

Match input exposures by time, flux, or expId (str, default 'TIME')

Allowed values:

'TIME': Match exposures by reported exposure time. Entries that are within 5e-3 seconds.
'FLUX': Match exposures by target flux. Use header keyword in matchExposuresByFluxKeyword to find the flux.
'EXPID': Match exposures by exposure ID.
'None': Field is optional

maximumRangeCovariancesAstier#: Maximum range of covariances as in Astier+19 (int, default 10)

minNumberGoodPixelsForCovariance#: Minimum number of acceptable good pixels per amp to calculate the covariances (via FFT or direclty). (int, default 10000)

nIterSigmaClipPtc#: Number of sigma-clipping iterations for afwMath.StatisticsControl() (int, default 3)

nSigmaClipPtc#: Sigma cut for afwMath.StatisticsControl() (float, default 5.5)

numEdgeSuspect#: Number of edge pixels to be flagged as untrustworthy. (int, default 0)

photodiodeCurrentScale#: Scale factor to apply to photodiode current values for the CHARGE_SUM, TRIMMED_SUM, and MEAN integration methods. (float, default -1.0)

photodiodeIntegrationMethod#

Integration method for photodiode monitoring data. (str, default 'TRIMMED_SUM')

Allowed values:

'DIRECT_SUM': Use numpy’s trapezoid integrator on all photodiode readout entries
'TRIMMED_SUM': Use numpy’s trapezoid integrator, clipping the leading and trailing entries, which are nominally at zero baseline level.
'CHARGE_SUM': Treat the current values as integrated charge over the sampling interval and simply sum the values, after subtracting a baseline level.
'MEAN': {‘Take the average of the photodiode measurements and multiply by the exposure time.’}
'None': Field is optional

saveLogOutput#: Flag to enable/disable saving of log output for a task, enabled by default. (bool, default True)

thresholdDiffAfwVarVsCov00#: If the absolute fractional differece between afwMath.VARIANCECLIP and Cov00 for a region of a difference image is greater than this threshold (percentage), a warning will be issued. (float, default 1.0)

useEfdPhotodiodeData#: Extract photodiode values from EFD? (bool, default False)

vignetteFunctionPolynomialCoeffs#: Polynomial terms for radial vignetting function. This is used with vig = np.polyval(coeffs, radius), where radius is in meters. This must be set if doVignetteFunctionRegionSelection is True. (List, default None)

vignetteFunctionRegionSelectionMinimumPixels#: Minumum number of pixels to select for vignette function region selection. (int, default 250000)

vignetteFunctionRegionSelectionPercent#: Vignetting function variation over the focal plane that is determined to be satisfactory. If this does not yield vignetteFunctionRegionSelectionMinimumPixels then this will be increased until vignetteFunctionRegionSelectionMinimumPixels is reached. (float, default 2.0)