lsst.pipe.tasks.extended_psf Namespace Reference

Classes
class	DetectorsInRegion
class	ExtendedPsf
class	FocalPlaneRegionExtendedPsf
class	MeasureExtendedPsfConfig
class	MeasureExtendedPsfConnections
class	MeasureExtendedPsfTask
class	StackBrightStarsConfig
class	StackBrightStarsTask

Functions
	find_region_for_detector (detector_id, detectors_focal_plane_regions)

Detailed Description

Read preprocessed bright stars and stack to build an extended PSF model.

Function Documentation

find_region_for_detector()

lsst.pipe.tasks.extended_psf.find_region_for_detector	(		detector_id,
			detectors_focal_plane_regions )

Find the focal plane region that contains a given detector.

Parameters
----------
detector_id : `int`
    The detector ID.

detectors_focal_plane_regions :
        `dict` [`str`, `lsst.pipe.tasks.extended_psf.DetectorsInRegion`]
    A dictionary containing focal plane region names as keys, and the
    corresponding detector IDs encoded within the values.

Returns
-------
key: `str`
    The name of the region to which the given detector belongs.

Raises
------
KeyError
    Raised if the given detector is not included in any focal plane region.

Definition at line 47 of file extended_psf.py.

def find_region_for_detector(detector_id, detectors_focal_plane_regions):
    """Find the focal plane region that contains a given detector.
 
    Parameters
    ----------
    detector_id : `int`
        The detector ID.
 
    detectors_focal_plane_regions :
            `dict` [`str`, `lsst.pipe.tasks.extended_psf.DetectorsInRegion`]
        A dictionary containing focal plane region names as keys, and the
        corresponding detector IDs encoded within the values.
 
    Returns
    -------
    key: `str`
        The name of the region to which the given detector belongs.
 
    Raises
    ------
    KeyError
        Raised if the given detector is not included in any focal plane region.
    """
    for region_id, detectors_in_region in detectors_focal_plane_regions.items():
        if detector_id in detectors_in_region.detectors:
            return region_id
    raise KeyError(
        "Detector %d is not included in any focal plane region.",
        detector_id,
    )