lsst.pipe.tasks.postprocess.ConsolidateVisitSummaryTask Class Reference

Inheritance diagram for lsst.pipe.tasks.postprocess.ConsolidateVisitSummaryTask:

Public Member Functions
	__init__ (self, **kwargs)
	runQuantum (self, butlerQC, inputRefs, outputRefs)
	run (self, *, visit, handles, camera=None, result=None)

Public Attributes
	schema = afwTable.ExposureTable.makeMinimalSchema()
	visitSummarySchema = afwTable.ExposureCatalog(self.schema)

Static Public Attributes
	ConfigClass = ConsolidateVisitSummaryConfig

Static Protected Member Functions
	_readLegacyComponents (handle, readVisitInfo)
	_readFutureComponents (handle, readVisitInfo)

Static Protected Attributes
str	_DefaultName = "consolidateVisitSummary"

Detailed Description

Task to consolidate per-detector visit metadata.

This task aggregates the following metadata from all the detectors in a
single visit into an exposure catalog:
- The visitInfo.
- The wcs.
- The photoCalib.
- The physical_filter and band (if available).
- The PSF model.
- The aperture correction map.
- The transmission curve.
- The psf size, shape, and effective area at the center of the detector.
- The corners of the bounding box in right ascension/declination.

Tests for this task are performed in ci_hsc_gen3.

Definition at line 1517 of file postprocess.py.

Constructor & Destructor Documentation

__init__()

lsst.pipe.tasks.postprocess.ConsolidateVisitSummaryTask.__init__	(		self,
		**	kwargs )

Definition at line 1537 of file postprocess.py.

Member Function Documentation

_readFutureComponents()

lsst.pipe.tasks.postprocess.ConsolidateVisitSummaryTask._readFutureComponents ( handle, readVisitInfo )

staticprotected

Read the metadata of one detector from an `lsst.images.VisitImage`
and convert it to legacy types.

Parameters
----------
handle : `lsst.daf.butler.DeferredDatasetHandle`
    Handle to the visit image.
readVisitInfo : `bool`
    Whether to read the visit info and filter label, which are the same
    for every detector in a visit.

Returns
-------
components : `lsst.pipe.base.Struct`
    Struct with the same attributes as `_readLegacyComponents`.

Definition at line 1690 of file postprocess.py.

_readLegacyComponents()

lsst.pipe.tasks.postprocess.ConsolidateVisitSummaryTask._readLegacyComponents ( handle, readVisitInfo )

staticprotected

Read the metadata of one detector from an
`lsst.afw.image.Exposure`.

Parameters
----------
handle : `lsst.daf.butler.DeferredDatasetHandle`
    Handle to the exposure.
readVisitInfo : `bool`
    Whether to read the visit info and filter label, which are the same
    for every detector in a visit.

Returns
-------
components : `lsst.pipe.base.Struct`
    Struct with ``visitInfo``, ``filterLabel`` (`None` unless
    ``readVisitInfo``), ``summaryStats``, ``wcs``, ``photoCalib``,
    ``bbox`` and ``validPolygon`` attributes.

Definition at line 1660 of file postprocess.py.

run()

lsst.pipe.tasks.postprocess.ConsolidateVisitSummaryTask.run	(		self,
		*	,
			visit,
			handles,
			camera = None,
			result = None )

Make a combined exposure catalog from a list of handles.
These handles must point to exposures with wcs, summaryStats,
and other visit metadata.

Parameters
----------
visit : `int`
    Visit identification number.
handles : `list` of `lsst.daf.butler.DeferredDatasetHandle`
    List of handles in visit, to `lsst.afw.image.Exposure` or
    `lsst.images.VisitImage` datasets depending on
    ``config.input_image_type``.
camera : `lsst.afw.cameraGeom.Camera`, optional
    Camera geometry.  Required if and only if
    ``do_refit_pointing=True``.
result : `lsst.pipe.base.Struct`, optional
    Output struct to modify in-place.

Returns
-------
result : `lsst.pipe.base.Struct`
    Struct with the following attributes:

    - ``visitSummary`` (`lsst.afw.table.ExposureCatalog`): an Exposure
      catalog with per-detector summary information.
    - ``visit_geometry`` (`lsst.obs.base.visit_geometry.VisitGeometry`):
      Regions that can be used to update butler dimension regions for
      this visit.  Only present if ``do_refit_pointing=True``.

Definition at line 1569 of file postprocess.py.

runQuantum()

lsst.pipe.tasks.postprocess.ConsolidateVisitSummaryTask.runQuantum	(		self,
			butlerQC,
			inputRefs,
			outputRefs )

Definition at line 1548 of file postprocess.py.

Member Data Documentation

_DefaultName

str lsst.pipe.tasks.postprocess.ConsolidateVisitSummaryTask._DefaultName = "consolidateVisitSummary"

staticprotected

Definition at line 1534 of file postprocess.py.

ConfigClass

lsst.pipe.tasks.postprocess.ConsolidateVisitSummaryTask.ConfigClass = ConsolidateVisitSummaryConfig

static

Definition at line 1535 of file postprocess.py.

schema

lsst.pipe.tasks.postprocess.ConsolidateVisitSummaryTask.schema = afwTable.ExposureTable.makeMinimalSchema()

Definition at line 1539 of file postprocess.py.

visitSummarySchema

lsst.pipe.tasks.postprocess.ConsolidateVisitSummaryTask.visitSummarySchema = afwTable.ExposureCatalog(self.schema)

Definition at line 1546 of file postprocess.py.

---

The documentation for this class was generated from the following file:

• python/lsst/pipe/tasks/postprocess.py