lsst.pipe.tasks.selectImages.WcsSelectImagesTask Class Reference

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

Public Member Functions
def	runDataRef (self, dataRef, coordList, makeDataRefList=True, selectDataList=[])
def	run (self, wcsList, bboxList, coordList, dataIds=None, **kwargs)
def	getValidImageCorners (self, imageWcs, imageBox, patchPoly, dataId=None)
def	run (self, coordList)

Static Public Attributes
	ConfigClass = pexConfig.Config

Detailed Description

Select images using their Wcs

    We use the "convexHull" method of lsst.sphgeom.ConvexPolygon to define
    polygons on the celestial sphere, and test the polygon of the
    patch for overlap with the polygon of the image.

    We use "convexHull" instead of generating a ConvexPolygon
    directly because the standard for the inputs to ConvexPolygon
    are pretty high and we don't want to be responsible for reaching them.

Definition at line 173 of file selectImages.py.

Member Function Documentation

getValidImageCorners()

def lsst.pipe.tasks.selectImages.WcsSelectImagesTask.getValidImageCorners	(		self,
			imageWcs,
			imageBox,
			patchPoly,
			dataId = None
	)

Definition at line 245 of file selectImages.py.

    def getValidImageCorners(self, imageWcs, imageBox, patchPoly, dataId=None):
        "Return corners or None if bad"
        try:
            imageCorners = [imageWcs.pixelToSky(pix) for pix in geom.Box2D(imageBox).getCorners()]
        except (pexExceptions.DomainError, pexExceptions.RuntimeError) as e:
            # Protecting ourselves from awful Wcs solutions in input images
            self.log.debug("WCS error in testing calexp %s (%s): deselecting", dataId, e)
            return
 
        imagePoly = lsst.sphgeom.ConvexPolygon.convexHull([coord.getVector() for coord in imageCorners])
        if imagePoly is None:
            self.log.debug("Unable to create polygon from image %s: deselecting", dataId)
            return
 
        if patchPoly.intersects(imagePoly):
            # "intersects" also covers "contains" or "is contained by"
            self.log.info("Selecting calexp %s" % dataId)
            return imageCorners
 
 

run() [1/2]

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 79 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()
 

run() [2/2]

def lsst.pipe.tasks.selectImages.WcsSelectImagesTask.run	(		self,
			wcsList,
			bboxList,
			coordList,
			dataIds = None,
		**	kwargs
	)

Return indices of provided lists that meet the selection criteria

Parameters:
-----------
wcsList : `list` of `lsst.afw.geom.SkyWcs`
    specifying the WCS's of the input ccds to be selected
bboxList : `list` of `lsst.geom.Box2I`
    specifying the bounding boxes of the input ccds to be selected
coordList : `list` of `lsst.geom.SpherePoint`
    ICRS coordinates specifying boundary of the patch.

Returns:
--------
result: `list` of `int`
    of indices of selected ccds

Definition at line 217 of file selectImages.py.

    def run(self, wcsList, bboxList, coordList, dataIds=None, **kwargs):
        """Return indices of provided lists that meet the selection criteria
 
        Parameters:
        -----------
        wcsList : `list` of `lsst.afw.geom.SkyWcs`
            specifying the WCS's of the input ccds to be selected
        bboxList : `list` of `lsst.geom.Box2I`
            specifying the bounding boxes of the input ccds to be selected
        coordList : `list` of `lsst.geom.SpherePoint`
            ICRS coordinates specifying boundary of the patch.
 
        Returns:
        --------
        result: `list` of `int`
            of indices of selected ccds
        """
        if dataIds is None:
            dataIds = [None] * len(wcsList)
        patchVertices = [coord.getVector() for coord in coordList]
        patchPoly = lsst.sphgeom.ConvexPolygon.convexHull(patchVertices)
        result = []
        for i, (imageWcs, imageBox, dataId) in enumerate(zip(wcsList, bboxList, dataIds)):
            imageCorners = self.getValidImageCorners(imageWcs, imageBox, patchPoly, dataId)
            if imageCorners:
                result.append(i)
        return result
 

runDataRef()

def lsst.pipe.tasks.selectImages.WcsSelectImagesTask.runDataRef	(		self,
			dataRef,
			coordList,
			makeDataRefList = True,
			selectDataList = []
	)

Select images in the selectDataList that overlap the patch

This method is the old entry point for the Gen2 commandline tasks and drivers
Will be deprecated in v22.

@param dataRef: Data reference for coadd/tempExp (with tract, patch)
@param coordList: List of ICRS coordinates (lsst.geom.SpherePoint) specifying boundary of patch
@param makeDataRefList: Construct a list of data references?
@param selectDataList: List of SelectStruct, to consider for selection

Reimplemented from lsst.pipe.tasks.selectImages.BaseSelectImagesTask.

Definition at line 185 of file selectImages.py.

    def runDataRef(self, dataRef, coordList, makeDataRefList=True, selectDataList=[]):
        """Select images in the selectDataList that overlap the patch
 
        This method is the old entry point for the Gen2 commandline tasks and drivers
        Will be deprecated in v22.
 
        @param dataRef: Data reference for coadd/tempExp (with tract, patch)
        @param coordList: List of ICRS coordinates (lsst.geom.SpherePoint) specifying boundary of patch
        @param makeDataRefList: Construct a list of data references?
        @param selectDataList: List of SelectStruct, to consider for selection
        """
        dataRefList = []
        exposureInfoList = []
 
        patchVertices = [coord.getVector() for coord in coordList]
        patchPoly = lsst.sphgeom.ConvexPolygon.convexHull(patchVertices)
 
        for data in selectDataList:
            dataRef = data.dataRef
            imageWcs = data.wcs
            imageBox = data.bbox
 
            imageCorners = self.getValidImageCorners(imageWcs, imageBox, patchPoly, dataId=None)
            if imageCorners:
                dataRefList.append(dataRef)
                exposureInfoList.append(BaseExposureInfo(dataRef.dataId, imageCorners))
 
        return pipeBase.Struct(
            dataRefList=dataRefList if makeDataRefList else None,
            exposureInfoList=exposureInfoList,
        )
 

Member Data Documentation

ConfigClass

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

staticinherited

Definition at line 75 of file selectImages.py.

---

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

• /j/snowflake/release/lsstsw/stack/0.4.3/Linux64/pipe_tasks/21.0.0-64-g1122c245+4fb2b8f86e/python/lsst/pipe/tasks/selectImages.py