rcatool.stats.ASoP.asop

rcatool.stats.ASoP.asop(data, keepdims=False, axis=0, bins=None, thr=None, return_bins=False)[source]

Calculate ASoP parameters.

Parameters:

  • data (array) – 2D or 1D array of data. All data points are collectively used in the asop calculation unless ‘keepdims’ is True. Then calculation is performed along zeroth axis (expected time dimension).

  • keepdims (boolean) – If data is 2d (time in third dimesion) and keepdims is set to True, calculation is applied to the dimension defined by axis argument (default 0) and returns a 2d array of asop components. If set to False (default) all values are collectively assembled before calculation.

  • axis (int) – The axis over which to apply the calculation if keepdims is set to True. Default is 0.

  • bins (list/array) – Defines the bin edges, including the rightmost edge, allowing for non-uniform bin widths. If bins is set to ‘None’ they will be automatically calculated using Klingaman bins; function bins_calc in this module.

  • thr (float) – Value of threshold if thresholding data. Default None.

  • return_bins (boolean) – If set to True (default False), bins that have been used in the calculation are returned.

Returns:

  • Cfactor (array) – data array with relative contribution per bin to the total mean.

  • FCfactor (array) – data array with relative contribution per bin independent of the total mean.

  • bins_ret (array) – If return_bins is True, the array of bin edges is returned.