LSSTApplications  20.0.0
LSSTDataManagementBasePackage
Classes | Functions | Variables
lsst.meas.base.forcedPhotCcd Namespace Reference

Classes

class  ForcedPhotCcdConnections
 
class  PerTractCcdDataIdContainer
 

Functions

def imageOverlapsTract (tract, imageWcs, imageBox)
 

Variables

 applyMosaicResults = None
 

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 110 of file forcedPhotCcd.py.

110 def imageOverlapsTract(tract, imageWcs, imageBox):
111  """Return whether the given bounding box overlaps the tract given a WCS.
112 
113  Parameters
114  ----------
115  tract : `lsst.skymap.TractInfo`
116  TractInfo specifying a tract.
117  imageWcs : `lsst.afw.geom.SkyWcs`
118  World coordinate system for the image.
119  imageBox : `lsst.geom.Box2I`
120  Bounding box for the image.
121 
122  Returns
123  -------
124  overlap : `bool`
125  `True` if the bounding box overlaps the tract; `False` otherwise.
126  """
127  tractPoly = tract.getOuterSkyPolygon()
128 
129  imagePixelCorners = lsst.geom.Box2D(imageBox).getCorners()
130  try:
131  imageSkyCorners = imageWcs.pixelToSky(imagePixelCorners)
132  except lsst.pex.exceptions.LsstCppException as e:
133  # Protecting ourselves from awful Wcs solutions in input images
134  if (not isinstance(e.message, lsst.pex.exceptions.DomainErrorException)
135  and not isinstance(e.message, lsst.pex.exceptions.RuntimeErrorException)):
136  raise
137  return False
138 
139  imagePoly = lsst.sphgeom.ConvexPolygon.convexHull([coord.getVector() for coord in imageSkyCorners])
140  return tractPoly.intersects(imagePoly) # "intersects" also covers "contains" or "is contained by"
141 
142 

Variable Documentation

◆ applyMosaicResults

lsst.meas.base.forcedPhotCcd.applyMosaicResults = None

Definition at line 41 of file forcedPhotCcd.py.

lsst::meas::base.forcedPhotCcd.imageOverlapsTract
def imageOverlapsTract(tract, imageWcs, imageBox)
Definition: forcedPhotCcd.py:110
lsst::geom::Box2D
A floating-point coordinate rectangle geometry.
Definition: Box.h:413
lsst::sphgeom::ConvexPolygon::convexHull
static ConvexPolygon convexHull(std::vector< UnitVector3d > const &points)
convexHull returns the convex hull of the given set of points if it exists and throws an exception ot...
Definition: ConvexPolygon.h:65