# -*- 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 http://www.thevirtualbrain.org
#
# (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 <http://www.gnu.org/licenses/>.
#
#
# CITATION:
# When using The Virtual Brain for scientific publications, please cite it as explained here:
# https://www.thevirtualbrain.org/tvb/zwei/neuroscience-publications
#
#
"""
.. moduleauthor:: lia.domide <lia.domide@codemart.ro>
"""
[docs]class WebStructure(object):
### TVB sections. Will appear as footer entries.
SECTION_USER = "user"
SECTION_PROJECT = "project"
SECTION_BURST = "burst"
SECTION_ANALYZE = "analyze"
SECTION_STIMULUS = "stimulus"
SECTION_CONNECTIVITY = "connectivity"
### Subsections for USER section
SUB_SECTION_LOGIN = "login"
SUB_SECTION_ACCOUNT = "account"
### Subsections for PROJECT section.
SUB_SECTION_PROJECT_MENU = "project"
SUB_SECTION_OPERATIONS = "operations"
SUB_SECTION_DATA_STRUCTURE = "data"
SUB_SECTION_LIST_PROJECTS = "list"
SUB_SECTION_PROPERTIES_PROJECT = "properties"
SUB_SECTION_FIGURES = "figures"
### Subsections for BURST section.
SUB_SECTION_BURST = "burst"
SUB_SECTION_MODEL_REGIONS = "regionmodel"
SUB_SECTION_MODEL_SURFACE = "surfacemodel"
SUB_SECTION_NOISE_CONFIGURATION = "noiseconfig"
SUB_SECTION_PHASE_PLANE = "phaseplane"
### Subsections for ANALYZE section.
### These subsections can extends, and depend on existing analyzers in the system.
SUB_SECTION_ANALYZE_MENU = "analyze"
SUB_SECTION_ANALYZE_1 = "crosscorr"
SUB_SECTION_ANALYZE_2 = "ccpearson"
SUB_SECTION_ANALYZE_3 = "coherence"
SUB_SECTION_ANALYZE_4 = "complexcoherence"
SUB_SECTION_ANALYZE_5 = "covariance"
SUB_SECTION_ANALYZE_6 = "components"
SUB_SECTION_ANALYZE_7 = "fourier"
SUB_SECTION_ANALYZE_8 = "ica"
SUB_SECTION_ANALYZE_9 = "timeseries"
SUB_SECTION_ANALYZE_10 = "wavelet"
SUB_SECTION_ANALYZE_11 = "balloon"
SUB_SECTION_ANALYZE_12 = "bct"
SUB_SECTION_ANALYZE_13 = "bctcentrality"
SUB_SECTION_ANALYZE_14 = "bctclustering"
SUB_SECTION_ANALYZE_15 = "bctdegree"
SUB_SECTION_ANALYZE_16 = "bctdensity"
SUB_SECTION_ANALYZE_17 = "bctdistance"
SUB_SECTION_ANALYZE_18 = "fcd_calculator"
### Subsections for STIMULUS section.
SUB_SECTION_STIMULUS_MENU = "stimulus"
SUB_SECTION_STIMULUS_SURFACE = "regionstim"
SUB_SECTION_STIMULUS_REGION = "surfacestim"
### Subsections for CONNECTIVITY section
SUB_SECTION_CONNECTIVITY_MENU = "step"
SUB_SECTION_CONNECTIVITY = "connectivity"
SUB_SECTION_LOCAL_CONNECTIVITY = "local"
SUB_SECTION_ALLEN = "allen"
SUB_SECTION_SIIBRA = 'siibra'
### Subsections used under BURST and PROJECT sections.
### These subsections can extend, and depend on existing visualizers in the system.
SUB_SECTION_VIEW_0 = "view_connectivity"
SUB_SECTION_VIEW_1 = "view_connectivity_edge"
SUB_SECTION_VIEW_2 = "view_brain"
SUB_SECTION_VIEW_3 = "view_brain_dual"
SUB_SECTION_VIEW_4 = "view_connectivity_local"
SUB_SECTION_VIEW_5 = "view_covariance"
SUB_SECTION_VIEW_6 = "view_coherence"
SUB_SECTION_VIEW_7 = "view_complex_coherence"
SUB_SECTION_VIEW_8 = "view_correlation"
SUB_SECTION_VIEW_9 = "view_correlation_pearson"
SUB_SECTION_VIEW_10 = "view_correlation_pearson_edge"
SUB_SECTION_VIEW_11 = "view_animated_timeseries"
SUB_SECTION_VIEW_12 = "view_fourier"
SUB_SECTION_VIEW_13 = "view_histogram"
SUB_SECTION_VIEW_14 = "view_ica"
SUB_SECTION_VIEW_15 = "view_pca"
SUB_SECTION_VIEW_16 = "view_pse"
SUB_SECTION_VIEW_17 = "view_pse_iso"
SUB_SECTION_VIEW_18 = "view_sensors"
SUB_SECTION_VIEW_19 = "view_surface"
SUB_SECTION_VIEW_20 = "view_timeseries"
SUB_SECTION_VIEW_21 = "view_volume"
SUB_SECTION_VIEW_22 = "view_topography"
SUB_SECTION_VIEW_23 = "view_wavelet"
SUB_SECTION_VIEW_24 = "view_annotations"
SUB_SECTION_VIEW_25 = "view_matrix"
### Texts to appear in HTML page headers as section-title.
WEB_SECTION_TITLES = {
SECTION_USER: "User",
SECTION_PROJECT: "Project",
SECTION_BURST: "Simulator",
SECTION_ANALYZE: "Analyze",
SECTION_STIMULUS: "Stimulus",
SECTION_CONNECTIVITY: 'Connectivity'}
### Texts to appear in HTML page headers as subsection-title.
### Attribute _ui_name in visualizer will be used as page-subtitle.
WEB_SUBSECTION_TITLES = {
SUB_SECTION_LOGIN: "Login",
SUB_SECTION_ACCOUNT: "Register",
SUB_SECTION_PROJECT_MENU: "",
SUB_SECTION_OPERATIONS: "Operations",
SUB_SECTION_DATA_STRUCTURE: "Data Structure",
SUB_SECTION_LIST_PROJECTS: "List",
SUB_SECTION_PROPERTIES_PROJECT: "Properties",
SUB_SECTION_FIGURES: "Image Archive",
SUB_SECTION_BURST: "",
SUB_SECTION_MODEL_REGIONS: "Region Model Parameters",
SUB_SECTION_MODEL_SURFACE: "Surface Model Parameters",
SUB_SECTION_NOISE_CONFIGURATION: "Noise dispersion configuration",
SUB_SECTION_PHASE_PLANE: "Phase plane",
SUB_SECTION_ANALYZE_MENU: "",
SUB_SECTION_ANALYZE_1: "Cross Correlation",
SUB_SECTION_ANALYZE_2: "Correlation Coefficients",
SUB_SECTION_ANALYZE_3: "Coherence",
SUB_SECTION_ANALYZE_4: "Complex Coherence",
SUB_SECTION_ANALYZE_5: "Covariance",
SUB_SECTION_ANALYZE_6: "Principal Components",
SUB_SECTION_ANALYZE_7: "Fourier",
SUB_SECTION_ANALYZE_8: "ICA",
SUB_SECTION_ANALYZE_9: "TimeSeries",
SUB_SECTION_ANALYZE_10: "Wavelet",
SUB_SECTION_ANALYZE_11: "Model Balloon",
SUB_SECTION_ANALYZE_12: "BCT",
SUB_SECTION_ANALYZE_13: "BCT Centrality",
SUB_SECTION_ANALYZE_14: "BCT Clustering",
SUB_SECTION_ANALYZE_15: "BCT Degree",
SUB_SECTION_ANALYZE_16: "BCT Density",
SUB_SECTION_ANALYZE_17: "BCT Distance",
SUB_SECTION_ANALYZE_18: "Functional Connectivity Dynamics",
SUB_SECTION_STIMULUS_MENU: "",
SUB_SECTION_STIMULUS_SURFACE: "Region",
SUB_SECTION_STIMULUS_REGION: "Surface",
SUB_SECTION_CONNECTIVITY_MENU: "",
SUB_SECTION_CONNECTIVITY: "Large Scale",
SUB_SECTION_LOCAL_CONNECTIVITY: "Local",
SUB_SECTION_ALLEN: "Mouse",
SUB_SECTION_SIIBRA: "Siibra",
SUB_SECTION_VIEW_0: "Connectivity Visualizer",
SUB_SECTION_VIEW_1: "Connectivity Edge Visualizer",
SUB_SECTION_VIEW_2: "Brain Visualizer",
SUB_SECTION_VIEW_3: "Brain Dual Activity Visualizer (3D and 2D)",
SUB_SECTION_VIEW_4: "Local Connectivity Visualizer",
SUB_SECTION_VIEW_5: "Covariance Visualizer",
SUB_SECTION_VIEW_6: "Coherence Visualizer",
SUB_SECTION_VIEW_7: "Complex Coherence Visualizer",
SUB_SECTION_VIEW_8: "Cross Correlation Visualizer",
SUB_SECTION_VIEW_9: "Pearson Correlation Coefficients Visualizer",
SUB_SECTION_VIEW_10: "Pearson Correlation Coefficients Edge Visualizer",
SUB_SECTION_VIEW_11: "Animated TimeSeries Visualizer",
SUB_SECTION_VIEW_12: "Fourier Visualizer",
SUB_SECTION_VIEW_13: "Histogram Visualizer",
SUB_SECTION_VIEW_14: "ICA Visualizer",
SUB_SECTION_VIEW_15: "PCA Visualizer",
SUB_SECTION_VIEW_16: "Discrete PSE Visualizer",
SUB_SECTION_VIEW_17: "Isocline PSE Visualizer",
SUB_SECTION_VIEW_18: "Sensor Visualizer",
SUB_SECTION_VIEW_19: "Surface Visualizer",
SUB_SECTION_VIEW_20: "TimeSeries Visualizer",
SUB_SECTION_VIEW_21: "in Volume Visualizer",
SUB_SECTION_VIEW_22: "Topography Visualizer",
SUB_SECTION_VIEW_23: "Wavelet Visualizer",
SUB_SECTION_VIEW_24: "Annotations Visualizer",
SUB_SECTION_VIEW_25: "Matrix Visualizer"
}
### ID of the HTML generated paragraph, to jump to it directly, in the online help overlay.
VISUALIZERS_ONLINE_HELP_SHORTCUTS = {
## Connectivity subsection link will not be needed, as we will have a full section in the help for this.
## SUB_SECTION_VIEW_0: "connectivity-visualizer**",
SUB_SECTION_VIEW_1: "connectivity-edge-bundle-visualizer",
SUB_SECTION_VIEW_2: "brain-activity-visualizer",
SUB_SECTION_VIEW_3: "dual-brain-activity-visualizer",
SUB_SECTION_VIEW_4: "local-connectivity-visualizer",
SUB_SECTION_VIEW_5: "covariance-visualizer",
SUB_SECTION_VIEW_6: "cross-coherence-visualizer",
SUB_SECTION_VIEW_7: "complex-coherence-visualizer",
SUB_SECTION_VIEW_8: "cross-correlation-visualizer",
SUB_SECTION_VIEW_9: "pearson-coefficients-visualizer",
SUB_SECTION_VIEW_10: "pearson-edge-bundle-visualizer",
SUB_SECTION_VIEW_11: "animated-time-series-visualizer",
SUB_SECTION_VIEW_12: "fourier-spectrum-visualizer",
SUB_SECTION_VIEW_13: "connectivity-measure-visualizer",
SUB_SECTION_VIEW_14: "independent-component-visualizer",
SUB_SECTION_VIEW_15: "principal-component-visualizer",
SUB_SECTION_VIEW_16: "discrete-pse-visualizer",
SUB_SECTION_VIEW_17: "isocline-pse-visualizer",
SUB_SECTION_VIEW_18: "sensor-visualizer",
SUB_SECTION_VIEW_19: "surface-visualizer",
SUB_SECTION_VIEW_20: "time-series-visualizer-svg-d3",
SUB_SECTION_VIEW_21: "volume-visualizer",
SUB_SECTION_VIEW_22: "topographic-visualizer",
SUB_SECTION_VIEW_23: "wavelet-spectrogram-visualizer",
SUB_SECTION_VIEW_24: "annotations-visualizer",
SUB_SECTION_VIEW_25: "matrix-visualizer"
}
### ID of the HTML generated paragraph, to jump to it directly, in the online help overlay.
### This can be wither a specific manual written description in UserGuide-UI_Analyzer.rst,
### or it can refer to a automatic generated paragraph for an analyzer, as mapped by api_anbalyzers.py
ANALYZERS_ONLINE_HELP_SHORTCUTS = {
SUB_SECTION_ANALYZE_1: "cross-correlation-of-nodes",
SUB_SECTION_ANALYZE_2: "pearson-correlation-coefficient",
SUB_SECTION_ANALYZE_3: "cross-coherence-of-nodes",
SUB_SECTION_ANALYZE_4: "complex-coherence-of-nodes",
SUB_SECTION_ANALYZE_5: "temporal-covariance-of-nodes",
SUB_SECTION_ANALYZE_6: "principal-component-analysis-pca",
SUB_SECTION_ANALYZE_7: "fourier-spectral-analysis",
SUB_SECTION_ANALYZE_8: "independent-component-analysis-ica",
SUB_SECTION_ANALYZE_9: "timeseries-metrics",
SUB_SECTION_ANALYZE_10: "continuous-wavelet-transform-cwt",
SUB_SECTION_ANALYZE_11: "model-balloon",
SUB_SECTION_ANALYZE_12: "brain-connectivity-toolbox-analyzers",
SUB_SECTION_ANALYZE_13: "brain-connectivity-toolbox-analyzers",
SUB_SECTION_ANALYZE_14: "brain-connectivity-toolbox-analyzers",
SUB_SECTION_ANALYZE_15: "brain-connectivity-toolbox-analyzers",
SUB_SECTION_ANALYZE_16: "brain-connectivity-toolbox-analyzers",
SUB_SECTION_ANALYZE_17: "brain-connectivity-toolbox-analyzers",
SUB_SECTION_ANALYZE_18: "functional-connectivity-dynamics-metric",
}
