xoa.filter.shapiro_kernel

xoa.filter.shapiro_kernel(dims)[source]

Generate a shapiro kernel

Parameters:: dims (str, tuple) – Dimension names
Returns:: xarray.DataArray – The kernel as a data array with provided dims and a shape of (3,)*len(dims)

Example

In [1]: shapiro_kernel('nx')
Out[1]: 
<xarray.DataArray (nx: 3)>
array([0., 1., 0.])
Dimensions without coordinates: nx

In [2]: shapiro_kernel(('ny', 'nx'))
Out[2]: 
<xarray.DataArray (ny: 3, nx: 3)>
array([[0., 1., 0.],
       [1., 2., 1.],
       [0., 1., 0.]])
Dimensions without coordinates: ny, nx

In [3]: shapiro_kernel(('nt', 'ny', 'nx'))
Out[3]: 
<xarray.DataArray (nt: 3, ny: 3, nx: 3)>
array([[[0., 1., 0.],
        [1., 2., 1.],
        [0., 1., 0.]],

       [[1., 2., 1.],
        [2., 3., 2.],
        [1., 2., 1.]],

       [[0., 1., 0.],
        [1., 2., 1.],
        [0., 1., 0.]]])
Dimensions without coordinates: nt, ny, nx