UpdateVisitSummaryTask

UpdateVisitSummaryTask combines updated versions of the various Exposure component objects used to characterize and calibrate a single-epoch image into a single per-visit exposure catalog (finalVisitSummary). It also recomputes summary statistics to reflect these updates.

Processing summary

UpdateVisitSummaryTask reads in the initial summary dataset of essentially the same form (visitSummary), then replaces the object fields of each record with objects loaded from other (often optional) input datasets that contain newer (often final) versions of those objects. When an object field is replaced, any related summary statistics in the catalog’s non-object columns are also recomputed.

See connection and run argument documentation for details.

Python API summary

from lsst.drp.tasks.update_visit_summary import UpdateVisitSummaryTask

classUpdateVisitSummaryTask(*, initInputs: dict[str, Any] | None = None, **kwargs)

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

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(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...

See also

See the UpdateVisitSummaryTask API reference for complete details.

Butler datasets

When run through the runQuantum method, UpdateVisitSummaryTask obtains datasets from the input Butler data repository and persists outputs to the output Butler data repository.

In this mode, the PSF and aperture correction map are always replaced (since at present all relevant pipelines do recompute these), even though they are optional when calling lsst.drp.tasks.update_visit_summary.UpdateVisitSummaryTask.run directly.

The main output dataset, finalVisitSummary (by default), can typically be used to provide all downstream tasks with the best versions of all calibrations for each detector.

Retargetable subtasks

compute_summary_stats

Default

lsst.pipe.tasks.computeExposureSummaryStats.ComputeExposureSummaryStatsTask

Field type

ConfigurableField

Subtask that computes summary statistics from Exposure components.

Configuration fields

background_provider

Default

'input_summary'

Field type

str ChoiceField

Choices

'input_summary'

The input visit summary catalog already includes summary statistics for the final backgrounds that can be used as-is.

'replacement'

{“The ‘background_originals’ connection refers to a background model that has been superseded by the model referred to by the ‘background_overrides’ connection.”}

Which connection(s) and behavior to use when applying background overrides.

connections

Data type

lsst.pipe.base.config.Connections

Field type

ConfigField

Configurations describing the connections of the PipelineTask to datatypes

photo_calib_provider

Default

'input_summary'

Field type

str ChoiceField

Choices

'input_summary'

Propagate the PhotoCalib from the input visit summary catalog and do not recompute photometric calibration summary statistics.

'tract'

{“Use the ‘photo_calib_overrides_tract’ connection to load an `ExposureCatalog` with {visit, tract} dimensions and per-detector rows, and recommpute photometric calibration summary statistics.”}

'global'

{“Use the ‘photo_calib_overrides_global’ connection to load an `ExposureCatalog` with {visit} dimensions and per-detector rows, and recommpute photometric calibration summary statistics.”}

Which connection and behavior to use when applying photometric calibration overrides.

saveLogOutput

Default

True

Field type

bool Field

Flag to enable/disable saving of log output for a task, enabled by default.

saveMetadata

Default

True

Field type

bool Field

Flag to enable/disable metadata saving for a task, enabled by default.

wcs_provider

Default

'input_summary'

Field type

str ChoiceField

Choices

'input_summary'

Propagate the WCS from the input visit summary catalog and do not recompute WCS-based summary statistics.

'tract'

{“Use the ‘wcs_overrides_tract’ connection to load an `ExposureCatalog` with {visit, tract} dimensions and per-detector rows, and recommpute WCS-based summary statistics.”}

'global'

{“Use the ‘wcs_overrides_global’ connection to load an `ExposureCatalog` with {visit} dimensions and per-detector rows, and recommpute WCS-based summary statistics.”}

Which connection and behavior to use when applying WCS overrides.