PhotonTransferCurveSolveTask¶
PhotonTransferCurveSolveTask combines the partial photon transfer curve (PTC) datasets from pairs of flats, and produces the complete curve, fitting the gains, read noises, and measuring the covariances.
Processing summary¶
PhotonTransferCurveSolveTask runs these operations:
Collates the multiple single-pair input PTC datasets.
Fits either a full-covariance model, or one of two simpler approximations (polynomial and Astier+19 exponential approximation).
Persists the final complete dataset to disk.
Python API summary¶
from lsst.cp.pipe.ptc.cpPtcSolve import PhotonTransferCurveSolveTask
-
class
PhotonTransferCurveSolveTask(*, config=None, log=None, initInputs=None, **kwargs) Task to fit the PTC from flat covariances
...
- attributeconfig
Access configuration fields and retargetable subtasks.
See also
See the PhotonTransferCurveSolveTask API reference for complete details.
Retargetable subtasks¶
No subtasks.
Configuration fields¶
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¶
- Data type
lsst.pipe.base.config.PhotonTransferCurveSolveConfigConnections- Field type
Configurations describing the connections of the PipelineTask to datatypes
consecutivePointsVarDecreases¶
- Default
2- Field type
- Range
[2,inf)
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.
doAmpOffsetGainRatioFixup¶
Do gain ratio fixup based on amp offsets?
doFitBootstrap¶
Use bootstrap for the PTC fit parameters and errors?.
doLegacyTurnoffSelection¶
Use ‘legacy’ computation for PTC turnoff selection. If set to False, then the KS test p-value selection will be used instead.
doSubtractLongRangeCovariances¶
Subtract long-range covariances before FULLCOVARIANCE fit, beyond startLongRangeCovariances?
ksTestMinPvalue¶
Minimum value of the Gaussian histogram KS test p-value to be used in PTC fit. Only used if doLegacyTurnoffSelection is False.
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.
maxIterFullFitCovariancesAstier¶
Maximum number of iterations in full model fit for FULLCOVARIANCE ptcFitType
maxIterationsPtcOutliers¶
- Default
2- Field type
- Range
[0,inf)
Maximum number of iterations for outlier rejection in PTC.
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}
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.
maximumRangeCovariancesAstier¶
Maximum range of measured covariances as in Astier+19
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. The same cut is applied to all amps if this parameter [dict] is passed as {‘ALL_AMPS’: value}
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.
polyDegLongRangeCovariances¶
If doSubtractLongRangeCovariances is True, polynomial degree to fit data beyond startLongRangeCovariances.
polynomialFitDegree¶
Degree of polynomial to fit the PTC, when ‘ptcFitType’=POLYNOMIAL.
ptcFitType¶
- Default
'POLYNOMIAL'- Field type
strChoiceField(optional)- Choices
'POLYNOMIAL'n-degree polynomial (use ‘polynomialFitDegree’ to set ‘n’).
'EXPAPPROXIMATION'Approximation in Astier+19 (Eq. 16).
'FULLCOVARIANCE'Full covariances model in Astier+19 (Eq. 20)
NoneField is optional
Fit PTC to Eq. 16, Eq. 20 in Astier+19, or to a polynomial.
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
sigmaCutPtcOutliers¶
Sigma cut for outlier rejection in PTC.
startLongRangeCovariances¶
If doSubtractLongRangeCovariances is True, subtract covariances beyond this range. It should be less than maximumRangeCovariancesAstier.