syncopy.plotting._plot_analog._prep_analog_plots¶

syncopy.plotting._plot_analog._prep_analog_plots(self, name, **inputArgs)[source]¶

Local helper that performs sanity checks and sets up data selection

Parameters

self (AnalogData object) – Syncopy AnalogData object that is being processed by the respective singlepanelplot() or multipanelplot() class methods defined in this module.
name (str) – Name of caller (i.e., “singlepanelplot” or “multipanelplot”)
inputArgs (dict) – Input arguments of caller (i.e., singlepanelplot() or multipanelplot()) collected in dictionary

Returns

dimArrs (tuple) – Tuple containing (in this order) trList, list of (selected) trials to visualize and chArr, 1D numpy.ndarray of channel specifiers based on provided user selection. Note that “all” and None selections are converted to arrays ready for indexing.
dimCounts (tuple) – Tuple holding sizes of corresponding selection arrays comprised in dimArrs. Elements are nTrials, number of (selected) trials and nChan, number of (selected) channels.
idx (list) – Three element indexing list (respecting non-default `dimord`s) intended for use with trial-array data.
timeIdx (int) – Position of time-axis within indexing list idx (either 0 or 1).
chanIdx (int) – Position of channel-axis within indexing list idx (either 0 or 1).

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.