ConsolidateVisitSummaryTask

ConsolidateVisitSummaryTask combines the non-trivial metadata, including the wcs, detector id, psf size and shape, filter, and bounding box corners into one per-visit exposure catalog (dataset visitSummary).

ConsolidateVisitSummaryTask is available as a command-line task, consolidateVisitSummary.py.

Processing summary

ConsolidateVisitSummaryTask reads in detector-level processed exposure metadata tables (dataset calexp) for a given visit, combines these data into an exposure catalog, and writes the result out as a visit-level summary catalog (dataset visitSummary). The metadata from each exposure/detector includes:

  • The visitInfo.
  • The wcs.
  • The photoCalib.
  • The physical_filter and band (if available).
  • The psf size, shape, and effective area at the center of the detector.
  • The corners of the bounding box in right ascension/declination.

Other quantities such as detector, PSF, aperture correction map, and transmission curve are not persisted because of storage concerns, and because of their limited utility as summary statistics.

consolidateVisitSummary.py command-line interface

consolidateVisitSummary.py REPOPATH [@file [@file2 ...]] [--output OUTPUTREPO | --rerun RERUN] [--id] [other options]

Key arguments:

REPOPATH

The input Butler repository’s URI or file path.

Key options:

--id

The data IDs to process.

See also

See Command-line task argument reference for details and additional options.

Python API summary

from lsst.pipe.tasks.postprocess import ConsolidateVisitSummaryTask
classConsolidateVisitSummaryTask(*, config: Optional[PipelineTaskConfig] = None, log: Optional[Union[logging.Logger, LsstLogAdapter]] = None, initInputs: Optional[Dict[str, Any]] = None, **kwargs)

Task to consolidate per-detector visit metadata...

attributeconfig

Access configuration fields and retargetable subtasks.

methodrun(**kwargs) -> Struct)

Run task algorithm on in-memory data...

methodrunDataRef(dataRefList)

Undocumented...

See also

See the ConsolidateVisitSummaryTask API reference for complete details.

Butler datasets

When run as the consolidateVisitSummary.py command-line task, or directly through the runDataRef method, ConsolidateVisitSummaryTask obtains datasets from the input Butler data repository and persists outputs to the output Butler data repository.

Input datasets

calexp
Per-detector, processed exposures with metadata (wcs, psf, etc.)

Output datasets

visitSummary
Per-visit summary catalog of ccd/visit metadata.

Examples

The following command shows an example of how to run the task on an example HSC repository.

consolidateVisitSummary.py /datasets/hsc/repo --rerun <rerun name> --id visit=30504