k-Wave Data Filters

class kwave_data_filters.InterpDataFilter

Helper class for interpolating N-dimensional arrays.

static staggered(data, offset)

Use linear interpolation to interpolate N-dimensional data to a grid shifted by “offset”.

Parameters
  • data – Input N-dimensional array of data.

  • offset – Offset of the target grid (where abs(“offset”) <= 1 must hold for each dimension).

Returns

Returns data interpolated to the offset grid. Off-grid values are copied from original data.

class kwave_data_filters.SpectralDataFilter

Helper class for application of spectral filters such as smoothing.

static smooth(data, window_name='blackman')

Smooth data using filter implemented in fourier-coefficient space using selected windowing function to attenuate high-frequency components.

Parameters
  • data – Input N-dimensional array of data.

  • window_name – Name of the windowing function to be used (only “blackman” window supported).

Returns

Smoothed data.