syncopy.plotting.spy_plotting._prep_toilim_avg

syncopy.plotting.spy_plotting._prep_toilim_avg(self)[source]

Set up averaging data across trials given toilim selection

Parameters

self (Syncopy data object) – Input object that is being processed by the respective singlepanelplot() or multipanelplot() function/class method.

Returns

tLengths – Array of length nSelectedTrials with each element encoding the number of samples contained in the provided toilim selection.

Return type

1D numpy.ndarray

Notes

If tLengths contains more than one unique element, a SPYValueError is raised.

Note further, that 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

singlepanelplot()

visualize Syncopy objects using single-panel figure(s)

multipanelplot()

visualize Syncopy objects using multi-panel figure(s)