syncopy.plotting._plot_spectral._prep_spectral_plots

syncopy.plotting._plot_spectral._prep_spectral_plots(self, name, **inputArgs)[source]

Local helper that performs sanity checks and sets up data selection

Parameters
Returns

  • dimArrs (tuple) – Four-element tuple containing (in this order): trList, list of (selected) trials to visualize, chArr, 1D numpy.ndarray of channel specifiers based on provided user selection, freqArr, 1D numpy.ndarray of frequency specifiers based on provided user selection, tpArr, 1D numpy.ndarray of taper specifiers based on provided user selection. Note that “all” and None selections are converted to arrays ready for indexing.

  • dimCounts (tuple) – Four-element tuple holding sizes of corresponding selection arrays comprised in dimArrs. Elements are (in this order): number of (selected) trials nTrials, number of (selected) channels nChan, number of (selected) frequencies nFreq, number of (selected) tapers nTap.

  • isTimeFrequency (bool) – If True, input object contains time-frequency data, False otherwise

  • complexConversion (callable) – Lambda function that performs complex-to-float conversion of Fourier coefficients (if necessary).

  • pltDtype (str or numpy.dtype) – Numeric type of (potentially converted) complex Fourier coefficients.

  • dataLbl (str) – Caption for y-axis or colorbar (depending on value of isTimeFrequency).

Notes

This is an auxiliary method that is intended purely for internal use. Please refer to the user-exposed methods singlepanelplot() and/or multipanelplot() to actually generate plots of Syncopy data objects.

See also

syncopy.plotting.spy_plotting._prep_plots()

General basic input parsing for all Syncopy plotting routines