Estimate cross-spectral density from an array using a multitaper method. Parameters ---------- X : array-like, shape (n_epochs, n_channels, n_times) The time series data consisting of n_epochs separate observations of signals with n_channels time-series of length n_times
(
X,
sfreq,
t0=0,
fmin=0,
fmax=np.inf,
tmin=None,
tmax=None,
ch_names=None,
n_fft=None,
bandwidth=None,
adaptive=False,
low_bias=True,
projs=None,
n_jobs=None,
max_iter=250,
*,
verbose=None,
)
| 918 | |
| 919 | @verbose |
| 920 | def csd_array_multitaper( |
| 921 | X, |
| 922 | sfreq, |
| 923 | t0=0, |
| 924 | fmin=0, |
| 925 | fmax=np.inf, |
| 926 | tmin=None, |
| 927 | tmax=None, |
| 928 | ch_names=None, |
| 929 | n_fft=None, |
| 930 | bandwidth=None, |
| 931 | adaptive=False, |
| 932 | low_bias=True, |
| 933 | projs=None, |
| 934 | n_jobs=None, |
| 935 | max_iter=250, |
| 936 | *, |
| 937 | verbose=None, |
| 938 | ): |
| 939 | """Estimate cross-spectral density from an array using a multitaper method. |
| 940 | |
| 941 | Parameters |
| 942 | ---------- |
| 943 | X : array-like, shape (n_epochs, n_channels, n_times) |
| 944 | The time series data consisting of n_epochs separate observations |
| 945 | of signals with n_channels time-series of length n_times. |
| 946 | sfreq : float |
| 947 | Sampling frequency of observations. |
| 948 | t0 : float |
| 949 | Time of the first sample relative to the onset of the epoch, in |
| 950 | seconds. Defaults to 0. |
| 951 | fmin : float |
| 952 | Minimum frequency of interest, in Hertz. |
| 953 | fmax : float | np.inf |
| 954 | Maximum frequency of interest, in Hertz. |
| 955 | tmin : float | None |
| 956 | Minimum time instant to consider, in seconds. If ``None`` start at |
| 957 | first sample. |
| 958 | tmax : float | None |
| 959 | Maximum time instant to consider, in seconds. If ``None`` end at last |
| 960 | sample. |
| 961 | ch_names : list of str | None |
| 962 | A name for each time series. If ``None`` (the default), the series will |
| 963 | be named 'SERIES###'. |
| 964 | n_fft : int | None |
| 965 | Length of the FFT. If ``None``, the exact number of samples between |
| 966 | ``tmin`` and ``tmax`` will be used. |
| 967 | bandwidth : float | None |
| 968 | The bandwidth of the multitaper windowing function in Hz. |
| 969 | adaptive : bool |
| 970 | Use adaptive weights to combine the tapered spectra into PSD. |
| 971 | low_bias : bool |
| 972 | Only use tapers with more than 90%% spectral concentration within |
| 973 | bandwidth. |
| 974 | projs : list of Projection | None |
| 975 | List of projectors to store in the CSD object. Defaults to ``None``, |
| 976 | which means no projectors are stored. |
| 977 | %(n_jobs)s |