Inheritance diagram for lsst.pipe.tasks.extended_psf.MeasureExtendedPsfTask:

Public Member Functions
	__init__ (self, initInputs=None, args, *kwargs)

	select_detector_refs (self, ref_list)

	runQuantum (self, butlerQC, inputRefs, outputRefs)

Public Attributes
	detectors_focal_plane_regions

	regionless_dets

Static Public Attributes
	ConfigClass = MeasureExtendedPsfConfig

Static Protected Attributes
str	_DefaultName = "measureExtendedPsf"

Detailed Description

Build and save extended PSF model.

The model is built by stacking bright star stamps, extracted and
preprocessed by
`lsst.pipe.tasks.processBrightStars.ProcessBrightStarsTask`.

If a mapping from detector IDs to focal plane regions is provided, a
different extended PSF model will be built for each focal plane region. If
not, a single constant extended PSF model is built with all available data.

Definition at line 509 of file extended_psf.py.

Constructor & Destructor Documentation

◆ init()

lsst.pipe.tasks.extended_psf.MeasureExtendedPsfTask.__init__	(		self,
			initInputs = None,
		*	args,
		**	kwargs )

Definition at line 524 of file extended_psf.py.

    def __init__(self, initInputs=None, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.makeSubtask("stack_bright_stars")
        self.detectors_focal_plane_regions = self.config.detectors_focal_plane_regions
        self.regionless_dets = []
 

Member Function Documentation

◆ runQuantum()

lsst.pipe.tasks.extended_psf.MeasureExtendedPsfTask.runQuantum	(	self,
		butlerQC,
		inputRefs,
		outputRefs )

Definition at line 559 of file extended_psf.py.

    def runQuantum(self, butlerQC, inputRefs, outputRefs):
        input_data = butlerQC.get(inputRefs)
        bss_ref_list = input_data["input_brightStarStamps"]
        # Creating the metadata dictionary to store the number of stars used to
        # generate the PSF model(s).
        self.metadata["psfStarCount"] = {}
        if not self.config.detectors_focal_plane_regions:
            self.log.info(
                "No detector groups were provided to MeasureExtendedPsfTask; computing a single, "
                "constant extended PSF model over all available observations."
            )
            # Creating the sub-dictionary to store the number of stars when one
            # PSF modle is generated for focal plane.
            self.metadata["psfStarCount"]["all"] = 0
            output_e_psf = ExtendedPsf(
                self.stack_bright_stars.run(bss_ref_list, self.metadata["psfStarCount"])
            )
        else:
            output_e_psf = ExtendedPsf()
            region_ref_list = self.select_detector_refs(bss_ref_list)
            for region_name, ref_list in region_ref_list.items():
                if not ref_list:
                    # no valid references found
                    self.log.warning(
                        "No valid brightStarStamps reference found for region '%s'; skipping it.",
                        region_name,
                    )
                    continue
                # Creating the sub-dictionary to store the number of stars
                # that are used to generate the PSF model for the current
                # region.
                self.metadata["psfStarCount"][region_name] = 0
                ext_psf = self.stack_bright_stars.run(ref_list, self.metadata["psfStarCount"], region_name)
                output_e_psf.add_regional_extended_psf(
                    ext_psf, region_name, self.detectors_focal_plane_regions[region_name]
                )
        output = Struct(extended_psf=output_e_psf)
        butlerQC.put(output, outputRefs)

◆ select_detector_refs()

lsst.pipe.tasks.extended_psf.MeasureExtendedPsfTask.select_detector_refs	(		self,
			ref_list )

Split available sets of bright star stamps according to focal plane
regions.

Parameters
----------
ref_list : `list` of
        `lsst.daf.butler._deferredDatasetHandle.DeferredDatasetHandle`
    List of available bright star stamps data references.

Definition at line 530 of file extended_psf.py.

    def select_detector_refs(self, ref_list):
        """Split available sets of bright star stamps according to focal plane
        regions.
 
        Parameters
        ----------
        ref_list : `list` of
                `lsst.daf.butler._deferredDatasetHandle.DeferredDatasetHandle`
            List of available bright star stamps data references.
        """
        region_ref_list = {region: [] for region in self.detectors_focal_plane_regions.keys()}
        for dataset_handle in ref_list:
            detector_id = dataset_handle.ref.dataId["detector"]
            if detector_id in self.regionless_dets:
                continue
            try:
                region_name = find_region_for_detector(detector_id, self.detectors_focal_plane_regions)
            except KeyError:
                self.log.warning(
                    "Bright stars were available for detector %d, but it was missing from the %s config "
                    "field, so they will not be used to build any of the extended PSF models.",
                    detector_id,
                    "'detectors_focal_plane_regions'",
                )
                self.regionless_dets.append(detector_id)
                continue
            region_ref_list[region_name].append(dataset_handle)
        return region_ref_list
 

Member Data Documentation

◆ _DefaultName

str lsst.pipe.tasks.extended_psf.MeasureExtendedPsfTask._DefaultName = "measureExtendedPsf"

staticprotected

Definition at line 522 of file extended_psf.py.

◆ ConfigClass

lsst.pipe.tasks.extended_psf.MeasureExtendedPsfTask.ConfigClass = MeasureExtendedPsfConfig

static

Definition at line 521 of file extended_psf.py.

◆ detectors_focal_plane_regions

lsst.pipe.tasks.extended_psf.MeasureExtendedPsfTask.detectors_focal_plane_regions

Definition at line 527 of file extended_psf.py.

◆ regionless_dets

lsst.pipe.tasks.extended_psf.MeasureExtendedPsfTask.regionless_dets

Definition at line 528 of file extended_psf.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pipe_tasks/g29320951ab+012e1474a1/python/lsst/pipe/tasks/extended_psf.py

Public Member Functions

Public Attributes

Static Public Attributes

Static Protected Attributes