lsst.pipe.tasks.update_visit_summary.PerTractInput Class Reference

Inheritance diagram for lsst.pipe.tasks.update_visit_summary.PerTractInput:

Public Member Functions
PerTractInput	load (cls, ButlerQuantumContext|Butler butler, BaseSkyMap sky_map, Iterable[DatasetRef] refs)
tuple[int, ExposureRecord|None]	best_for_detector (self, int detector_id, SpherePoint|None center=None, Box2I|None bbox=None)

Detailed Description

Wrapper class for input `~lsst.afw.table.ExposureCatalog` datasets
that are per-tract.

This selects the best tract via the minimum average distance (on the sky)
from the detector's corners to the tract center.

Definition at line 133 of file update_visit_summary.py.

Member Function Documentation

best_for_detector()

tuple[int, ExposureRecord | None] lsst.pipe.tasks.update_visit_summary.PerTractInput.best_for_detector	(		self,
		int	detector_id,
		SpherePoint | None	center = None,
		Box2I | None	bbox = None
	)

Return the exposure record for this detector that is the best match
for this detector.

Parameters
----------
detector_id : `int`
    Detector ID; used to find the right row in the catalog or catalogs.
center : `lsst.geom.SpherePoint` or `None`
    Center of the detector in sky coordinates.  If not provided, one
    will be computed via `compute_center_for_detector_record`.
bbox : `lsst.geom.Box2I`, optional
    Bounding box for the detector in its own pixel coordinates.

Returns
-------
tract_id : `int`
    ID of the tract that supplied this record, or `-1` if ``record`` is
    `None` or if the input was not per-tract.
record : `lsst.afw.table.ExposureRecord` or `None`
    Best record for this detector, or `None` if there either were no
    records for this detector or no WCS available to compute a center.

Reimplemented from lsst.pipe.tasks.update_visit_summary.PossiblyMultipleInput.

Definition at line 182 of file update_visit_summary.py.

load()

PerTractInput lsst.pipe.tasks.update_visit_summary.PerTractInput.load	(		cls,
		ButlerQuantumContext | Butler	butler,
		BaseSkyMap	sky_map,
		Iterable[DatasetRef]	refs
	)

Load and wrap input catalogs.

Parameters
----------
butler : `lsst.pipe.base.ButlerQuantumContext`
    Butler proxy used in `~lsst.pipe.base.PipelineTask.runQuantum`.
sky_map : `lsst.skymap.BaseSkyMap`
    Definition of tracts and patches.
refs : `~collections.abc.Iterable` [`lsst.daf.butler.DatasetRef`]
    References to the catalog datasets to load.

Returns
-------
wrapper : `PerTractInput`
    Wrapper object for the loaded catalogs.

Definition at line 148 of file update_visit_summary.py.

---

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

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