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 74 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)

Reimplemented in lsst.pipe.tasks.selectImages.WcsSelectImagesTask.

Definition at line 81 of file selectImages.py.

◆ 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.tasks.selectImages.WcsSelectImagesTask.

Definition at line 102 of file selectImages.py.

Member Data Documentation

◆ ConfigClass

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

static

Definition at line 77 of file selectImages.py.

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

python/lsst/pipe/tasks/selectImages.py