lsst.cp.pipe  20.0.0-3-gc53c7b6
Static Public Attributes | List of all members
lsst.cp.pipe.defects.FindDefectsTaskConfig Class Reference
Inheritance diagram for lsst.cp.pipe.defects.FindDefectsTaskConfig:

Static Public Attributes

 isrForFlats
 
 isrForDarks
 
 isrMandatoryStepsFlats
 
 isrMandatoryStepsDarks
 
 isrForbiddenStepsFlats
 
 isrForbiddenStepsDarks
 
 isrDesirableSteps
 
 ccdKey
 
 imageTypeKey
 
 mode
 
 nSigmaBright
 
 nSigmaDark
 
 nPixBorderUpDown
 
 nPixBorderLeftRight
 
 badOnAndOffPixelColumnThreshold
 
 goodPixelColumnGapThreshold
 
 edgesAsDefects
 

Detailed Description

Config class for defect finding

Definition at line 46 of file defects.py.

Member Data Documentation

◆ badOnAndOffPixelColumnThreshold

lsst.cp.pipe.defects.FindDefectsTaskConfig.badOnAndOffPixelColumnThreshold
static
Initial value:
= pexConfig.Field(
dtype=int,
doc=("If BPC is the set of all the bad pixels in a given column (not necessarily consecutive) ",
"and the size of BPC is at least 'badOnAndOffPixelColumnThreshold', all the pixels between the ",
"pixels that satisfy minY (BPC) and maxY (BPC) will be marked as bad, with 'Y' being the long ",
"axis of the amplifier (and 'X' the other axis, which for a column is a constant for all ",
"pixels in the set BPC). If there are more than 'goodPixelColumnGapThreshold' consecutive ",
"non-bad pixels in BPC, an exception to the above is made and those consecutive ",
"'goodPixelColumnGapThreshold' are not marked as bad."),
default=50,
)

Definition at line 134 of file defects.py.

◆ ccdKey

lsst.cp.pipe.defects.FindDefectsTaskConfig.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 89 of file defects.py.

◆ edgesAsDefects

lsst.cp.pipe.defects.FindDefectsTaskConfig.edgesAsDefects
static
Initial value:
= pexConfig.Field(
dtype=bool,
doc=("Mark all edge pixels, as defined by nPixBorder[UpDown, LeftRight], as defects."
" Normal treatment is to simply exclude this region from the defect finding, such that no"
" defect will be located there."),
default=False,
)

Definition at line 151 of file defects.py.

◆ goodPixelColumnGapThreshold

lsst.cp.pipe.defects.FindDefectsTaskConfig.goodPixelColumnGapThreshold
static
Initial value:
= pexConfig.Field(
dtype=int,
doc=("Size, in pixels, of usable consecutive pixels in a column with on and off bad pixels (see ",
"'badOnAndOffPixelColumnThreshold')."),
default=30,
)

Definition at line 145 of file defects.py.

◆ imageTypeKey

lsst.cp.pipe.defects.FindDefectsTaskConfig.imageTypeKey
static
Initial value:
= pexConfig.Field(
dtype=str,
doc="The key for the butler to use by which to check whether images are darks or flats",
default='imageType',
)

Definition at line 94 of file defects.py.

◆ isrDesirableSteps

lsst.cp.pipe.defects.FindDefectsTaskConfig.isrDesirableSteps
static
Initial value:
= pexConfig.ListField(
dtype=str,
doc=("isr operations that it is advisable to perform, but are not mission-critical."
" WARNs are logged for any of these found to be False."),
default=['doBias']
)

Definition at line 83 of file defects.py.

◆ isrForbiddenStepsDarks

lsst.cp.pipe.defects.FindDefectsTaskConfig.isrForbiddenStepsDarks
static
Initial value:
= pexConfig.ListField(
dtype=str,
doc=("isr operations that must NOT be performed for valid results when using darks."
" Raises if any of these are True"),
default=['doBrighterFatter', 'doUseOpticsTransmission',
'doUseFilterTransmission', 'doUseSensorTransmission', 'doUseAtmosphereTransmission']
)

Definition at line 76 of file defects.py.

◆ isrForbiddenStepsFlats

lsst.cp.pipe.defects.FindDefectsTaskConfig.isrForbiddenStepsFlats
static
Initial value:
= pexConfig.ListField(
dtype=str,
doc=("isr operations that must NOT be performed for valid results when using flats."
" Raises if any of these are True"),
default=['doBrighterFatter', 'doUseOpticsTransmission',
'doUseFilterTransmission', 'doUseSensorTransmission', 'doUseAtmosphereTransmission']
)

Definition at line 69 of file defects.py.

◆ isrForDarks

lsst.cp.pipe.defects.FindDefectsTaskConfig.isrForDarks
static
Initial value:
= pexConfig.ConfigurableField(
target=IsrTask,
doc="Task to perform instrumental signature removal",
)

Definition at line 53 of file defects.py.

◆ isrForFlats

lsst.cp.pipe.defects.FindDefectsTaskConfig.isrForFlats
static
Initial value:
= pexConfig.ConfigurableField(
target=IsrTask,
doc="Task to perform instrumental signature removal",
)

Definition at line 49 of file defects.py.

◆ isrMandatoryStepsDarks

lsst.cp.pipe.defects.FindDefectsTaskConfig.isrMandatoryStepsDarks
static
Initial value:
= pexConfig.ListField(
dtype=str,
doc=("isr operations that must be performed for valid results when using darks. "
"Raises if any of these are False"),
default=['doAssembleCcd', 'doFringe']
)

Definition at line 63 of file defects.py.

◆ isrMandatoryStepsFlats

lsst.cp.pipe.defects.FindDefectsTaskConfig.isrMandatoryStepsFlats
static
Initial value:
= pexConfig.ListField(
dtype=str,
doc=("isr operations that must be performed for valid results when using flats."
" Raises if any of these are False"),
default=['doAssembleCcd', 'doFringe']
)

Definition at line 57 of file defects.py.

◆ mode

lsst.cp.pipe.defects.FindDefectsTaskConfig.mode
static
Initial value:
= pexConfig.ChoiceField(
doc=("Use single master calibs (flat and dark) for finding defects, or a list of raw visits?"
" If MASTER, a single visit number should be supplied, for which the corresponding master flat"
" and dark will be used. If VISITS, the list of visits will be used, treating the flats and "
" darks as appropriate, depending on their image types, as determined by their imageType from"
" config.imageTypeKey"),
dtype=str,
default="VISITS",
allowed={
"VISITS": "Calculate defects from a list of raw visits",
"MASTER": "Use the corresponding master calibs from the specified visit to measure defects",
}
)

Definition at line 99 of file defects.py.

◆ nPixBorderLeftRight

lsst.cp.pipe.defects.FindDefectsTaskConfig.nPixBorderLeftRight
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of pixels to exclude from left & right of image when looking for defects.",
default=7,
)

Definition at line 129 of file defects.py.

◆ nPixBorderUpDown

lsst.cp.pipe.defects.FindDefectsTaskConfig.nPixBorderUpDown
static
Initial value:
= pexConfig.Field(
dtype=int,
doc="Number of pixels to exclude from top & bottom of image when looking for defects.",
default=7,
)

Definition at line 124 of file defects.py.

◆ nSigmaBright

lsst.cp.pipe.defects.FindDefectsTaskConfig.nSigmaBright
static
Initial value:
= pexConfig.Field(
dtype=float,
doc=("Number of sigma above mean for bright pixel detection. The default value was found to be",
" appropriate for some LSST sensors in DM-17490."),
default=4.8,
)

Definition at line 112 of file defects.py.

◆ nSigmaDark

lsst.cp.pipe.defects.FindDefectsTaskConfig.nSigmaDark
static
Initial value:
= pexConfig.Field(
dtype=float,
doc=("Number of sigma below mean for dark pixel detection. The default value was found to be",
" appropriate for some LSST sensors in DM-17490."),
default=5.0,
)

Definition at line 118 of file defects.py.


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