lsst.pipe.tasks.diffractionSpikeMask Namespace Reference

Classes
class	DiffractionSpikeMaskConfig
class	DiffractionSpikeMaskTask

Functions
	getRegion (exposure, margin=None)
	boxSeparation (bbox, x, y)

Function Documentation

boxSeparation()

lsst.pipe.tasks.diffractionSpikeMask.boxSeparation	(		bbox,
			x,
			y )

Return the minimum horizontal or vertical distance from a point to the
outside edge of a bounding box.

Parameters
----------
bbox : `lsst.geom.Box2I`
    The bounding box to check.
x, y : `float`
    Coordinates of the point.

Returns
-------
distance : `float`
    The distance in pixels by which the point is outside the box, or 0 if
    it is inside.

Definition at line 468 of file diffractionSpikeMask.py.

getRegion()

lsst.pipe.tasks.diffractionSpikeMask.getRegion	(		exposure,
			margin = None )

Calculate an enveloping region for an exposure.

Parameters
----------
exposure : `lsst.afw.image.Exposure`
    Exposure object with calibrated WCS.
margin : `lsst.sphgeom.Angle`, optional
    Grow the surrounding region of the exposure by this amount, in order to
    mask the diffraction spikes of stars off the image.

Returns
-------
region : `lsst.sphgeom.Region`
    Region enveloping an exposure.

Definition at line 433 of file diffractionSpikeMask.py.