Source code for tvb.analyzers.metric_variance_global

# -*- coding: utf-8 -*-
# TheVirtualBrain-Scientific Package. This package holds all simulators, and
# analysers necessary to run brain-simulations. You can use it stand alone or
# in conjunction with TheVirtualBrain-Framework Package. See content of the
# documentation-folder for more details. See also
# (c) 2012-2024, Baycrest Centre for Geriatric Care ("Baycrest") and others
# This program is free software: you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software Foundation,
# either version 3 of the License, or (at your option) any later version.
# This program is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
# PARTICULAR PURPOSE.  See the GNU General Public License for more details.
# You should have received a copy of the GNU General Public License along with this
# program.  If not, see <>.
# When using The Virtual Brain for scientific publications, please cite it as explained here:

Filler analyzer: Takes a TimeSeries object and returns a Float.

.. moduleauthor:: Bogdan Neacsa <>
.. moduleauthor:: Stuart A. Knock <Stuart@tvb.invalid>


from tvb.basic.logger.builder import get_logger

Zero-centres all the time-series and then calculates the variance over all 
data points.
TimeSeries DataType
This is a crude indicator of "excitability" or oscillation amplitude of the
models over the entire network.

log = get_logger(__name__)

[docs] def compute_variance_global_metric(params): """ # type: dict(TimeSeries, float, int) -> float Compute the zero centered global variance of the time_series. Parameters ---------- params : a dictionary containing time_series : TimeSeries Input time series for which the metric will be computed. start_point : float Determines how many points of the TimeSeries will be discarded before computing the metric segment : int Divides the input time-series into discrete equally sized sequences and use the last segment to compute the metric. Only used when the start point is larger than the time-series length """ time_series = params['time_series'] start_point = params['start_point'] segment = params['segment'] shape = tpts = shape[0] if start_point != 0.0: start_tpt = start_point / time_series.sample_period log.debug("Will discard: %s time points" % start_tpt) else: start_tpt = 0 if start_tpt > tpts: log.warning("The time-series is shorter than the starting point") log.debug("Will divide the time-series into %d segments." % segment) # Lazy strategy start_tpt = int((segment - 1) * (tpts // segment)) start_tpt = int(start_tpt) zero_mean_data = ([start_tpt:, :] -[start_tpt:, :].mean(axis=0)) global_variance = zero_mean_data.var() return global_variance