TheVirtualBrain:
TheDocumentationwebsite.
# -*- 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 do download
# TheVirtualBrain-Scientific Package (for simulators). See content of the
# documentation-folder for more details. See also http://www.thevirtualbrain.org
#
# (c) 2012-2022, 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 follows:
#
# Paula Sanz Leon, Stuart A. Knock, M. Marmaduke Woodman, Lia Domide,
# Jochen Mersmann, Anthony R. McIntosh, Viktor Jirsa (2013)
# The Virtual Brain: a simulator of primate brain network dynamics.
# Frontiers in Neuroinformatics (7:10. doi: 10.3389/fninf.2013.00010)
#
#
from tvb.adapters.simulator.noise_forms import get_form_for_noise
from tvb.adapters.simulator.subforms_mapping import SubformsEnum, get_ui_name_to_noise_dict
from tvb.basic.neotraits.api import Attr
from tvb.core.entities.file.simulator.view_model import HeunDeterministicViewModel, HeunStochasticViewModel, \
EulerDeterministicViewModel, EulerStochasticViewModel, RungeKutta4thOrderDeterministicViewModel, IdentityViewModel, \
VODEViewModel, VODEStochasticViewModel, Dopri5ViewModel, Dopri5StochasticViewModel, Dop853ViewModel, \
Dop853StochasticViewModel, IntegratorViewModel, NoiseViewModel
from tvb.core.entities.file.simulator.view_model import IntegratorStochasticViewModel
from tvb.core.neotraits.forms import Form, SelectField, FloatField
[docs]def get_integrator_to_form_dict():
integrator_class_to_form = {
HeunDeterministicViewModel: IntegratorForm,
HeunStochasticViewModel: IntegratorStochasticForm,
EulerDeterministicViewModel: IntegratorForm,
EulerStochasticViewModel: IntegratorStochasticForm,
RungeKutta4thOrderDeterministicViewModel: IntegratorForm,
IdentityViewModel: IntegratorForm,
VODEViewModel: IntegratorForm,
VODEStochasticViewModel: IntegratorStochasticForm,
Dopri5ViewModel: IntegratorForm,
Dopri5StochasticViewModel: IntegratorStochasticForm,
Dop853ViewModel: IntegratorForm,
Dop853StochasticViewModel: IntegratorStochasticForm
}
return integrator_class_to_form
[docs]def get_form_for_integrator(integrator_class):
return get_integrator_to_form_dict().get(integrator_class)
[docs]class IntegratorForm(Form):
def __init__(self):
super(IntegratorForm, self).__init__()
self.dt = FloatField(IntegratorViewModel.dt)
[docs]class IntegratorStochasticForm(IntegratorForm):
template = 'form_fields/select_field.html'
def __init__(self):
super(IntegratorStochasticForm, self).__init__()
self.noise_choices = get_ui_name_to_noise_dict()
default_noise = list(self.noise_choices.values())[0]
self.noise = SelectField(Attr(NoiseViewModel, label='Noise', default=default_noise), name='noise',
choices=self.noise_choices, subform=get_form_for_noise(default_noise))
[docs] def fill_trait(self, datatype):
super(IntegratorStochasticForm, self).fill_trait(datatype)
if self.noise.data and type(datatype.noise) != self.noise.data:
datatype.noise = self.noise.data()
[docs] def fill_from_trait(self, trait):
# type: (IntegratorStochasticViewModel) -> None
super(IntegratorStochasticForm, self).fill_from_trait(trait)
self.noise.data = trait.noise.__class__