cubed.map_overlap

Contents

cubed.map_overlap#

cubed.map_overlap(func, *args, dtype=None, chunks=None, depth=None, boundary=None, trim=False, **kwargs)#

Apply a function to corresponding blocks from multiple input arrays with some overlap.

Parameters:

  • func (callable) – Function to apply to every block (with overlap) to produce the output array.

  • args (arrays) – The Cubed arrays to map over. Note that currently only one array may be specified.

  • dtype (np.dtype) – The dtype of the output array.

  • chunks (tuple) – Chunk shape of blocks in the output array.

  • depth (int, tuple, dict or list) – The number of elements that each block should share with its neighbors.

  • boundary (value type, tuple, dict or list) – How to handle the boundaries. Note that this currently only supports constant values.

  • trim (bool) – Whether or not to trim depth elements from each block after calling the map function. Currently only False is supported.

  • **kwargs (dict) – Extra keyword arguments to pass to function.

Contents