Multivariate Analysis¶
Introduction¶
Blah.
API¶
-
hsltools.Multivar.Cxyy(x, y, r, s, N) Description of module level function.
- Parameters
x – The first parameter.
y –
r –
s –
N –
- Returns
z
- Return type
placeholder
-
hsltools.Multivar.detrend(signal) Returns detrend of the signal.
- Parameters
signal (array-like) – Array containing numbers whose detrends are desired.
- Returns
Returns detrend values of the signal.
- Return type
ndarray
-
hsltools.Multivar.multivar_all_features(signal1, signal2, name) Returns all of the Multivar features of the two signals in the form of a labeled data frame (xcorr_lagtime, xbicorr).
- Parameters
signal1 (array-like) – Array containing numbers representing the first signal.
signal2 (array-like) – Array containing numbers representing the second signal.
name (string) – Name representing signals desired for data frame.
- Returns
Returns a data frame of all the Multivar features with the column headings [name_xcorr_lag, name_xbicorr]
name_xcorr_lag - see xcorr_lagtime name_xbicorr - see xbicorr
- Return type
DataFrame
-
hsltools.Multivar.normalize(signal) Returns the normalized signal.
- Parameters
signal (array-like) – Array containing numbers whose nomalized values are desired.
- Returns
Returns normalized values of the signal.
- Return type
array-like
-
hsltools.Multivar.resample(signal1, signal2) Returns a resample of the two signals.
- Parameters
signal1 (array-like) – Array containing numbers representing the first signal whose resample is desired.
signal2 (array-like) – Array containing numbers representing the second signal whose resample is desired.
- Returns
Returns signal1 resampled. Returns signal2 resampled.
- Return type
(array-like, array-like)
-
hsltools.Multivar.xbicorr(x, y) Description of module level function.
- Parameters
x – The first parameter.
y –
- Returns
z
- Return type
float
-
hsltools.Multivar.xcorr_lagtime(signal1, signal2, make_plot=False, sig1='', sig2='') Returns xcorr_lagtime.
- Parameters
signal1 (array-like) – The first signal.
signal2 (array-like) – The second signal.
= bool (make_plot) – True if a plot is desired, false otherwise.
sig1 (string) – Name of signal1;
sig2 (string) – Name of signal2;
- Returns
Returns tau
- Return type
ndarray of ints