- syncopy.mean(spy_data, dim, keeptrials=True, parallel=None, select=None, **kwargs)[source]#
Calculates the average along arbitrary dimensions of a Syncopy data object
Additional trial averaging can be performed with
keeptrials=False. Standalone (only) trial averaging can only be done sequentially and requires
spy_data (Syncopy data object) – The object where an average is to be computed
dim (str) – Dimension label over which to calculate the statistic. Must be present in the
spy_dataobject, e.g. ‘channel’ or ‘trials’
keeptrials (bool) – Set to
Falseto trigger additional trial averaging Has no effect if
parallel (None or bool) – If None (recommended), processing is automatically performed in parallel (i.e., concurrently across trials/channel-groups), provided a dask parallel processing client is running and available. Parallel processing can be manually disabled by setting parallel to False. If parallel is True but no parallel processing client is running, computing will be performed sequentially.
select (dict or
StructDictor str) – In-place selection of subset of input data for processing. Please refer to
syncopy.selectdata()for further usage details.
res – New object with the desired dimension averaged out
- Return type
Syncopy data object