lsst.pipe.tasks g540474b770+e2881a99e2
Loading...
Searching...
No Matches
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 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 1499 of file postprocess.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 1519 of file postprocess.py.

Member Function Documentation

◆ 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.
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 1551 of file postprocess.py.

◆ runQuantum()

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

Definition at line 1530 of file postprocess.py.

Member Data Documentation

◆ _DefaultName

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

Definition at line 1516 of file postprocess.py.

◆ ConfigClass

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

Definition at line 1517 of file postprocess.py.

◆ schema

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

Definition at line 1521 of file postprocess.py.

◆ visitSummarySchema

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

Definition at line 1528 of file postprocess.py.


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