lsst.pipe.tasks.extended_psf.MeasureExtendedPsfTask Class Reference

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

Public Member Functions
def	__init__ (self, initInputs=None, *args, **kwargs)
def	select_detector_refs (self, ref_list)
def	runQuantum (self, butlerQC, inputRefs, outputRefs)

Public Attributes
	focal_plane_regions
	regionless_dets

Static Public Attributes
	ConfigClass = MeasureExtendedPsfConfig

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 using
all available data.

Definition at line 423 of file extended_psf.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 437 of file extended_psf.py.

    def __init__(self, initInputs=None, *args, **kwargs):
        pipeBase.CmdLineTask.__init__(self, *args, **kwargs)
        self.makeSubtask("stack_bright_stars")
        self.focal_plane_regions = {region: [] for region in
                                    set(self.config.detectors_focal_plane_regions.values())}
        for det, region in self.config.detectors_focal_plane_regions.items():
            self.focal_plane_regions[region].append(det)
        # make no assumption on what detector IDs should be, but if we come
        # across one where there are processed bright stars, but no
        # corresponding focal plane region, make sure we keep track of
        # it (eg to raise a warning only once)
        self.regionless_dets = []
 

Member Function Documentation

runQuantum()

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

Definition at line 476 of file extended_psf.py.

    def runQuantum(self, butlerQC, inputRefs, outputRefs):
        input_data = butlerQC.get(inputRefs)
        bss_ref_list = input_data['input_brightStarStamps']
        # Handle default case of a single region with empty detector list
        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.")
            output_e_psf = ExtendedPsf(self.stack_bright_stars.run(bss_ref_list))
        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
                ext_psf = self.stack_bright_stars.run(ref_list, region_name)
                output_e_psf.add_regional_extended_psf(ext_psf, region_name,
                                                       self.focal_plane_regions[region_name])
        output = pipeBase.Struct(extended_psf=output_e_psf)
        butlerQC.put(output, outputRefs)

select_detector_refs()

def 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 450 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.focal_plane_regions.keys()}
        for dataset_handle in ref_list:
            det_id = dataset_handle.ref.dataId["detector"]
            if det_id in self.regionless_dets:
                continue
            try:
                region_name = self.config.detectors_focal_plane_regions[det_id]
            except KeyError:
                self.log.warning('Bright stars were available for detector %d, but it was missing '
                                 'from the "detectors_focal_plane_regions" config field, so they will not '
                                 'be used to build any of the extended PSF models', det_id)
                self.regionless_dets.append(det_id)
                continue
            region_ref_list[region_name].append(dataset_handle)
        return region_ref_list
 

Member Data Documentation

ConfigClass

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

static

Definition at line 434 of file extended_psf.py.

focal_plane_regions

lsst.pipe.tasks.extended_psf.MeasureExtendedPsfTask.focal_plane_regions

Definition at line 440 of file extended_psf.py.

regionless_dets

lsst.pipe.tasks.extended_psf.MeasureExtendedPsfTask.regionless_dets

Definition at line 448 of file extended_psf.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/pipe_tasks/21.0.0-172-gfb10e10a+18fedfabac/python/lsst/pipe/tasks/extended_psf.py