lsst.cp.pipe  20.0.0-11-g716e02e+073108dc36
Static Public Attributes | List of all members
lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig Class Reference
Inheritance diagram for lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig:

Static Public Attributes

 ccdKey
 
 ptcFitType
 
 sigmaClipFullFitCovariancesAstier
 
 maxIterFullFitCovariancesAstier
 
 maximumRangeCovariancesAstier
 
 covAstierRealSpace
 
 polynomialFitDegree
 
 doCreateLinearizer
 
 linearizerType
 
 polynomialFitDegreeNonLinearity
 
 binSize
 
 minMeanSignal
 
 maxMeanSignal
 
 initialNonLinearityExclusionThresholdPositive
 
 initialNonLinearityExclusionThresholdNegative
 
 sigmaCutPtcOutliers
 
 maskNameList
 
 nSigmaClipPtc
 
 nIterSigmaClipPtc
 
 maxIterationsPtcOutliers
 
 doFitBootstrap
 
 maxAduForLookupTableLinearizer
 
 instrumentName
 

Detailed Description

Config class for photon transfer curve measurement task

Definition at line 46 of file ptc.py.

Member Data Documentation

◆ binSize

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.binSize
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Bin the image by this factor in both dimensions.",
default=1,
)

Definition at line 109 of file ptc.py.

◆ ccdKey

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.ccdKey
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="The key by which to pull a detector from a dataId, e.g. 'ccd' or 'detector'.",
default='ccd',
)

Definition at line 48 of file ptc.py.

◆ covAstierRealSpace

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.covAstierRealSpace
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Calculate covariances in real space or via FFT? (see appendix A of Astier+19).",
default=False,
)

Definition at line 78 of file ptc.py.

◆ doCreateLinearizer

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.doCreateLinearizer
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Calculate non-linearity and persist linearizer?",
default=False,
)

Definition at line 88 of file ptc.py.

◆ doFitBootstrap

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.doFitBootstrap
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc="Use bootstrap for the PTC fit parameters and errors?.",
default=False,
)

Definition at line 169 of file ptc.py.

◆ initialNonLinearityExclusionThresholdNegative

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.initialNonLinearityExclusionThresholdNegative
static
Initial value:
= pexConfig.RangeField(
dtype=float,
doc="Initially exclude data points with a variance that are more than a factor of this from being"
" linear in the negative direction, from the PTC fit. Note that these points will also be"
" excluded from the non-linearity fit. This is done before the iterative outlier rejection,"
" to allow an accurate determination of the sigmas for said iterative fit.",
default=0.25,
min=0.0,
max=1.0,
)

Definition at line 134 of file ptc.py.

◆ initialNonLinearityExclusionThresholdPositive

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.initialNonLinearityExclusionThresholdPositive
static
Initial value:
= pexConfig.RangeField(
dtype=float,
doc="Initially exclude data points with a variance that are more than a factor of this from being"
" linear in the positive direction, from the PTC fit. Note that these points will also be"
" excluded from the non-linearity fit. This is done before the iterative outlier rejection,"
" to allow an accurate determination of the sigmas for said iterative fit.",
default=0.12,
min=0.0,
max=1.0,
)

Definition at line 124 of file ptc.py.

◆ instrumentName

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.instrumentName
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="Instrument name.",
default='',
)

Definition at line 179 of file ptc.py.

◆ linearizerType

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.linearizerType
static
Initial value:
= pexConfig.ChoiceField(
dtype=str,
doc="Linearizer type, if doCreateLinearizer=True",
default="LINEARIZEPOLYNOMIAL",
allowed={
"LINEARIZEPOLYNOMIAL": "n-degree polynomial (use 'polynomialFitDegreeNonLinearity' to set 'n').",
"LINEARIZESQUARED": "c0 quadratic coefficient derived from coefficients of polynomiual fit",
"LOOKUPTABLE": "Loouk table formed from linear part of polynomial fit."
}
)

Definition at line 93 of file ptc.py.

◆ maskNameList

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.maskNameList
static
Initial value:
= pexConfig.ListField(
dtype=str,
doc="Mask list to exclude from statistics calculations.",
default=['SUSPECT', 'BAD', 'NO_DATA'],
)

Definition at line 149 of file ptc.py.

◆ maxAduForLookupTableLinearizer

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.maxAduForLookupTableLinearizer
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Maximum DN value for the LookupTable linearizer.",
default=2**18,
)

Definition at line 174 of file ptc.py.

◆ maximumRangeCovariancesAstier

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.maximumRangeCovariancesAstier
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Maximum range of covariances as in Astier+19",
default=8,
)

Definition at line 73 of file ptc.py.

◆ maxIterationsPtcOutliers

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.maxIterationsPtcOutliers
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Maximum number of iterations for outlier rejection in PTC.",
default=2,
)

Definition at line 164 of file ptc.py.

◆ maxIterFullFitCovariancesAstier

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.maxIterFullFitCovariancesAstier
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Maximum number of iterations in full model fit for FULLCOVARIANCE ptcFitType",
default=3,
)

Definition at line 68 of file ptc.py.

◆ maxMeanSignal

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.maxMeanSignal
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Maximum value (inclusive) of mean signal (in DN) below which to consider.",
default=9e6,
)

Definition at line 119 of file ptc.py.

◆ minMeanSignal

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.minMeanSignal
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Minimum value (inclusive) of mean signal (in DN) above which to consider.",
default=0,
)

Definition at line 114 of file ptc.py.

◆ nIterSigmaClipPtc

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.nIterSigmaClipPtc
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of sigma-clipping iterations for afwMath.StatisticsControl()",
default=1,
)

Definition at line 159 of file ptc.py.

◆ nSigmaClipPtc

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.nSigmaClipPtc
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Sigma cut for afwMath.StatisticsControl()",
default=5.5,
)

Definition at line 154 of file ptc.py.

◆ polynomialFitDegree

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.polynomialFitDegree
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Degree of polynomial to fit the PTC, when 'ptcFitType'=POLYNOMIAL.",
default=3,
)

Definition at line 83 of file ptc.py.

◆ polynomialFitDegreeNonLinearity

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.polynomialFitDegreeNonLinearity
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="If doCreateLinearizer, degree of polynomial to fit the meanSignal vs exposureTime" +
" curve to produce the table for LinearizeLookupTable.",
default=3,
)

Definition at line 103 of file ptc.py.

◆ ptcFitType

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.ptcFitType
static
Initial value:
= pexConfig.ChoiceField(
dtype=str,
doc="Fit PTC to approximation in Astier+19 (Equation 16) or to a polynomial.",
default="POLYNOMIAL",
allowed={
"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)"
}
)

Definition at line 53 of file ptc.py.

◆ sigmaClipFullFitCovariancesAstier

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.sigmaClipFullFitCovariancesAstier
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="sigma clip for full model fit for FULLCOVARIANCE ptcFitType ",
default=5.0,
)

Definition at line 63 of file ptc.py.

◆ sigmaCutPtcOutliers

lsst.cp.pipe.ptc.MeasurePhotonTransferCurveTaskConfig.sigmaCutPtcOutliers
static
Initial value:
= pexConfig.Field(
dtype=float,
doc="Sigma cut for outlier rejection in PTC.",
default=5.0,
)

Definition at line 144 of file ptc.py.


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