lsst.scarlet.lite.bbox Namespace Reference

Classes
class	Box

Functions
tuple[tuple[slice,...], tuple[slice,...]]	overlapped_slices (Box bbox1, Box bbox2)

Function Documentation

overlapped_slices()

tuple[tuple[slice, ...], tuple[slice, ...]] lsst.scarlet.lite.bbox.overlapped_slices	(	Box	bbox1,
		Box	bbox2 )

Slices of bbox1 and bbox2 that overlap

Parameters
----------
bbox1:
    The first box.
bbox2:
    The second box.

Returns
-------
slices: tuple[Sequence[slice], Sequence[slice]]
    The slice of an array bounded by `bbox1` and
    the slice of an array bounded by `bbox2` in the
    overlapping region.

Definition at line 486 of file bbox.py.

def overlapped_slices(bbox1: Box, bbox2: Box) -> tuple[tuple[slice, ...], tuple[slice, ...]]:
    """Slices of bbox1 and bbox2 that overlap
 
    Parameters
    ----------
    bbox1:
        The first box.
    bbox2:
        The second box.
 
    Returns
    -------
    slices: tuple[Sequence[slice], Sequence[slice]]
        The slice of an array bounded by `bbox1` and
        the slice of an array bounded by `bbox2` in the
        overlapping region.
    """
    overlap = bbox1 & bbox2
    if np.all(np.array(overlap.shape) == 0):
        # There was no overlap, so return empty slices
        return (slice(0, 0),) * len(overlap.shape), (slice(0, 0),) * len(overlap.shape)
    _bbox1 = overlap - bbox1.origin
    _bbox2 = overlap - bbox2.origin
    slices = (
        _bbox1.slices,
        _bbox2.slices,
    )
    return slices