lsst.meas.base.forcedPhotCcd Namespace Reference

Classes
class	PerTractCcdDataIdContainer
class	ForcedPhotCcdConnections
class	for
class	documentation
class	ForcedPhotCcd

Functions
def	imageOverlapsTract (tract, imageWcs, imageBox)

Variables
	applyMosaicResults = None
	footprintSource

Function Documentation

imageOverlapsTract()

def lsst.meas.base.forcedPhotCcd.imageOverlapsTract	(		tract,
			imageWcs,
			imageBox
	)

Return whether the given bounding box overlaps the tract given a WCS.

Parameters
----------
tract : `lsst.skymap.TractInfo`
    TractInfo specifying a tract.
imageWcs : `lsst.afw.geom.SkyWcs`
    World coordinate system for the image.
imageBox : `lsst.geom.Box2I`
    Bounding box for the image.

Returns
-------
overlap : `bool`
    `True` if the bounding box overlaps the tract; `False` otherwise.

Definition at line 122 of file forcedPhotCcd.py.

def imageOverlapsTract(tract, imageWcs, imageBox):
    """Return whether the given bounding box overlaps the tract given a WCS.
 
    Parameters
    ----------
    tract : `lsst.skymap.TractInfo`
        TractInfo specifying a tract.
    imageWcs : `lsst.afw.geom.SkyWcs`
        World coordinate system for the image.
    imageBox : `lsst.geom.Box2I`
        Bounding box for the image.
 
    Returns
    -------
    overlap : `bool`
        `True` if the bounding box overlaps the tract; `False` otherwise.
    """
    tractPoly = tract.getOuterSkyPolygon()
 
    imagePixelCorners = lsst.geom.Box2D(imageBox).getCorners()
    try:
        imageSkyCorners = imageWcs.pixelToSky(imagePixelCorners)
    except lsst.pex.exceptions.LsstCppException as e:
        # Protecting ourselves from awful Wcs solutions in input images
        if (not isinstance(e.message, lsst.pex.exceptions.DomainErrorException)
                and not isinstance(e.message, lsst.pex.exceptions.RuntimeErrorException)):
            raise
        return False
 
    imagePoly = lsst.sphgeom.ConvexPolygon.convexHull([coord.getVector() for coord in imageSkyCorners])
    return tractPoly.intersects(imagePoly)  # "intersects" also covers "contains" or "is contained by"
 
 

Variable Documentation

applyMosaicResults

lsst.meas.base.forcedPhotCcd.applyMosaicResults = None

Definition at line 52 of file forcedPhotCcd.py.

footprintSource

lsst.meas.base.forcedPhotCcd.footprintSource

Definition at line 289 of file forcedPhotCcd.py.