lsst.afw.geom._spanSetContinued.SpanSet Class Reference

Public Member Functions
	asArray (self, shape=None, xy0=None)

Detailed Description

Definition at line 28 of file _spanSetContinued.py.

Member Function Documentation

asArray()

lsst.afw.geom._spanSetContinued.SpanSet.asArray	(		self,
			shape = None,
			xy0 = None )

Convert a SpanSet into a numpy boolean array

Parameters
----------
shape : `tuple` of `int`
    The final shape of the output array.
    If `shape` is `None` then the extent of the bounding box is used.
xy0 : `~lsst.geom.Box2I` or `tuple` of `int`
    The lower-left corner of the array that will contain the spans.
    If `xy0` is `None` then the origin of the bounding box is used.

Returns
-------
result : `numpy.ndarray`
    The array with pixels contained in `spans` marked as `True`.

Definition at line 29 of file _spanSetContinued.py.

    def asArray(self, shape=None, xy0=None):
        """Convert a SpanSet into a numpy boolean array
 
        Parameters
        ----------
        shape : `tuple` of `int`
            The final shape of the output array.
            If `shape` is `None` then the extent of the bounding box is used.
        xy0 : `~lsst.geom.Box2I` or `tuple` of `int`
            The lower-left corner of the array that will contain the spans.
            If `xy0` is `None` then the origin of the bounding box is used.
 
        Returns
        -------
        result : `numpy.ndarray`
            The array with pixels contained in `spans` marked as `True`.
        """
        # prevent circular import
        from lsst.afw.image import Mask
 
        if shape is None and xy0 is None:
            # It's slightly faster to set the array with the Mask instead of
            # shifting the spans.
            bbox = self.getBBox()
            mask = Mask(bbox)
            self.setMask(mask, 1)
            result = mask.getArray().astype(bool)
        else:
            if shape is None:
                # Use the shape of the full SpanSet
                extent = self.getBBox().getDimensions()
                shape = extent[1], extent[0]
 
            if xy0 is None:
                xy0 = self.getBBox().getMin()
            offset = (-xy0[0], -xy0[1])
 
            result = np.zeros(shape, dtype=bool)
            yidx, xidx = self.shiftedBy(*offset).indices()
            result[yidx, xidx] = 1
        return result

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/python/lsst/afw/geom/_spanSetContinued.py