PhotonTransferCurveSolveConfig#

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

Bases: PipelineTaskConfig

Configuration for fitting measured covariances.

Attributes Summary

`ampOffsetGainRatioMaxAdu`	Maximum number of adu to use for amp offset gain ratio fixup.
`ampOffsetGainRatioMinAdu`	Minimum number of adu to use for amp offset gain ratio fixup.
`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.
`consecutivePointsVarDecreases`	Required number of consecutive points/fluxes in the PTC where the variance decreases in order to find a first estimate of the PTC turn-off.
`doAmpOffsetGainRatioFixup`	Do gain ratio fixup based on amp offsets? Deprecated: This option has been deprecated and will be removed after v30.
`doFitBootstrap`	Use bootstrap for the PTC fit parameters and errors?.
`doLegacyTurnoffSelection`	Use 'legacy' computation for PTC turnoff selection.
`doModelPtcRolloff`	Model the roll-off in the PTC turnoff as a exponential decay.
`doSubtractLongRangeCovariances`	Subtract long-range covariances before FULLCOVARIANCE fit, beyond startLongRangeCovariances? (`bool`, default `False`)
`extendRollofSearchMaskSizeAdu`	The amount to extend the mask beyond the initial PTC turnoff to fit the rolloff.
`ksTestMinPvalue`	Minimum value of the Gaussian histogram KS test p-value to be used in PTC fit.
`maxDeltaInitialPtcOutlierFit`	If there are any outliers in the initial fit that have mean greater than maxSignalInitialPtcOutlierFit, then no points that have this delta mean from the previous `good` point are allowed.
`maxIterFullFitCovariancesAstier`	Maximum number of iterations in full model fit for FULLCOVARIANCE ptcFitType (`int`, default `3`)
`maxIterationsPtcOutliers`	Maximum number of iterations for outlier rejection in PTC.
`maxMeanSignal`	Maximum values (inclusive) of mean signal (in adu) below which to consider, per amp.
`maxPtcRolloffDeviation`	Maximum percent difference between the model with saturation rolloff and the model without to set the PTC turnoff.
`maxSignalInitialPtcOutlierFit`	Maximum signal considered for intial outlier fit.
`maximumRangeCovariancesAstier`	Maximum range of measured covariances as in Astier+19 (`int`, default `10`)
`maximumRangeCovariancesAstierFullCovFit`	Maximum range up to where to fit covariances as in Astier+19, for the FULLCOVARIANCE model.This is different from maximumRangeCovariancesAstier.It should be less or equal than maximumRangeCovariancesAstier.The number of parameters for this model is 3*maximumRangeCovariancesAstierFullCovFit^2 + 1, so increase with care so that the fit is not too slow.
`minMeanSignal`	Minimum values (inclusive) of mean signal (in adu) per amp to use.
`minVarPivotSearch`	The code looks for a pivot signal point after which the variance starts decreasing at high-flux to exclude then from the PTC model fit.
`polyDegLongRangeCovariances`	If doSubtractLongRangeCovariances is True, polynomial degree to fit data beyond startLongRangeCovariances.
`polynomialFitDegree`	Degree of polynomial to fit the PTC, when 'ptcFitType'=POLYNOMIAL.
`ptcFitType`	Fit PTC to Eq.
`saveLogOutput`	Flag to enable/disable saving of log output for a task, enabled by default.
`scaleMaxSignalInitialPtcOutlierFit`	Scale maxSignalInitialPtcOutlierFit and maxDeltaInitialPtcOutlierFit by approximate gain? If yes then maxSignalInitialPtcOutlierFit and maxDeltaInitialPtcOutlierFit are assumed to have units of electrons, otherwise adu.
`sigmaClipFullFitCovariancesAstier`	sigma clip for full model fit for FULLCOVARIANCE ptcFitType (`float`, default `5.0`)
`sigmaCutPtcOutliers`	Sigma cut for outlier rejection in PTC.
`startLongRangeCovariances`	If doSubtractLongRangeCovariances is True, subtract covariances beyond this range.

Methods Summary

validate()

Validate the Config, raising an exception if invalid.

Attributes Documentation

ampOffsetGainRatioMaxAdu#: Maximum number of adu to use for amp offset gain ratio fixup. Deprecated: This option has been deprecated and will be removed after v30. (float, default 20000.0)

ampOffsetGainRatioMinAdu#: Minimum number of adu to use for amp offset gain ratio fixup. Deprecated: This option has been deprecated and will be removed after v30. (float, default 1000.0)

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.

consecutivePointsVarDecreases#

Required number of consecutive points/fluxes in the PTC where the variance decreases in order to find a first estimate of the PTC turn-off. Only used if doLegacyTurnoffSelection is True. Deprecated: This option has been deprecated and will be removed after v30. (int, default 2)

Valid Range = [2,inf)

doAmpOffsetGainRatioFixup#: Do gain ratio fixup based on amp offsets? Deprecated: This option has been deprecated and will be removed after v30. (bool, default False)

doFitBootstrap#: Use bootstrap for the PTC fit parameters and errors?. (bool, default False)

doLegacyTurnoffSelection#: Use ‘legacy’ computation for PTC turnoff selection. If set to False, then the KS test p-value selection will be used instead. Deprecated: This option has been deprecated and will be removed after v30. (bool, default False)

doModelPtcRolloff#: Model the roll-off in the PTC turnoff as a exponential decay. (bool, default False)

doSubtractLongRangeCovariances#: Subtract long-range covariances before FULLCOVARIANCE fit, beyond startLongRangeCovariances? (bool, default False)

extendRollofSearchMaskSizeAdu#: The amount to extend the mask beyond the initial PTC turnoff to fit the rolloff. Only used if doModelPtcRolloff=True (units: adu). (float, default 5000.0)

ksTestMinPvalue#: Minimum value of the Gaussian histogram KS test p-value to be used in PTC fit. (float, default 0.01)

maxDeltaInitialPtcOutlierFit#: If there are any outliers in the initial fit that have mean greater than maxSignalInitialPtcOutlierFit, then no points that have this delta mean from the previous good point are allowed. If scaleMaxSignalInitialPtcOutlierFit=True then the units are electrons; otherwise adu. (float, default 9000.0)

maxIterFullFitCovariancesAstier#: Maximum number of iterations in full model fit for FULLCOVARIANCE ptcFitType (int, default 3)

maxIterationsPtcOutliers#

Maximum number of iterations for outlier rejection in PTC. (int, default 2)

Valid Range = [0,inf)

maxMeanSignal#: Maximum values (inclusive) of mean signal (in adu) below which to consider, per amp. The same cut is applied to all amps if this dictionary is of the form {‘ALL_AMPS’: value} (Dict, default {'ALL_AMPS': 1000000.0})

maxPtcRolloffDeviation#: Maximum percent difference between the model with saturation rolloff and the model without to set the PTC turnoff. Only used if doModelPtcRolloff=True. (float, default 0.01)

maxSignalInitialPtcOutlierFit#: Maximum signal considered for intial outlier fit. This should be below the PTC turnoff to ensure accurate outlier rejection. If scaleMaxSignalInitialPtcOutlierFit=True then the units are electrons; otherwise adu. (float, default 50000.0)

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

maximumRangeCovariancesAstierFullCovFit#: Maximum range up to where to fit covariances as in Astier+19, for the FULLCOVARIANCE model.This is different from maximumRangeCovariancesAstier.It should be less or equal than maximumRangeCovariancesAstier.The number of parameters for this model is 3*maximumRangeCovariancesAstierFullCovFit^2 + 1, so increase with care so that the fit is not too slow. (int, default 10)

minMeanSignal#: Minimum values (inclusive) of mean signal (in adu) per amp to use. The same cut is applied to all amps if this parameter [dict] is passed as {‘ALL_AMPS’: value} (Dict, default {'ALL_AMPS': 0.0})

minVarPivotSearch#: The code looks for a pivot signal point after which the variance starts decreasing at high-flux to exclude then from the PTC model fit. However, sometimes at low fluxes, the variance decreases slightly. Set this variable for the variance value, in adu^2, after which the pivot should be sought. Only used if doLegacyTurnoffSelection is True. Deprecated: This option has been deprecated and will be removed after v30. (float, default 10000)

polyDegLongRangeCovariances#: If doSubtractLongRangeCovariances is True, polynomial degree to fit data beyond startLongRangeCovariances. (int, default 1)

polynomialFitDegree#: Degree of polynomial to fit the PTC, when ‘ptcFitType’=POLYNOMIAL. Deprecated: This field is no longer used. Will be removed after v30. (int, default 3)

ptcFitType#

Fit PTC to Eq. 16 or Eq. 20 in Astier+19. (str, default 'EXPAPPROXIMATION')

Allowed values:

'EXPAPPROXIMATION': Approximation in Astier+19 (Eq. 16).
'FULLCOVARIANCE_NO_B': Full covariances model in Astier+19 (Eq. 15)
'FULLCOVARIANCE': Full covariances model in Astier+19 (Eq. 20)
'None': Field is optional

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

scaleMaxSignalInitialPtcOutlierFit#: Scale maxSignalInitialPtcOutlierFit and maxDeltaInitialPtcOutlierFit by approximate gain? If yes then maxSignalInitialPtcOutlierFit and maxDeltaInitialPtcOutlierFit are assumed to have units of electrons, otherwise adu. (bool, default True)

sigmaClipFullFitCovariancesAstier#: sigma clip for full model fit for FULLCOVARIANCE ptcFitType (float, default 5.0)

sigmaCutPtcOutliers#: Sigma cut for outlier rejection in PTC. (float, default 5.0)

startLongRangeCovariances#: If doSubtractLongRangeCovariances is True, subtract covariances beyond this range. It should be less than maximumRangeCovariancesAstier. (int, default 4)

Methods Documentation

validate()#

Validate the Config, raising an exception if invalid.

Raises#

lsst.pex.config.FieldValidationError: Raised if verification fails.

Notes#

The base class implementation performs type checks on all fields by calling their validate methods.

Complex single-field validation can be defined by deriving new Field types. For convenience, some derived lsst.pex.config.Field-types (ConfigField and ConfigChoiceField) are defined in lsst.pex.config that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived Config classes after calling this method, and base validation is complete.