pymodalib.implementations.python.coherence.group_coherence module

exception CoherenceException

Bases: Exception

dual_group_coherence_impl(group1_signals1: numpy.ndarray, group1_signals2: numpy.ndarray, group2_signals1: numpy.ndarray, group2_signals2: numpy.ndarray, fs: float, percentile: float = 95, *wavelet_args, **wavelet_kwargs) → Tuple[numpy.ndarray, numpy.ndarray, numpy.ndarray]

For docstrings, please see the wrapper functions in ‘pymodalib.algorithms’.

group_coherence_impl(signals_a: numpy.ndarray, signals_b: numpy.ndarray, fs: float, cleanup: bool = True, percentile: float = 95, *wavelet_args, **wavelet_kwargs) → Tuple[numpy.ndarray, numpy.ndarray]

For docstrings, please see the wrapper functions in ‘pymodalib.algorithms’.

wrapper_pass_function(func: Callable) → Any

Wrapper which allows a Pool’s ‘starmap’ to be called with a function that takes no parameters.

This is used to pass *args and **kwargs to a function, by creating a partial function with functools.partial which is provided with all required arguments including the *args and **kwargs.

The partial function is then passed an an argument to this function in starmap.

Parameters:func (Callable) – The partial function to run, which takes no parameters. Returns:The return values from the partial function. Return type:Any

wt(signal: numpy.ndarray, fs: float, *args, **kwargs) → Tuple[numpy.ndarray, numpy.ndarray]

Wrapper for the wavelet transform.