Source code for tvb.adapters.visualizers.cross_coherence

# -*- coding: utf-8 -*-
# TheVirtualBrain-Framework Package. This package holds all Data Management, and 
# Web-UI helpful to run brain-simulations. To use it, you also need to download
# TheVirtualBrain-Scientific Package (for simulators). See content of the
# documentation-folder for more details. See also
# (c) 2012-2023, 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:

A displayer for the cross coherence of a time series.

.. moduleauthor:: Marmaduke Woodman <>


import json

from tvb.adapters.datatypes.db.spectral import CoherenceSpectrumIndex
from tvb.adapters.visualizers.matrix_viewer import ABCMappedArraySVGVisualizer
from tvb.core.adapters.abcadapter import ABCAdapterForm
from tvb.core.adapters.abcdisplayer import ABCDisplayer
from tvb.core.neocom import h5
from tvb.core.neotraits.forms import TraitDataTypeSelectField
from tvb.core.neotraits.view_model import ViewModel, DataTypeGidAttr
from tvb.datatypes.spectral import CoherenceSpectrum

[docs]class CrossCoherenceVisualizerModel(ViewModel): datatype = DataTypeGidAttr( linked_datatype=CoherenceSpectrum, label='Coherence spectrum:' )
[docs]class CrossCoherenceVisualizerForm(ABCAdapterForm): def __init__(self): super(CrossCoherenceVisualizerForm, self).__init__() self.datatype = TraitDataTypeSelectField(CrossCoherenceVisualizerModel.datatype, name='datatype', conditions=self.get_filters())
[docs] @staticmethod def get_view_model(): return CrossCoherenceVisualizerModel
[docs] @staticmethod def get_required_datatype(): return CoherenceSpectrumIndex
[docs] @staticmethod def get_input_name(): return 'datatype'
[docs] @staticmethod def get_filters(): return None
[docs]class CrossCoherenceVisualizer(ABCMappedArraySVGVisualizer): _ui_name = "Cross Coherence Visualizer" _ui_subsection = "coherence"
[docs] def get_form_class(self): return CrossCoherenceVisualizerForm
[docs] def launch(self, view_model): # type: (CrossCoherenceVisualizerModel) -> dict """Construct data for visualization and launch it.""" with h5.h5_file_for_gid(view_model.datatype) as datatype_h5: # get data from coherence datatype h5, convert to json frequency = ABCDisplayer.dump_with_precision(datatype_h5.frequency.load().flat) array_data = datatype_h5.array_data[:] params = self.compute_raw_matrix_params(array_data) params.update(frequency=frequency) params.update(matrix_strides=json.dumps([x / array_data.itemsize for x in array_data.strides])) return self.build_display_result("cross_coherence/view", params)