Inheritance diagram for lsst.pipe.tasks.selectImages.BestSeeingWcsSelectImagesTask:

Public Member Functions
def	runDataRef (self, dataRef, coordList, makeDataRefList=True, selectDataList=None)

def	run (self, coordList)

Static Public Attributes
	ConfigClass = BestSeeingWcsSelectImageConfig

Detailed Description

Select up to a maximum number of the best-seeing images using their Wcs.

Definition at line 363 of file selectImages.py.

Member Function Documentation

◆ run()

def lsst.pipe.tasks.selectImages.BaseSelectImagesTask.run	(	self,
		coordList
	)

inherited

Select images suitable for coaddition in a particular region

@param[in] coordList: list of coordinates defining region of interest; if None then select all images
subclasses may add additional keyword arguments, as required

@return a pipeBase Struct containing:
- exposureInfoList: a list of exposure information objects (subclasses of BaseExposureInfo),
    which have at least the following fields:
    - dataId: data ID dictionary
    - coordList: ICRS coordinates of the corners of the exposure (list of lsst.geom.SpherePoint)

Definition at line 76 of file selectImages.py.

     def run(self, coordList):
         """Select images suitable for coaddition in a particular region
  
         @param[in] coordList: list of coordinates defining region of interest; if None then select all images
         subclasses may add additional keyword arguments, as required
  
         @return a pipeBase Struct containing:
         - exposureInfoList: a list of exposure information objects (subclasses of BaseExposureInfo),
             which have at least the following fields:
             - dataId: data ID dictionary
             - coordList: ICRS coordinates of the corners of the exposure (list of lsst.geom.SpherePoint)
         """
         raise NotImplementedError()
  

◆ runDataRef()

def lsst.pipe.tasks.selectImages.BestSeeingWcsSelectImagesTask.runDataRef	(	self,
		dataRef,
		coordList,
		makeDataRefList = `True`,
		selectDataList = `None`
	)

Select the best-seeing images in the selectDataList that overlap the patch.

Parameters
----------
dataRef : `lsst.daf.persistence.ButlerDataRef`
    Data reference for coadd/tempExp (with tract, patch)
coordList : `list` of `lsst.geom.SpherePoint`
    List of ICRS sky coordinates specifying boundary of patch
makeDataRefList : `boolean`, optional
    Construct a list of data references?
selectDataList : `list` of `SelectStruct`
    List of SelectStruct, to consider for selection

Returns
-------
result : `lsst.pipe.base.Struct`
    Result struct with components:
    - ``exposureList``: the selected exposures
        (`list` of `lsst.pipe.tasks.selectImages.BaseExposureInfo`).
    - ``dataRefList``: the optional data references corresponding to
        each element of ``exposureList``
        (`list` of `lsst.daf.persistence.ButlerDataRef`, or `None`).

Reimplemented from lsst.pipe.tasks.selectImages.WcsSelectImagesTask.

Definition at line 368 of file selectImages.py.

                    selectDataList=None):
         """Select the best-seeing images in the selectDataList that overlap the patch.
  
         Parameters
         ----------
         dataRef : `lsst.daf.persistence.ButlerDataRef`
             Data reference for coadd/tempExp (with tract, patch)
         coordList : `list` of `lsst.geom.SpherePoint`
             List of ICRS sky coordinates specifying boundary of patch
         makeDataRefList : `boolean`, optional
             Construct a list of data references?
         selectDataList : `list` of `SelectStruct`
             List of SelectStruct, to consider for selection
  
         Returns
         -------
         result : `lsst.pipe.base.Struct`
             Result struct with components:
             - ``exposureList``: the selected exposures
                 (`list` of `lsst.pipe.tasks.selectImages.BaseExposureInfo`).
             - ``dataRefList``: the optional data references corresponding to
                 each element of ``exposureList``
                 (`list` of `lsst.daf.persistence.ButlerDataRef`, or `None`).
         """
         if self.config.nImagesMax <= 0:
             raise RuntimeError(f"nImagesMax must be greater than zero: {self.config.nImagesMax}")
  
         psfSizes = []
         dataRefList = []
         exposureInfoList = []
  
         if selectDataList is None:
             selectDataList = []
  
         result = super().runDataRef(dataRef, coordList, makeDataRefList=True, selectDataList=selectDataList)
  
         for dataRef, exposureInfo in zip(result.dataRefList, result.exposureInfoList):
             cal = dataRef.get("calexp", immediate=True)
  
             # if min/max PSF values are defined, remove images out of bounds
             pixToArcseconds = cal.getWcs().getPixelScale().asArcseconds()
             psfSize = cal.getPsf().computeShape().getDeterminantRadius()*pixToArcseconds
             sizeFwhm = psfSize * np.sqrt(8.*np.log(2.))
             if self.config.maxPsfFwhm and sizeFwhm > self.config.maxPsfFwhm:
                 continue
             if self.config.minPsfFwhm and sizeFwhm < self.config.minPsfFwhm:
                 continue
             psfSizes.append(psfSize)
             dataRefList.append(dataRef)
             exposureInfoList.append(exposureInfo)
  
         if len(psfSizes) > self.config.nImagesMax:
             sortedIndices = np.argsort(psfSizes)[:self.config.nImagesMax]
             filteredDataRefList = [dataRefList[i] for i in sortedIndices]
             filteredExposureInfoList = [exposureInfoList[i] for i in sortedIndices]
             self.log.info(f"{len(sortedIndices)} images selected with FWHM "
                           f"range of {psfSizes[sortedIndices[0]]}--{psfSizes[sortedIndices[-1]]} arcseconds")
  
         else:
             if len(psfSizes) == 0:
                 self.log.warn("0 images selected.")
             else:
                 self.log.debug(f"{len(psfSizes)} images selected with FWHM range "
                                f"of {psfSizes[0]}--{psfSizes[-1]} arcseconds")
             filteredDataRefList = dataRefList
             filteredExposureInfoList = exposureInfoList
  
         return pipeBase.Struct(
             dataRefList=filteredDataRefList if makeDataRefList else None,
             exposureInfoList=filteredExposureInfoList,
         )

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.selectImages.BestSeeingWcsSelectImagesTask.ConfigClass = BestSeeingWcsSelectImageConfig

static

Definition at line 366 of file selectImages.py.

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

/j/snowflake/release/lsstsw/stack/0.4.1/Linux64/pipe_tasks/21.0.0-43-g9a3faf29+c9d24e8573/python/lsst/pipe/tasks/selectImages.py