DcrAssembleCoaddConnections#

class lsst.drp.tasks.dcr_assemble_coadd.DcrAssembleCoaddConnections(*, config: PipelineTaskConfig | None = None)#

Bases: CompareWarpAssembleCoaddConnections

Attributes Summary

`allConnections`	Mapping holding all connection attributes.
`artifactMasks`	Connection for output dataset.
`brightObjectMask`	Class used for declaring PipelineTask prerequisite connections.
`coaddExposure`	Connection for output dataset.
`dcrCoadds`	Connection for output dataset.
`dcrNImages`	Connection for output dataset.
`defaultTemplates`
`deprecatedTemplates`
`dimensions`	Set of dimension names that define the unit of work for this task.
`initInputs`	Set with the names of all `InitInput` connection attributes.
`initOutputs`	Set with the names of all `InitOutput` connection attributes.
`inputMap`	Connection for output dataset.
`inputWarps`	Class used for declaring PipelineTask input connections.
`inputs`	Set with the names of all `connectionTypes.Input` connection attributes.
`nImage`	Connection for output dataset.
`outputs`	Set with the names of all `Output` connection attributes.
`prerequisiteInputs`	Set with the names of all `PrerequisiteInput` connection attributes.
`psfMatchedWarps`	Class used for declaring PipelineTask input connections.
`selectedVisits`	Class used for declaring PipelineTask input connections.
`skyMap`	Class used for declaring PipelineTask input connections.
`templateCoadd`	Connection for output dataset.
`templateExposure`	Class used for declaring PipelineTask input connections.

Attributes Documentation

allConnections: Mapping[str, BaseConnection] = {'artifactMasks': Output(name='compare_warp_artifact_mask', storageClass='Mask', doc='Mask of artifacts detected in the coadd', multiple=True, deprecated=None, _deprecation_context='', dimensions=('tract', 'patch', 'skymap', 'visit', 'instrument'), isCalibration=False), 'brightObjectMask': PrerequisiteInput(name='brightObjectMask', storageClass='ObjectMaskCatalog', doc='Input Bright Object Mask mask produced with external catalogs to be applied to the mask plane BRIGHT_OBJECT.', multiple=False, deprecated=None, _deprecation_context='', dimensions=('tract', 'patch', 'skymap', 'band'), isCalibration=False, deferLoad=False, minimum=0, lookupFunction=None), 'coaddExposure': Output(name='{outputCoaddName}Coadd{warpTypeSuffix}', storageClass='ExposureF', doc='Output coadded exposure, produced by stacking input warps', multiple=False, deprecated=None, _deprecation_context='', dimensions=('tract', 'patch', 'skymap', 'band'), isCalibration=False), 'dcrCoadds': Output(name='{fakesType}{outputCoaddName}Coadd{warpTypeSuffix}', storageClass='ExposureF', doc='Output coadded exposure, produced by stacking input warps', multiple=True, deprecated=None, _deprecation_context='', dimensions=('tract', 'patch', 'skymap', 'band', 'subfilter'), isCalibration=False), 'dcrNImages': Output(name='{outputCoaddName}Coadd_nImage', storageClass='ImageU', doc='Output image of number of input images per pixel', multiple=True, deprecated=None, _deprecation_context='', dimensions=('tract', 'patch', 'skymap', 'band', 'subfilter'), isCalibration=False), 'inputMap': Output(name='{outputCoaddName}Coadd_inputMap', storageClass='HealSparseMap', doc='Output healsparse map of input images', multiple=False, deprecated=None, _deprecation_context='', dimensions=('tract', 'patch', 'skymap', 'band'), isCalibration=False), 'inputWarps': Input(name='{inputWarpName}Coadd_{warpType}Warp', storageClass='ExposureF', doc='Input list of warps to be assembled i.e. stacked.Note that this will often be different than the inputCoaddName.WarpType (e.g. direct, psfMatched) is controlled by the warpType config parameter', multiple=True, deprecated=None, _deprecation_context='', dimensions=('tract', 'patch', 'skymap', 'visit', 'instrument'), isCalibration=False, deferLoad=True, minimum=1, deferGraphConstraint=False, deferBinding=False), 'nImage': Output(name='{outputCoaddName}Coadd_nImage', storageClass='ImageU', doc='Output image of number of input images per pixel', multiple=False, deprecated=None, _deprecation_context='', dimensions=('tract', 'patch', 'skymap', 'band'), isCalibration=False), 'psfMatchedWarps': Input(name='{inputCoaddName}Coadd_psfMatchedWarp', storageClass='ExposureF', doc='PSF-Matched Warps are required by CompareWarp regardless of the coadd type requested. Only PSF-Matched Warps make sense for image subtraction. Therefore, they must be an additional declared input.', multiple=True, deprecated=None, _deprecation_context='', dimensions=('tract', 'patch', 'skymap', 'visit'), isCalibration=False, deferLoad=True, minimum=1, deferGraphConstraint=False, deferBinding=False), 'selectedVisits': Input(name='{outputCoaddName}Visits', storageClass='StructuredDataDict', doc='Selected visits to be coadded.', multiple=False, deprecated=None, _deprecation_context='', dimensions=('instrument', 'tract', 'patch', 'skymap', 'band'), isCalibration=False, deferLoad=False, minimum=1, deferGraphConstraint=False, deferBinding=False), 'skyMap': Input(name='skyMap', storageClass='SkyMap', doc='Input definition of geometry/bbox and projection/wcs for coadded exposures', multiple=False, deprecated=None, _deprecation_context='', dimensions=('skymap',), isCalibration=False, deferLoad=False, minimum=1, deferGraphConstraint=False, deferBinding=False), 'templateCoadd': Output(name='{outputCoaddName}CoaddPsfMatched', storageClass='ExposureF', doc='Model of the static sky, used to find temporal artifacts. Typically a PSF-Matched, sigma-clipped coadd. Written if and only if assembleStaticSkyModel.doWrite=True', multiple=False, deprecated=None, _deprecation_context='', dimensions=('tract', 'patch', 'skymap', 'band'), isCalibration=False), 'templateExposure': Input(name='{fakesType}{inputCoaddName}Coadd{warpTypeSuffix}', storageClass='ExposureF', doc='Input coadded exposure, produced by previous call to AssembleCoadd', multiple=False, deprecated=None, _deprecation_context='', dimensions=('tract', 'patch', 'skymap', 'band'), isCalibration=False, deferLoad=False, minimum=1, deferGraphConstraint=False, deferBinding=False)}#

Mapping holding all connection attributes.

This is a read-only view that is automatically updated when connection attributes are added, removed, or replaced in __init__. It is also updated after __init__ completes to reflect changes in inputs, prerequisiteInputs, outputs, initInputs, and initOutputs.

artifactMasks#: Connection for output dataset.

brightObjectMask#

Class used for declaring PipelineTask prerequisite connections.

Attributes#

namestr: The default name used to identify the dataset type.
storageClassstr: The storage class used when (un)/persisting the dataset type.
multiplebool: Indicates if this connection should expect to contain multiple objects of the given dataset type. Tasks with more than one connection with multiple=True with the same dimensions may want to implement PipelineTaskConnections.adjustQuantum to ensure those datasets are consistent (i.e. zip-iterable) in PipelineTask.runQuantum and notify the execution system as early as possible of outputs that will not be produced because the corresponding input is missing.
dimensionsiterable of str: The lsst.daf.butler.Butler lsst.daf.butler.Registry dimensions used to identify the dataset type identified by the specified name.
minimumbool: Minimum number of datasets required for this connection, per quantum. This is checked in the base implementation of PipelineTaskConnections.adjustQuantum, which raises FileNotFoundError (causing QuantumGraph generation to fail). PipelineTask implementations may provide custom adjustQuantum implementations for more fine-grained or configuration-driven constraints, as long as they are compatible with this minium.
lookupFunctiontyping.Callable, optional: An optional callable function that will look up PrerequisiteInputs using the DatasetType, registry, quantum dataId, and input collections passed to it. If no function is specified, the default temporal spatial lookup will be used.

Raises#

TypeError: Raised if minimum is greater than one but multiple=False.

Notes#

Prerequisite inputs are used for datasets that must exist in the data repository before a pipeline including this is run; they cannot be produced by another task in the same pipeline.

In exchange for this limitation, they have a number of advantages relative to regular Input connections:

The query used to find them then during QuantumGraph generation can be fully customized by providing a lookupFunction.
Failed searches for prerequisites during QuantumGraph generation will usually generate more helpful diagnostics than those for regular Input connections.
The default query for prerequisite inputs relates the quantum dimensions directly to the dimensions of its dataset type, without being constrained by any of the other dimensions in the pipeline. This allows them to be used for temporal calibration lookups (which regular Input connections cannot do at present) and to work around QuantumGraph generation limitations involving cases where naive spatial overlap relationships between dimensions are not desired (e.g. a task that wants all detectors in each visit for which the visit overlaps a tract, not just those where that detector+visit combination overlaps the tract).
Prerequisite inputs may be optional (regular inputs are never optional).

coaddExposure#: Connection for output dataset.

dcrCoadds#: Connection for output dataset.

dcrNImages#: Connection for output dataset.

defaultTemplates = {'fakesType': '', 'inputCoaddName': 'deep', 'inputWarpName': 'deep', 'outputCoaddName': 'dcr', 'warpType': 'direct', 'warpTypeSuffix': ''}#

deprecatedTemplates = {}#

dimensions: set[str] = {'band', 'patch', 'skymap', 'tract'}#

Set of dimension names that define the unit of work for this task.

Required and implied dependencies will automatically be expanded later and need not be provided.

This may be replaced or modified in __init__ to change the dimensions of the task. After __init__ it will be a frozenset and may not be replaced.

initInputs: set[str] = frozenset({})#

Set with the names of all InitInput connection attributes.

See inputs for additional information.

initOutputs: set[str] = frozenset({})#

Set with the names of all InitOutput connection attributes.

See inputs for additional information.

inputMap#: Connection for output dataset.

inputWarps#

Class used for declaring PipelineTask input connections.

Attributes#

namestr: The default name used to identify the dataset type.
storageClassstr: The storage class used when (un)/persisting the dataset type.
multiplebool: Indicates if this connection should expect to contain multiple objects of the given dataset type. Tasks with more than one connection with multiple=True with the same dimensions may want to implement PipelineTaskConnections.adjustQuantum to ensure those datasets are consistent (i.e. zip-iterable) in PipelineTask.runQuantum and notify the execution system as early as possible of outputs that will not be produced because the corresponding input is missing.
dimensionsiterable of str: The lsst.daf.butler.Butler lsst.daf.butler.Registry dimensions used to identify the dataset type identified by the specified name.
deferLoadbool: Indicates that this dataset type will be loaded as a lsst.daf.butler.DeferredDatasetHandle. PipelineTasks can use this object to load the object at a later time.
minimumbool: Minimum number of datasets required for this connection, per quantum. This is checked in the base implementation of PipelineTaskConnections.adjustQuantum, which raises NoWorkFound if the minimum is not met for Input connections (causing the quantum to be pruned, skipped, or never created, depending on the context), and FileNotFoundError for PrerequisiteInput connections (causing QuantumGraph generation to fail). PipelineTask implementations may provide custom adjustQuantum implementations for more fine-grained or configuration-driven constraints, as long as they are compatible with this minium.
deferGraphConstraintbool, optional: If True, do not include this dataset type’s existence in the initial query that starts the QuantumGraph generation process. This can be used to make QuantumGraph generation faster by avoiding redundant datasets, and in certain cases it can (along with careful attention to which tasks are included in the same QuantumGraph) be used to work around the QuantumGraph generation algorithm’s inflexible handling of spatial overlaps. This option has no effect when the connection is not an overall input of the pipeline (or subset thereof) for which a graph is being created, and it never affects the ordering of quanta.
deferBindingbool, optional: If True, the dataset will not be automatically included in the pipeline graph, deferGraphConstraint is implied. The custom QuantumGraphBuilder is required to bind it and add a corresponding edge to the pipeline graph. This option allows to have the same dataset type as both input and output of a quantum.

Raises#

TypeError: Raised if minimum is greater than one but multiple=False.
NotImplementedError: Raised if minimum is zero for a regular Input connection; this is not currently supported by our QuantumGraph generation algorithm.

inputs: set[str] = frozenset({'inputWarps', 'psfMatchedWarps', 'selectedVisits', 'skyMap', 'templateExposure'})#

Set with the names of all connectionTypes.Input connection attributes.

This is updated automatically as class attributes are added, removed, or replaced in __init__. Removing entries from this set will cause those connections to be removed after __init__ completes, but this is supported only for backwards compatibility; new code should instead just delete the collection attributed directly. After __init__ this will be a frozenset and may not be replaced.

nImage#: Connection for output dataset.

outputs: set[str] = frozenset({'artifactMasks', 'coaddExposure', 'dcrCoadds', 'dcrNImages', 'inputMap', 'nImage', 'templateCoadd'})#

Set with the names of all Output connection attributes.

See inputs for additional information.

prerequisiteInputs: set[str] = frozenset({'brightObjectMask'})#

Set with the names of all PrerequisiteInput connection attributes.

See inputs for additional information.

psfMatchedWarps#

Class used for declaring PipelineTask input connections.

Attributes#

namestr: The default name used to identify the dataset type.
storageClassstr: The storage class used when (un)/persisting the dataset type.
multiplebool: Indicates if this connection should expect to contain multiple objects of the given dataset type. Tasks with more than one connection with multiple=True with the same dimensions may want to implement PipelineTaskConnections.adjustQuantum to ensure those datasets are consistent (i.e. zip-iterable) in PipelineTask.runQuantum and notify the execution system as early as possible of outputs that will not be produced because the corresponding input is missing.
dimensionsiterable of str: The lsst.daf.butler.Butler lsst.daf.butler.Registry dimensions used to identify the dataset type identified by the specified name.
deferLoadbool: Indicates that this dataset type will be loaded as a lsst.daf.butler.DeferredDatasetHandle. PipelineTasks can use this object to load the object at a later time.
minimumbool: Minimum number of datasets required for this connection, per quantum. This is checked in the base implementation of PipelineTaskConnections.adjustQuantum, which raises NoWorkFound if the minimum is not met for Input connections (causing the quantum to be pruned, skipped, or never created, depending on the context), and FileNotFoundError for PrerequisiteInput connections (causing QuantumGraph generation to fail). PipelineTask implementations may provide custom adjustQuantum implementations for more fine-grained or configuration-driven constraints, as long as they are compatible with this minium.
deferGraphConstraintbool, optional: If True, do not include this dataset type’s existence in the initial query that starts the QuantumGraph generation process. This can be used to make QuantumGraph generation faster by avoiding redundant datasets, and in certain cases it can (along with careful attention to which tasks are included in the same QuantumGraph) be used to work around the QuantumGraph generation algorithm’s inflexible handling of spatial overlaps. This option has no effect when the connection is not an overall input of the pipeline (or subset thereof) for which a graph is being created, and it never affects the ordering of quanta.
deferBindingbool, optional: If True, the dataset will not be automatically included in the pipeline graph, deferGraphConstraint is implied. The custom QuantumGraphBuilder is required to bind it and add a corresponding edge to the pipeline graph. This option allows to have the same dataset type as both input and output of a quantum.

Raises#

TypeError: Raised if minimum is greater than one but multiple=False.
NotImplementedError: Raised if minimum is zero for a regular Input connection; this is not currently supported by our QuantumGraph generation algorithm.

selectedVisits#

Class used for declaring PipelineTask input connections.

Attributes#

namestr: The default name used to identify the dataset type.
storageClassstr: The storage class used when (un)/persisting the dataset type.
multiplebool: Indicates if this connection should expect to contain multiple objects of the given dataset type. Tasks with more than one connection with multiple=True with the same dimensions may want to implement PipelineTaskConnections.adjustQuantum to ensure those datasets are consistent (i.e. zip-iterable) in PipelineTask.runQuantum and notify the execution system as early as possible of outputs that will not be produced because the corresponding input is missing.
dimensionsiterable of str: The lsst.daf.butler.Butler lsst.daf.butler.Registry dimensions used to identify the dataset type identified by the specified name.
deferLoadbool: Indicates that this dataset type will be loaded as a lsst.daf.butler.DeferredDatasetHandle. PipelineTasks can use this object to load the object at a later time.
minimumbool: Minimum number of datasets required for this connection, per quantum. This is checked in the base implementation of PipelineTaskConnections.adjustQuantum, which raises NoWorkFound if the minimum is not met for Input connections (causing the quantum to be pruned, skipped, or never created, depending on the context), and FileNotFoundError for PrerequisiteInput connections (causing QuantumGraph generation to fail). PipelineTask implementations may provide custom adjustQuantum implementations for more fine-grained or configuration-driven constraints, as long as they are compatible with this minium.
deferGraphConstraintbool, optional: If True, do not include this dataset type’s existence in the initial query that starts the QuantumGraph generation process. This can be used to make QuantumGraph generation faster by avoiding redundant datasets, and in certain cases it can (along with careful attention to which tasks are included in the same QuantumGraph) be used to work around the QuantumGraph generation algorithm’s inflexible handling of spatial overlaps. This option has no effect when the connection is not an overall input of the pipeline (or subset thereof) for which a graph is being created, and it never affects the ordering of quanta.
deferBindingbool, optional: If True, the dataset will not be automatically included in the pipeline graph, deferGraphConstraint is implied. The custom QuantumGraphBuilder is required to bind it and add a corresponding edge to the pipeline graph. This option allows to have the same dataset type as both input and output of a quantum.

Raises#

TypeError: Raised if minimum is greater than one but multiple=False.
NotImplementedError: Raised if minimum is zero for a regular Input connection; this is not currently supported by our QuantumGraph generation algorithm.

skyMap#

Class used for declaring PipelineTask input connections.

Attributes#

namestr: The default name used to identify the dataset type.
storageClassstr: The storage class used when (un)/persisting the dataset type.
multiplebool: Indicates if this connection should expect to contain multiple objects of the given dataset type. Tasks with more than one connection with multiple=True with the same dimensions may want to implement PipelineTaskConnections.adjustQuantum to ensure those datasets are consistent (i.e. zip-iterable) in PipelineTask.runQuantum and notify the execution system as early as possible of outputs that will not be produced because the corresponding input is missing.
dimensionsiterable of str: The lsst.daf.butler.Butler lsst.daf.butler.Registry dimensions used to identify the dataset type identified by the specified name.
deferLoadbool: Indicates that this dataset type will be loaded as a lsst.daf.butler.DeferredDatasetHandle. PipelineTasks can use this object to load the object at a later time.
minimumbool: Minimum number of datasets required for this connection, per quantum. This is checked in the base implementation of PipelineTaskConnections.adjustQuantum, which raises NoWorkFound if the minimum is not met for Input connections (causing the quantum to be pruned, skipped, or never created, depending on the context), and FileNotFoundError for PrerequisiteInput connections (causing QuantumGraph generation to fail). PipelineTask implementations may provide custom adjustQuantum implementations for more fine-grained or configuration-driven constraints, as long as they are compatible with this minium.
deferGraphConstraintbool, optional: If True, do not include this dataset type’s existence in the initial query that starts the QuantumGraph generation process. This can be used to make QuantumGraph generation faster by avoiding redundant datasets, and in certain cases it can (along with careful attention to which tasks are included in the same QuantumGraph) be used to work around the QuantumGraph generation algorithm’s inflexible handling of spatial overlaps. This option has no effect when the connection is not an overall input of the pipeline (or subset thereof) for which a graph is being created, and it never affects the ordering of quanta.
deferBindingbool, optional: If True, the dataset will not be automatically included in the pipeline graph, deferGraphConstraint is implied. The custom QuantumGraphBuilder is required to bind it and add a corresponding edge to the pipeline graph. This option allows to have the same dataset type as both input and output of a quantum.

Raises#

TypeError: Raised if minimum is greater than one but multiple=False.
NotImplementedError: Raised if minimum is zero for a regular Input connection; this is not currently supported by our QuantumGraph generation algorithm.

templateCoadd#: Connection for output dataset.

templateExposure#

Class used for declaring PipelineTask input connections.

Attributes#

namestr: The default name used to identify the dataset type.
storageClassstr: The storage class used when (un)/persisting the dataset type.
multiplebool: Indicates if this connection should expect to contain multiple objects of the given dataset type. Tasks with more than one connection with multiple=True with the same dimensions may want to implement PipelineTaskConnections.adjustQuantum to ensure those datasets are consistent (i.e. zip-iterable) in PipelineTask.runQuantum and notify the execution system as early as possible of outputs that will not be produced because the corresponding input is missing.
dimensionsiterable of str: The lsst.daf.butler.Butler lsst.daf.butler.Registry dimensions used to identify the dataset type identified by the specified name.
deferLoadbool: Indicates that this dataset type will be loaded as a lsst.daf.butler.DeferredDatasetHandle. PipelineTasks can use this object to load the object at a later time.
minimumbool: Minimum number of datasets required for this connection, per quantum. This is checked in the base implementation of PipelineTaskConnections.adjustQuantum, which raises NoWorkFound if the minimum is not met for Input connections (causing the quantum to be pruned, skipped, or never created, depending on the context), and FileNotFoundError for PrerequisiteInput connections (causing QuantumGraph generation to fail). PipelineTask implementations may provide custom adjustQuantum implementations for more fine-grained or configuration-driven constraints, as long as they are compatible with this minium.
deferGraphConstraintbool, optional: If True, do not include this dataset type’s existence in the initial query that starts the QuantumGraph generation process. This can be used to make QuantumGraph generation faster by avoiding redundant datasets, and in certain cases it can (along with careful attention to which tasks are included in the same QuantumGraph) be used to work around the QuantumGraph generation algorithm’s inflexible handling of spatial overlaps. This option has no effect when the connection is not an overall input of the pipeline (or subset thereof) for which a graph is being created, and it never affects the ordering of quanta.
deferBindingbool, optional: If True, the dataset will not be automatically included in the pipeline graph, deferGraphConstraint is implied. The custom QuantumGraphBuilder is required to bind it and add a corresponding edge to the pipeline graph. This option allows to have the same dataset type as both input and output of a quantum.

Raises#

TypeError: Raised if minimum is greater than one but multiple=False.
NotImplementedError: Raised if minimum is zero for a regular Input connection; this is not currently supported by our QuantumGraph generation algorithm.