# -*- 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>
.. moduleauthor:: Bogdan Neacsa <bogdan.neacsa@codemart.ro>
"""
import urllib.request, urllib.parse, urllib.error
import cherrypy
from tvb.config.init.introspector_registry import IntrospectionRegistry
from tvb.core.entities.load import load_entity_by_gid
from tvb.core.services.project_service import ProjectService
from tvb.core.adapters.abcadapter import ABCAdapter
from tvb.core.adapters.exceptions import LaunchException
from tvb.core.entities.filters.factory import FilterChain
from tvb.interfaces.web.controllers.autologging import traced
from tvb.interfaces.web.controllers.decorators import handle_error, expose_fragment, check_user
from tvb.interfaces.web.controllers.decorators import using_template, expose_json
from tvb.interfaces.web.controllers.base_controller import BaseController
PSE_FLOT = "FLOT"
PSE_ISO = "ISO"
REDIRECT_MSG = '/burst/explore/pse_error?adapter_name=%s&message=%s'
[docs]
@traced
class ParameterExplorationController(BaseController):
"""
Controller to handle PSE actions.
"""
[docs]
@cherrypy.expose
@handle_error(redirect=False)
def get_default_pse_viewer(self, datatype_group_gid):
"""
For a given DataTypeGroup, check first if the discrete PSE is compatible.
If this is not the case fallback to the continous PSE viewer.
If none are available return: None.
"""
algorithm = self.algorithm_service.get_algorithm_by_module_and_class(IntrospectionRegistry.DISCRETE_PSE_ADAPTER_MODULE,
IntrospectionRegistry.DISCRETE_PSE_ADAPTER_CLASS)
if self._is_compatible(algorithm, datatype_group_gid):
return PSE_FLOT
algorithm = self.algorithm_service.get_algorithm_by_module_and_class(IntrospectionRegistry.ISOCLINE_PSE_ADAPTER_MODULE,
IntrospectionRegistry.ISOCLINE_PSE_ADAPTER_CLASS)
if self._is_compatible(algorithm, datatype_group_gid):
return PSE_ISO
return None
def _is_compatible(self, algorithm, datatype_group_gid):
"""
Check if PSE view filters are compatible with current DataType.
:param algorithm: Algorithm instance to get filters from it.
:param datatype_group_gid: Current DataTypeGroup to validate against.
:returns: True when DataTypeGroup can be displayed with current algorithm, False when incompatible.
"""
datatype_group = load_entity_by_gid(datatype_group_gid)
filter_chain = FilterChain.from_json(algorithm.datatype_filter)
if datatype_group and (not filter_chain or filter_chain.get_python_filter_equivalent(datatype_group)):
return True
return False
[docs]
@expose_fragment('burst/burst_pse_error')
def pse_error(self, adapter_name, message):
return {'adapter_name': adapter_name, 'message': message}
def _prepare_pse_context(self, datatype_group_gid, back_page, color_metric, size_metric, is_refresh):
if color_metric == 'None' or color_metric == "undefined":
color_metric = None
if size_metric == 'None' or size_metric == "undefined":
size_metric = None
algorithm = self.algorithm_service.get_algorithm_by_module_and_class(
IntrospectionRegistry.DISCRETE_PSE_ADAPTER_MODULE,
IntrospectionRegistry.DISCRETE_PSE_ADAPTER_CLASS)
adapter = ABCAdapter.build_adapter(algorithm)
if self._is_compatible(algorithm, datatype_group_gid):
try:
pse_context = adapter.prepare_parameters(datatype_group_gid, back_page, color_metric, size_metric)
if is_refresh:
return dict(series_array=pse_context.series_array,
has_started_ops=pse_context.has_started_ops)
else:
pse_context.prepare_individual_jsons()
return pse_context
except LaunchException as ex:
error_msg = urllib.parse.quote(ex.message)
else:
error_msg = urllib.parse.quote(
"Discrete PSE is incompatible (most probably due to result size being too large).")
name = urllib.parse.quote(adapter._ui_name)
raise LaunchException(REDIRECT_MSG % (name, error_msg))
[docs]
@cherrypy.expose
@handle_error(redirect=True)
@using_template('visualizers/pse_discrete/burst_preview')
@check_user
def draw_discrete_exploration(self, datatype_group_gid, back_page, color_metric=None, size_metric=None):
"""
Create new data for when the user chooses to refresh from the UI.
"""
try:
return self._prepare_pse_context(datatype_group_gid, back_page, color_metric, size_metric, False)
except LaunchException as ex:
self.redirect(ex.message)
[docs]
@expose_json
def get_series_array_discrete(self, datatype_group_gid, back_page, color_metric=None, size_metric=None):
"""
Create new data for when the user chooses to refresh from the UI.
"""
try:
return self._prepare_pse_context(datatype_group_gid, back_page, color_metric, size_metric, True)
except LaunchException as ex:
self.redirect(ex.message)
[docs]
@cherrypy.expose
@handle_error(redirect=True)
@using_template('visualizers/pse_isocline/burst_preview')
@check_user
def draw_isocline_exploration(self, datatype_group_gid):
algorithm = self.algorithm_service.get_algorithm_by_module_and_class(IntrospectionRegistry.ISOCLINE_PSE_ADAPTER_MODULE,
IntrospectionRegistry.ISOCLINE_PSE_ADAPTER_CLASS)
adapter = ABCAdapter.build_adapter(algorithm)
if self._is_compatible(algorithm, datatype_group_gid):
try:
view_model = adapter.get_view_model_class()()
view_model.datatype_group = datatype_group_gid
return adapter.burst_preview(view_model)
except LaunchException as ex:
self.logger.error(ex.message)
error_msg = urllib.parse.quote(ex.message)
else:
error_msg = urllib.parse.quote("Isocline PSE requires a 2D range of floating point values.")
name = urllib.parse.quote(adapter._ui_name)
self.redirect(REDIRECT_MSG % (name, error_msg))
[docs]
@expose_json
def get_metric_matrix(self, datatype_group_gid, metric_name=None):
algorithm = self.algorithm_service.get_algorithm_by_module_and_class(IntrospectionRegistry.ISOCLINE_PSE_ADAPTER_MODULE,
IntrospectionRegistry.ISOCLINE_PSE_ADAPTER_CLASS)
adapter = ABCAdapter.build_adapter(algorithm)
if self._is_compatible(algorithm, datatype_group_gid):
try:
return adapter.get_metric_matrix(datatype_group_gid, metric_name)
except LaunchException as ex:
self.logger.error(ex.message)
error_msg = urllib.parse.quote(ex.message)
else:
error_msg = urllib.parse.quote("Isocline PSE requires a 2D range of floating point values.")
name = urllib.parse.quote(adapter._ui_name)
self.redirect(REDIRECT_MSG % (name, error_msg))
[docs]
@expose_json
def get_node_matrix(self, datatype_group_gid):
algorithm = self.algorithm_service.get_algorithm_by_module_and_class(IntrospectionRegistry.ISOCLINE_PSE_ADAPTER_MODULE,
IntrospectionRegistry.ISOCLINE_PSE_ADAPTER_CLASS)
adapter = ABCAdapter.build_adapter(algorithm)
if self._is_compatible(algorithm, datatype_group_gid):
try:
return adapter.prepare_node_data(datatype_group_gid)
except LaunchException as ex:
self.logger.error(ex.message)
error_msg = urllib.parse.quote(ex.message)
else:
error_msg = urllib.parse.quote("Isocline PSE requires a 2D range of floating point values.")
name = urllib.parse.quote(adapter._ui_name)
self.redirect(REDIRECT_MSG % (name, error_msg))
