UpdateVisitSummaryTask¶

class lsst.drp.tasks.update_visit_summary.UpdateVisitSummaryTask(*, initInputs: Optional[dict, None] = None, **kwargs)¶

Bases: lsst.pipe.base.PipelineTask

A pipeline task that creates a new visit-summary table after all lsst.afw.image.Exposure components have been finalized.

Notes

This task is designed to be run just prior to making warps for coaddition, as it aggregates all inputs other than the images and backgrounds into a single ExposureCatalog dataset and recomputes summary statistics that are useful in selecting which images should go into a coadd. Its output can also be used to reconstruct a final processed visit image when combined with a post-ISR image, the background model, and the final mask.

Attributes Summary

canMultiprocess

Methods Summary

`emptyMetadata`()	Empty (clear) the metadata for this Task and all sub-Tasks.
`getFullMetadata`()	Get metadata for all tasks.
`getFullName`()	Get the task name as a hierarchical name including parent task names.
`getName`()	Get the name of the task.
`getResourceConfig`()	Return resource configuration for this task.
`getTaskDict`()	Get a dictionary of all tasks as a shallow copy.
`makeField`(doc)	Make a `lsst.pex.config.ConfigurableField` for this task.
`makeSubtask`(name, **keyArgs)	Create a subtask as a new instance as the `name` attribute of this task.
`run`(input_summary_catalog, input_exposures, …)	Build an updated version of a visit summary catalog.
`runQuantum`(butlerQC, inputRefs, outputRefs)	Method to do butler IO and or transforms to provide in memory objects for tasks run method
`timer`(name, logLevel)	Context manager to log performance data for an arbitrary block of code.

Attributes Documentation

canMultiprocess = True¶

Methods Documentation

emptyMetadata() → None¶: Empty (clear) the metadata for this Task and all sub-Tasks.

getFullMetadata() → lsst.pipe.base._task_metadata.TaskMetadata¶

Get metadata for all tasks.

Returns:	metadata : `TaskMetadata` The keys are the full task name. Values are metadata for the top-level task and all subtasks, sub-subtasks, etc.

Notes

The returned metadata includes timing information (if @timer.timeMethod is used) and any metadata set by the task. The name of each item consists of the full task name with . replaced by :, followed by . and the name of the item, e.g.:

topLevelTaskName:subtaskName:subsubtaskName.itemName

using : in the full task name disambiguates the rare situation that a task has a subtask and a metadata item with the same name.

getFullName() → str¶

Get the task name as a hierarchical name including parent task names.

Returns:	fullName : `str` The full name consists of the name of the parent task and each subtask separated by periods. For example: The full name of top-level task “top” is simply “top”. The full name of subtask “sub” of top-level task “top” is “top.sub”. The full name of subtask “sub2” of subtask “sub” of top-level task “top” is “top.sub.sub2”.

getName() → str¶

Get the name of the task.

Returns:	taskName : `str` Name of the task.

See also

getFullName

getResourceConfig() → Optional[ResourceConfig]¶

Return resource configuration for this task.

Returns:	Object of type `ResourceConfig` or `None` if resource configuration is not defined for this task.

getTaskDict() → Dict[str, weakref.ReferenceType[lsst.pipe.base.task.Task]]¶

Get a dictionary of all tasks as a shallow copy.

Returns:	taskDict : `dict` Dictionary containing full task name: task object for the top-level task and all subtasks, sub-subtasks, etc.

classmethod makeField(doc: str) → lsst.pex.config.configurableField.ConfigurableField¶

Make a lsst.pex.config.ConfigurableField for this task.

Parameters:	doc : `str` Help text for the field.
Returns:	configurableField : `lsst.pex.config.ConfigurableField` A `ConfigurableField` for this task.

Examples

Provides a convenient way to specify this task is a subtask of another task.

Here is an example of use:

class OtherTaskConfig(lsst.pex.config.Config):
    aSubtask = ATaskClass.makeField("brief description of task")

makeSubtask(name: str, **keyArgs) → None¶

Create a subtask as a new instance as the name attribute of this task.

Parameters:	name : `str` Brief name of the subtask. keyArgs Extra keyword arguments used to construct the task. The following arguments are automatically provided and cannot be overridden: “config”. “parentTask”.

Notes

The subtask must be defined by Task.config.name, an instance of ConfigurableField or RegistryField.

run(input_summary_catalog: lsst.afw.table.ExposureCatalog, input_exposures: collections.abc.Mapping[int, lsst.daf.butler._deferredDatasetHandle.DeferredDatasetHandle], psf_overrides: Optional[lsst.afw.table.ExposureCatalog, None] = None, psf_star_catalog: Optional[astropy.table.table.Table, None] = None, ap_corr_overrides: Optional[lsst.afw.table.ExposureCatalog, None] = None, photo_calib_overrides: Optional[lsst.drp.tasks.update_visit_summary.PossiblyMultipleInput, None] = None, wcs_overrides: Optional[lsst.drp.tasks.update_visit_summary.PossiblyMultipleInput, None] = None, background_originals: Optional[collections.abc.Mapping[int, lsst.daf.butler._deferredDatasetHandle.DeferredDatasetHandle], None] = None, background_overrides: Optional[collections.abc.Mapping[int, lsst.daf.butler._deferredDatasetHandle.DeferredDatasetHandle], None] = None)¶

Build an updated version of a visit summary catalog.

Parameters:

input_summary_catalog : lsst.afw.table.ExposureCatalog: Input catalog. Each row in this catalog will be used to produce a row in the output catalog. Any override parameter that is None will leave the corresponding values unchanged from those in this input catalog.
input_exposures : collections.abc.Mapping [int,: lsst.daf.butler.DeferredDatasetHandle]

Deferred-load objects that fetch lsst.afw.image.Exposure instances. Only the image, mask, and variance are used; all other components are assumed to be superceded by at least input_summary_catalog and probably some _overrides arguments as well. This usually corresponds to the calexp dataset.
psf_overrides : lsst.afw.table.ExposureCatalog, optional: Catalog with attached lsst.afw.detection.Psf objects that supersede the input catalog’s PSFs.
psf_star_catalog : astropy.table.Table, optional: Table containing PSF stars for use in computing PSF summary statistics. Must be provided if psf_overrides is.
ap_corr_overrides : lsst.afw.table.ExposureCatalog, optional: Catalog with attached lsst.afw.image.ApCorrMap objects that supersede the input catalog’s aperture corrections.
photo_calib_overrides : PossiblyMultipleInput, optional: Catalog wrappers with attached lsst.afw.image.PhotoCalib objects that supersede the input catalog’s photometric calibrations.
wcs_overrides : PossiblyMultipleInput, optional: Catalog wrappers with attached lsst.afw.geom.SkyWcs objects that supersede the input catalog’s astrometric calibrations.
background_originals : collections.abc.Mapping [int,: lsst.daf.butler.DeferredDatasetHandle], optional

Deferred-load objects that fetch lsst.afw.math.BackgroundList instances. These should correspond to the background already subtracted from input_exposures. If not provided and background_overrides is, it is assumed that the background in input_exposures has not been subtracted. If provided, all keys in background_overrides must also be present in background_originals.
background_overrides : collections.abc.Mapping [int,: lsst.daf.butler.DeferredDatasetHandle], optional

Deferred-load objects that fetch lsst.afw.math.BackgroundList instances. These should correspond to the background that should now be subtracted from``input_exposures`` to yield the final background-subtracted image.

Returns:

output_summary_catalog : lsst.afw.table.ExposureCatalog: Output visit summary catalog.

Notes

If any override parameter is provided but does not have a value for a particular detector, that component will be set to None in the returned catalog for that detector and all summary statistics derived from that component will be reset (usually to NaN) as well. Not passing an override parameter at all will instead pass through the original component and values from the input catalog unchanged.

runQuantum(butlerQC: lsst.pipe.base.butlerQuantumContext.ButlerQuantumContext, inputRefs: lsst.pipe.base.connections.InputQuantizedConnection, outputRefs: lsst.pipe.base.connections.OutputQuantizedConnection) → None¶

Method to do butler IO and or transforms to provide in memory objects for tasks run method

Parameters:

butlerQC : ButlerQuantumContext: A butler which is specialized to operate in the context of a lsst.daf.butler.Quantum.
inputRefs : InputQuantizedConnection: Datastructure whose attribute names are the names that identify connections defined in corresponding PipelineTaskConnections class. The values of these attributes are the lsst.daf.butler.DatasetRef objects associated with the defined input/prerequisite connections.
outputRefs : OutputQuantizedConnection: Datastructure whose attribute names are the names that identify connections defined in corresponding PipelineTaskConnections class. The values of these attributes are the lsst.daf.butler.DatasetRef objects associated with the defined output connections.

timer(name: str, logLevel: int = 10) → Iterator[None]¶

Context manager to log performance data for an arbitrary block of code.

Parameters:	name : `str` Name of code being timed; data will be logged using item name: `Start` and `End`. logLevel A `logging` level constant.

Navigation

UpdateVisitSummaryTask¶