CompareWarpAssembleCoaddConfig¶
- class lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddConfig(*args, **kw)¶
Bases:
AssembleCoaddConfig
Attributes Summary
Task to assemble an artifact-free, PSF-matched Coadd to serve as a naive/first-iteration model of the static sky.
Mask planes that, if set, the associated pixel should not be included in the coaddTempExp.
Name of mask bit used for bright objects (
str
, default'BRIGHT_OBJECT'
)Calculate coadd variance from input variance by stacking statistic.Passed to StatisticsControl.setCalcErrorFromInputVariance() (
bool
, defaultTrue
)Number of iterations of outlier rejection; ignored if non-clipping statistic selected.
Coadd name: typically one of deep or goodSeeing.
Configuration for CoaddPsf (
CoaddPsfConfig
, default<class 'lsst.meas.algorithms.CoaddPsfConfig'>
)Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
Detect outlier sources on difference between each psfMatched warp and static sky model (
ConfigurableInstance
, default<class 'lsst.meas.algorithms.detection.SourceDetectionConfig'>
)Detect sources on static sky model.
Whether to apply external photometric calibration via an
lsst.afw.image.PhotoCalib
object.Whether to apply external astrometric calibration via an
lsst.afw.geom.SkyWcs
object.Attach a piecewise TransmissionCurve for the coadd? (requires all input Exposures to have TransmissionCurves).
Filter artifact candidates based on morphological criteria, i.g.
Create a bitwise map of coadd inputs (
bool
, defaultFalse
)Interpolate over NaN pixels? Also extrapolate, if necessary, but the results are ugly.
Set mask and flag bits for bright objects? (
bool
, defaultFalse
)Create image of number of contributing exposures for each pixel (
bool
, defaultFalse
)Perform online coaddition when statistic="MEAN" to save memory? (
bool
, defaultFalse
)Ignore artifact candidates that are mostly covered by the bad pixel mask, because they will be excluded anyway.
Rescue artifacts from clipping that completely lie within a footprint detectedon the PsfMatched Template Coadd.
Match to modelPsf? Sets makePsfMatched=True, makeDirect=False Deprecated: This field is no longer used.
Rescale Warp variance plane using empirical noise? (
bool
, defaultTrue
)Coadd only visits selected by a SelectVisitsTask (
bool
, defaultFalse
)Perform sigma clipped outlier rejection with MEANCLIP statistic? (DEPRECATED) (
bool
, defaultFalse
)Use ValidPolygons from shrunk Psf-Matched Calexps? Should be set to True by CompareWarp only.
Persist coadd? (
bool
, defaultTrue
)Grow streak footprints by this number multiplied by the PSF width (
float
, default5
)Should be set to True if fake sources have been inserted into the input data.
Add photometric calibration variance to warp variance plane.
Input map creation subtask.
Subtask that helps fill CoaddInputs catalogs added to the final Exposure (
ConfigurableInstance
, default<class 'lsst.pipe.tasks.coaddInputRecorder.CoaddInputRecorderConfig'>
)Task to interpolate (and extrapolate) over NaN pixels (
ConfigurableInstance
, default<class 'lsst.pipe.tasks.interpImage.InterpImageConfig'>
)Threshold (in fractional weight) of rejection at which we propagate a mask plane to the coadd; that is, we set the mask bit on the coadd if the fraction the rejected frames would have contributed exceeds this value.
Detect streaks on difference between each psfMatched warp and static sky model.
Size in pixels of matching kernel.
Fraction of local number of epochs (N) to use as effective maxNumEpochs for high N.
Fraction of local number of epochs (N) to use as effective maxNumEpochs for low N.
Charactistic maximum local number of epochs/visits in which an artifact candidate can appear and still be masked.
Model Psf factory (
ConfigurableInstance
, default<class 'lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory'>
)Prefilter artifact candidates that are mostly covered by these bad mask planes.
Prefilter artifact candidates with less than this fraction overlapping good pixels (
float
, default0.05
)Mask planes to remove before coadding (
List
, default['NOT_DEBLENDED']
)Flag to enable/disable saving of log output for a task, enabled by default.
Flag to enable/disable metadata saving for a task, enabled by default.
Rescale variance on warps (
ConfigurableInstance
, default<class 'lsst.meas.algorithms.scaleVariance.ScaleVarianceConfig'>
)Task to adjust the photometric zero point of the coadd temp exposures (
ConfigurableInstance
, default<class 'lsst.pipe.tasks.scaleZeroPoint.ScaleZeroPointConfig'>
)Image selection subtask.
Sigma for outlier rejection; ignored if non-clipping statistic selected.
Unitless fraction of pixels defining how much of the outlier region has to meet the temporal criteria.
Main stacking statistic for aggregating over the epochs.
Name of mask bit used for streaks (
str
, default'STREAK'
)Width, height of stack subregion size; make small enough that a full stack of images will fit into memory at once.
When using doApplyExternalPhotoCalib, use 'global' calibrations that are not run per-tract.
When using doApplyExternalSkyWcs, use 'global' calibrations that are not run per-tract.
Warp name: one of 'direct' or 'psfMatched' (
str
, default'direct'
)Methods Summary
applyConfigOverrides
(instrument, ...)Apply config overrides to this config instance.
compare
(other[, shortcut, rtol, atol, output])Compare this configuration to another
Config
for equality.formatHistory
(name, **kwargs)Format a configuration field's history to a human-readable format.
freeze
()Make this config, and all subconfigs, read-only.
items
()Get configurations as
(field name, field value)
pairs.keys
()Get field names.
load
(filename[, root])Modify this config in place by executing the Python code in a configuration file.
loadFromStream
(stream[, root, filename, ...])Modify this Config in place by executing the Python code in the provided stream.
loadFromString
(code[, root, filename, ...])Modify this Config in place by executing the Python code in the provided string.
names
()Get all the field names in the config, recursively.
save
(filename[, root])Save a Python script to the named file, which, when loaded, reproduces this config.
saveToStream
(outfile[, root, skipImports])Save a configuration file to a stream, which, when loaded, reproduces this config.
saveToString
([skipImports])Return the Python script form of this configuration as an executable string.
Subclass hook for computing defaults.
toDict
()Make a dictionary of field names and their values.
update
(**kw)Update values of fields specified by the keyword arguments.
validate
()Validate the Config, raising an exception if invalid.
values
()Get field values.
Attributes Documentation
- assembleStaticSkyModel¶
Task to assemble an artifact-free, PSF-matched Coadd to serve as a naive/first-iteration model of the static sky. (
ConfigurableInstance
, default<class 'lsst.pipe.tasks.assembleCoadd.AssembleCoaddConfig'>
)
- badMaskPlanes¶
Mask planes that, if set, the associated pixel should not be included in the coaddTempExp. (
List
, default('NO_DATA',)
)
- calcErrorFromInputVariance¶
Calculate coadd variance from input variance by stacking statistic.Passed to StatisticsControl.setCalcErrorFromInputVariance() (
bool
, defaultTrue
)
- clipIter¶
Number of iterations of outlier rejection; ignored if non-clipping statistic selected. (
int
, default2
)
- coaddPsf¶
Configuration for CoaddPsf (
CoaddPsfConfig
, default<class 'lsst.meas.algorithms.CoaddPsfConfig'>
)
- connections: pexConfig.ConfigField¶
Field which refers to a dynamically added configuration class which is based on a PipelineTaskConnections class.
- detect¶
Detect outlier sources on difference between each psfMatched warp and static sky model (
ConfigurableInstance
, default<class 'lsst.meas.algorithms.detection.SourceDetectionConfig'>
)
- detectTemplate¶
Detect sources on static sky model. Only used if doPreserveContainedBySource is True (
ConfigurableInstance
, default<class 'lsst.meas.algorithms.detection.SourceDetectionConfig'>
)
- doApplyExternalPhotoCalib¶
Whether to apply external photometric calibration via an
lsst.afw.image.PhotoCalib
object. Uses theexternalPhotoCalibName
field to determine which calibration to load. Deprecated: Deprecated in favor of the ‘visitSummary’ connection. Will be removed after v26. (bool
, defaultFalse
)
- doApplyExternalSkyWcs¶
Whether to apply external astrometric calibration via an
lsst.afw.geom.SkyWcs
object. UsesexternalSkyWcsName
field to determine which calibration to load. Deprecated: Deprecated in favor of the ‘visitSummary’ connection. Will be removed after v26. (bool
, defaultFalse
)
- doAttachTransmissionCurve¶
Attach a piecewise TransmissionCurve for the coadd? (requires all input Exposures to have TransmissionCurves). (
bool
, defaultFalse
)
- doFilterMorphological¶
Filter artifact candidates based on morphological criteria, i.g. those that appear to be streaks. (
bool
, defaultFalse
)
- doInterp¶
Interpolate over NaN pixels? Also extrapolate, if necessary, but the results are ugly. (
bool
, defaultTrue
)
- doOnlineForMean¶
Perform online coaddition when statistic=”MEAN” to save memory? (
bool
, defaultFalse
)
- doPrefilterArtifacts¶
Ignore artifact candidates that are mostly covered by the bad pixel mask, because they will be excluded anyway. This prevents them from contributing to the outlier epoch count image and potentially being labeled as persistant.’Mostly’ is defined by the config ‘prefilterArtifactsRatio’. (
bool
, defaultTrue
)
- doPreserveContainedBySource¶
Rescue artifacts from clipping that completely lie within a footprint detectedon the PsfMatched Template Coadd. Replicates a behavior of SafeClip. (
bool
, defaultTrue
)
- doPsfMatch¶
Match to modelPsf? Sets makePsfMatched=True, makeDirect=False Deprecated: This field is no longer used. Will be removed after v26. (
bool
, defaultFalse
)
- doSigmaClip¶
Perform sigma clipped outlier rejection with MEANCLIP statistic? (DEPRECATED) (
bool
, defaultFalse
)
- doUsePsfMatchedPolygons¶
Use ValidPolygons from shrunk Psf-Matched Calexps? Should be set to True by CompareWarp only. (
bool
, defaultFalse
)
- hasFakes¶
Should be set to True if fake sources have been inserted into the input data. (
bool
, defaultFalse
)
- history¶
Read-only history.
- inputMapper¶
Input map creation subtask. (
ConfigurableInstance
, default<class 'lsst.pipe.tasks.healSparseMapping.HealSparseInputMapConfig'>
)
- inputRecorder¶
Subtask that helps fill CoaddInputs catalogs added to the final Exposure (
ConfigurableInstance
, default<class 'lsst.pipe.tasks.coaddInputRecorder.CoaddInputRecorderConfig'>
)
- interpImage¶
Task to interpolate (and extrapolate) over NaN pixels (
ConfigurableInstance
, default<class 'lsst.pipe.tasks.interpImage.InterpImageConfig'>
)
- maskPropagationThresholds¶
Threshold (in fractional weight) of rejection at which we propagate a mask plane to the coadd; that is, we set the mask bit on the coadd if the fraction the rejected frames would have contributed exceeds this value. (
Dict
, default{'SAT': 0.1}
)
- maskStreaks¶
Detect streaks on difference between each psfMatched warp and static sky model. Only used if doFilterMorphological is True. Adds a mask plane to an exposure, with the mask plane name set bystreakMaskName (
ConfigurableInstance
, default<class 'lsst.pipe.tasks.maskStreaks.MaskStreaksConfig'>
)
- maxFractionEpochsHigh¶
Fraction of local number of epochs (N) to use as effective maxNumEpochs for high N. Effective maxNumEpochs = min(maxFractionEpochsLow * N, maxNumEpochs + maxFractionEpochsHigh * N) (
float
, default0.03
)Valid Range = [0.0,1.0)
- maxFractionEpochsLow¶
Fraction of local number of epochs (N) to use as effective maxNumEpochs for low N. Effective maxNumEpochs = min(maxFractionEpochsLow * N, maxNumEpochs + maxFractionEpochsHigh * N) (
float
, default0.4
)Valid Range = [0.0,1.0)
- maxNumEpochs¶
Charactistic maximum local number of epochs/visits in which an artifact candidate can appear and still be masked. The effective maxNumEpochs is a broken linear function of local number of epochs (N): min(maxFractionEpochsLow*N, maxNumEpochs + maxFractionEpochsHigh*N). For each footprint detected on the image difference between the psfMatched warp and static sky model, if a significant fraction of pixels (defined by spatialThreshold) are residuals in more than the computed effective maxNumEpochs, the artifact candidate is deemed persistant rather than transient and not masked. (
int
, default2
)
- modelPsf¶
Model Psf factory (
ConfigurableInstance
, default<class 'lsst.meas.algorithms.gaussianPsfFactory.GaussianPsfFactory'>
)
- prefilterArtifactsMaskPlanes¶
Prefilter artifact candidates that are mostly covered by these bad mask planes. (
List
, default('NO_DATA', 'BAD', 'SAT', 'SUSPECT')
)
- prefilterArtifactsRatio¶
Prefilter artifact candidates with less than this fraction overlapping good pixels (
float
, default0.05
)
- removeMaskPlanes¶
Mask planes to remove before coadding (
List
, default['NOT_DEBLENDED']
)
- saveLogOutput¶
Flag to enable/disable saving of log output for a task, enabled by default. (
bool
, defaultTrue
)
- saveMetadata¶
Flag to enable/disable metadata saving for a task, enabled by default. Deprecated: This field is deprecated and will be removed after v26. (
bool
, defaultTrue
)
- scaleWarpVariance¶
Rescale variance on warps (
ConfigurableInstance
, default<class 'lsst.meas.algorithms.scaleVariance.ScaleVarianceConfig'>
)
- scaleZeroPoint¶
Task to adjust the photometric zero point of the coadd temp exposures (
ConfigurableInstance
, default<class 'lsst.pipe.tasks.scaleZeroPoint.ScaleZeroPointConfig'>
)
- select¶
Image selection subtask. (
ConfigurableInstance
, default<class 'lsst.pipe.tasks.selectImages.PsfWcsSelectImagesConfig'>
)
- sigmaClip¶
Sigma for outlier rejection; ignored if non-clipping statistic selected. (
float
, default3.0
)
- spatialThreshold¶
Unitless fraction of pixels defining how much of the outlier region has to meet the temporal criteria. If 0, clip all. If 1, clip none. (
float
, default0.5
)Valid Range = [0.0,1.0]
- subregionSize¶
Width, height of stack subregion size; make small enough that a full stack of images will fit into memory at once. (
List
, default(2000, 2000)
)
- useGlobalExternalPhotoCalib¶
When using doApplyExternalPhotoCalib, use ‘global’ calibrations that are not run per-tract. When False, use per-tract photometric calibration files. Deprecated: Deprecated in favor of the ‘visitSummary’ connection. Will be removed after v26. (
bool
, defaultFalse
)
- useGlobalExternalSkyWcs¶
When using doApplyExternalSkyWcs, use ‘global’ calibrations that are not run per-tract. When False, use per-tract wcs files. Deprecated: Deprecated in favor of the ‘visitSummary’ connection. Will be removed after v26. (
bool
, defaultFalse
)
Methods Documentation
- applyConfigOverrides(instrument: Instrument | None, taskDefaultName: str, pipelineConfigs: Iterable[ConfigIR] | None, parameters: ParametersIR, label: str) None ¶
Apply config overrides to this config instance.
- Parameters:
- instrument
Instrument
orNone
An instance of the
Instrument
specified in a pipeline. IfNone
then the pipeline did not specify and instrument.- taskDefaultName
str
The default name associated with the
Task
class. This may be used with instrumental overrides.- pipelineConfigs
Iterable
ofConfigIR
An iterable of
ConfigIR
objects that contain overrides to apply to this config instance.- parameters
ParametersIR
Parameters defined in a Pipeline which are used in formatting of config values across multiple
Task
in a pipeline.- label
str
The label associated with this class’s Task in a pipeline.
- instrument
- compare(other, shortcut=True, rtol=1e-08, atol=1e-08, output=None)¶
Compare this configuration to another
Config
for equality.- Parameters:
- other
lsst.pex.config.Config
Other
Config
object to compare against this config.- shortcut
bool
, optional If
True
, return as soon as an inequality is found. Default isTrue
.- rtol
float
, optional Relative tolerance for floating point comparisons.
- atol
float
, optional Absolute tolerance for floating point comparisons.
- outputcallable, optional
A callable that takes a string, used (possibly repeatedly) to report inequalities.
- other
- Returns:
- isEqual
bool
True
when the twolsst.pex.config.Config
instances are equal.False
if there is an inequality.
- isEqual
See also
Notes
Unselected targets of
RegistryField
fields and unselected choices ofConfigChoiceField
fields are not considered by this method.Floating point comparisons are performed by
numpy.allclose
.
- formatHistory(name, **kwargs)¶
Format a configuration field’s history to a human-readable format.
- Parameters:
- name
str
Name of a
Field
in this config.- kwargs
Keyword arguments passed to
lsst.pex.config.history.format
.
- name
- Returns:
- history
str
A string containing the formatted history.
- history
See also
- freeze()¶
Make this config, and all subconfigs, read-only.
- items()¶
Get configurations as
(field name, field value)
pairs.- Returns:
- items
ItemsView
Iterator of tuples for each configuration. Tuple items are:
Field name.
Field value.
- items
- keys()¶
Get field names.
- Returns:
- names
KeysView
List of
lsst.pex.config.Field
names.
- names
- load(filename, root='config')¶
Modify this config in place by executing the Python code in a configuration file.
- Parameters:
- filename
str
Name of the configuration file. A configuration file is Python module.
- root
str
, optional Name of the variable in file that refers to the config being overridden.
For example, the value of root is
"config"
and the file contains:config.myField = 5
Then this config’s field
myField
is set to5
.
- filename
- loadFromStream(stream, root='config', filename=None, extraLocals=None)¶
Modify this Config in place by executing the Python code in the provided stream.
- Parameters:
- streamfile-like object,
str
,bytes
, or compiled string Stream containing configuration override code. If this is a code object, it should be compiled with
mode="exec"
.- root
str
, optional Name of the variable in file that refers to the config being overridden.
For example, the value of root is
"config"
and the file contains:config.myField = 5
Then this config’s field
myField
is set to5
.- filename
str
, optional Name of the configuration file, or
None
if unknown or contained in the stream. Used for error reporting.- extraLocals
dict
ofstr
toobject
, optional Any extra variables to include in local scope when loading.
- streamfile-like object,
See also
Notes
For backwards compatibility reasons, this method accepts strings, bytes and code objects as well as file-like objects. New code should use
loadFromString
instead for most of these types.
- loadFromString(code, root='config', filename=None, extraLocals=None)¶
Modify this Config in place by executing the Python code in the provided string.
- Parameters:
- code
str
,bytes
, or compiled string Stream containing configuration override code.
- root
str
, optional Name of the variable in file that refers to the config being overridden.
For example, the value of root is
"config"
and the file contains:config.myField = 5
Then this config’s field
myField
is set to5
.- filename
str
, optional Name of the configuration file, or
None
if unknown or contained in the stream. Used for error reporting.- extraLocals
dict
ofstr
toobject
, optional Any extra variables to include in local scope when loading.
- code
- Raises:
- ValueError
Raised if a key in extraLocals is the same value as the value of the root argument.
- save(filename, root='config')¶
Save a Python script to the named file, which, when loaded, reproduces this config.
- Parameters:
- filename
str
Desination filename of this configuration.
- root
str
, optional Name to use for the root config variable. The same value must be used when loading (see
lsst.pex.config.Config.load
).
- filename
- saveToStream(outfile, root='config', skipImports=False)¶
Save a configuration file to a stream, which, when loaded, reproduces this config.
- Parameters:
- outfilefile-like object
Destination file object write the config into. Accepts strings not bytes.
- root
Name to use for the root config variable. The same value must be used when loading (see
lsst.pex.config.Config.load
).- skipImports
bool
, optional If
True
then do not includeimport
statements in output, this is to support human-oriented output frompipetask
where additional clutter is not useful.
- saveToString(skipImports=False)¶
Return the Python script form of this configuration as an executable string.
- Parameters:
- Returns:
- code
str
A code string readable by
loadFromString
.
- code
- setDefaults()¶
Subclass hook for computing defaults.
Notes
Derived
Config
classes that must compute defaults rather than using theField
instances’s defaults should do so here. To correctly use inherited defaults, implementations ofsetDefaults
must call their base class’ssetDefaults
.
- toDict()¶
Make a dictionary of field names and their values.
See also
Notes
This method uses the
toDict
method of individual fields. Subclasses ofField
may need to implement atoDict
method for this method to work.
- update(**kw)¶
Update values of fields specified by the keyword arguments.
- Parameters:
- kw
Keywords are configuration field names. Values are configuration field values.
Notes
The
__at
and__label
keyword arguments are special internal keywords. They are used to strip out any internal steps from the history tracebacks of the config. Do not modify these keywords to subvert aConfig
instance’s history.Examples
This is a config with three fields:
>>> from lsst.pex.config import Config, Field >>> class DemoConfig(Config): ... fieldA = Field(doc='Field A', dtype=int, default=42) ... fieldB = Field(doc='Field B', dtype=bool, default=True) ... fieldC = Field(doc='Field C', dtype=str, default='Hello world') ... >>> config = DemoConfig()
These are the default values of each field:
>>> for name, value in config.iteritems(): ... print(f"{name}: {value}") ... fieldA: 42 fieldB: True fieldC: 'Hello world'
Using this method to update
fieldA
andfieldC
:>>> config.update(fieldA=13, fieldC='Updated!')
Now the values of each field are:
>>> for name, value in config.iteritems(): ... print(f"{name}: {value}") ... fieldA: 13 fieldB: True fieldC: 'Updated!'
- 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
andConfigChoiceField
) are defined inlsst.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.
- values()¶
Get field values.
- Returns:
- values
ValuesView
Iterator of field values.
- values