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

Public Member Functions
def	run (self, coordList)

def	runDataRef (self, dataRef, coordList, makeDataRefList=True, selectDataList=[])

Static Public Attributes
	ConfigClass = pexConfig.Config

Detailed Description

Base task for selecting images suitable for coaddition

Definition at line 73 of file selectImages.py.

Member Function Documentation

◆ run()

def lsst.pipe.tasks.selectImages.BaseSelectImagesTask.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)

Definition at line 80 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.BaseSelectImagesTask.runDataRef	(	self,
		dataRef,
		coordList,
		makeDataRefList = `True`,
		selectDataList = `[]`
	)

Run based on a data reference

This delegates to run() and _runArgDictFromDataId() to do the actual
selection. In the event that the selectDataList is non-empty, this will
be used to further restrict the selection, providing the user with
additional control over the selection.

@param[in] dataRef: data reference; must contain any extra keys needed by the subclass
@param[in] coordList: list of coordinates defining region of interest; if None, search the whole sky
@param[in] makeDataRefList: if True, return dataRefList
@param[in] selectDataList: List of SelectStruct with dataRefs to consider for selection
@return a pipeBase Struct containing:
- exposureInfoList: a list of objects derived from ExposureInfo
- dataRefList: a list of data references (None if makeDataRefList False)

Reimplemented in lsst.pipe.drivers.utils.NullSelectImagesTask, and lsst.pipe.tasks.selectImages.WcsSelectImagesTask.

Definition at line 101 of file selectImages.py.

     def runDataRef(self, dataRef, coordList, makeDataRefList=True, selectDataList=[]):
         """Run based on a data reference
  
         This delegates to run() and _runArgDictFromDataId() to do the actual
         selection. In the event that the selectDataList is non-empty, this will
         be used to further restrict the selection, providing the user with
         additional control over the selection.
  
         @param[in] dataRef: data reference; must contain any extra keys needed by the subclass
         @param[in] coordList: list of coordinates defining region of interest; if None, search the whole sky
         @param[in] makeDataRefList: if True, return dataRefList
         @param[in] selectDataList: List of SelectStruct with dataRefs to consider for selection
         @return a pipeBase Struct containing:
         - exposureInfoList: a list of objects derived from ExposureInfo
         - dataRefList: a list of data references (None if makeDataRefList False)
         """
         runArgDict = self._runArgDictFromDataId(dataRef.dataId)
         exposureInfoList = self.run(coordList, **runArgDict).exposureInfoList
  
         if len(selectDataList) > 0 and len(exposureInfoList) > 0:
             # Restrict the exposure selection further
             ccdKeys, ccdValues = _extractKeyValue(exposureInfoList)
             inKeys, inValues = _extractKeyValue([s.dataRef for s in selectDataList], keys=ccdKeys)
             inValues = set(inValues)
             newExposureInfoList = []
             for info, ccdVal in zip(exposureInfoList, ccdValues):
                 if ccdVal in inValues:
                     newExposureInfoList.append(info)
                 else:
                     self.log.info("De-selecting exposure %s: not in selectDataList", info.dataId)
             exposureInfoList = newExposureInfoList
  
         if makeDataRefList:
             butler = dataRef.butlerSubset.butler
             dataRefList = [butler.dataRef(datasetType="calexp",
                                           dataId=expInfo.dataId,
                                           ) for expInfo in exposureInfoList]
         else:
             dataRefList = None
  
         return pipeBase.Struct(
             dataRefList=dataRefList,
             exposureInfoList=exposureInfoList,
         )
  
  

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.selectImages.BaseSelectImagesTask.ConfigClass = pexConfig.Config

static

Definition at line 76 of file selectImages.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-147-g0e635eb1+1acddb5be5/python/lsst/pipe/tasks/selectImages.py