xscale.Window.set

Window.set(n=None, dim=None, cutoff=None, dx=None, window='boxcar', chunks=None)

Set the different properties of the current window.

Parameters:
n : int, sequence or dict, optional

Window order over dimensions specified through an integer coupled with the dim parameter. A dictionnary can also be used to specify the order.

dim : str or sequence, optional

Names of the dimensions associated with the window.

cutoff : float, sequence or dict, optional

The window cutoff over the dimensions specified through a dictionnary or coupled with the dim parameter. If None, the cutoff is not used to desgin the filter.

dx : float, sequence or dict, optional

Define the resolution of the dimensions. If None, the resolution is directly infered from the coordinates associated to the dimensions.

trim : bool, optional

If True, choose to only keep the valid data not affected by the boundaries.

window : string, tupple, or string and parameters values, or dict, optional

Window to use, see scipy.signal.get_window() for a list of windows and required parameters

chunks : int, tuple or dict, optional

Chunk sizes along each dimension, e.g., 5, (5, 5) or {'x': 5, 'y': 5}