Share boundaries between neighboring blocks Parameters ---------- x: da.Array A dask array depth: dict The size of the shared boundary per axis boundary: dict The boundary condition on each axis. Options are 'reflect', 'periodic', 'nearest', 'non
(x, depth, boundary, *, allow_rechunk=True)
| 375 | |
| 376 | |
| 377 | def overlap(x, depth, boundary, *, allow_rechunk=True): |
| 378 | """Share boundaries between neighboring blocks |
| 379 | |
| 380 | Parameters |
| 381 | ---------- |
| 382 | |
| 383 | x: da.Array |
| 384 | A dask array |
| 385 | depth: dict |
| 386 | The size of the shared boundary per axis |
| 387 | boundary: dict |
| 388 | The boundary condition on each axis. Options are 'reflect', 'periodic', |
| 389 | 'nearest', 'none', or an array value. Such a value will fill the |
| 390 | boundary with that value. |
| 391 | allow_rechunk: bool, keyword only |
| 392 | Allows rechunking, otherwise chunk sizes need to match and core |
| 393 | dimensions are to consist only of one chunk. |
| 394 | |
| 395 | The depth input informs how many cells to overlap between neighboring |
| 396 | blocks ``{0: 2, 2: 5}`` means share two cells in 0 axis, 5 cells in 2 axis. |
| 397 | Axes missing from this input will not be overlapped. |
| 398 | |
| 399 | Any axis containing chunks smaller than depth will be rechunked if |
| 400 | possible, provided the keyword ``allow_rechunk`` is True (recommended). |
| 401 | |
| 402 | Examples |
| 403 | -------- |
| 404 | >>> import numpy as np |
| 405 | >>> import dask.array as da |
| 406 | |
| 407 | >>> x = np.arange(64).reshape((8, 8)) |
| 408 | >>> d = da.from_array(x, chunks=(4, 4)) |
| 409 | >>> d.chunks |
| 410 | ((4, 4), (4, 4)) |
| 411 | |
| 412 | >>> g = da.overlap.overlap(d, depth={0: 2, 1: 1}, |
| 413 | ... boundary={0: 100, 1: 'reflect'}) |
| 414 | >>> g.chunks |
| 415 | ((8, 8), (6, 6)) |
| 416 | |
| 417 | >>> np.array(g) |
| 418 | array([[100, 100, 100, 100, 100, 100, 100, 100, 100, 100, 100, 100], |
| 419 | [100, 100, 100, 100, 100, 100, 100, 100, 100, 100, 100, 100], |
| 420 | [ 0, 0, 1, 2, 3, 4, 3, 4, 5, 6, 7, 7], |
| 421 | [ 8, 8, 9, 10, 11, 12, 11, 12, 13, 14, 15, 15], |
| 422 | [ 16, 16, 17, 18, 19, 20, 19, 20, 21, 22, 23, 23], |
| 423 | [ 24, 24, 25, 26, 27, 28, 27, 28, 29, 30, 31, 31], |
| 424 | [ 32, 32, 33, 34, 35, 36, 35, 36, 37, 38, 39, 39], |
| 425 | [ 40, 40, 41, 42, 43, 44, 43, 44, 45, 46, 47, 47], |
| 426 | [ 16, 16, 17, 18, 19, 20, 19, 20, 21, 22, 23, 23], |
| 427 | [ 24, 24, 25, 26, 27, 28, 27, 28, 29, 30, 31, 31], |
| 428 | [ 32, 32, 33, 34, 35, 36, 35, 36, 37, 38, 39, 39], |
| 429 | [ 40, 40, 41, 42, 43, 44, 43, 44, 45, 46, 47, 47], |
| 430 | [ 48, 48, 49, 50, 51, 52, 51, 52, 53, 54, 55, 55], |
| 431 | [ 56, 56, 57, 58, 59, 60, 59, 60, 61, 62, 63, 63], |
| 432 | [100, 100, 100, 100, 100, 100, 100, 100, 100, 100, 100, 100], |
| 433 | [100, 100, 100, 100, 100, 100, 100, 100, 100, 100, 100, 100]]) |
| 434 | """ |
no test coverage detected