TheVirtualBrain:

TheDocumentationwebsite.

Table Of Contents

Previous topic

spatial Package

Next topic

analyzers Package

This Page

entities Package

context_model_parameters

class tvb.interfaces.web.entities.context_model_parameters.SurfaceContextModelParameters(surface_index, default_model, current_equation, current_model_param)[source]

Bases: builtins.object

This class contains methods which allows you to edit the model parameters for each vertex of the given surface.

apply_equation(param_name, equation_instance)[source]

Applies an equation on the given model parameter.

apply_focal_point(model_param, triangle_index)[source]

NOTE: Expects a triangle index

Adds a focal point in which should be applied the equation for the given model parameter.

get_configure_info()[source]
Returns:a dictionary which contains information about the applied equations on the model parameters.
get_data_for_model_param(param_name)[source]

Compute the equation configured for the current param_name. If no equation was set for param_name, return the default array.

get_equation_for_parameter(parameter_name)[source]
Returns:the applied equation for the given model param OR None if there is no equation applied to this param.
get_focal_points_for_parameter(parameter_name)[source]
Returns:the list of focal points for the equation applied in the given model param.
remove_focal_point(model_param, triangle_index)[source]

NOTE: Expects a vertex index

Removes a focal point from the list of focal points in which should be applied the equation for the given model parameter.

reset_equations_for_all_parameters()[source]

Reset the equations for all the model parameters.

reset_param_equation(model_param)[source]

Resets the equation for the specified model parameter.

context_overlay

class tvb.interfaces.web.entities.context_overlay.OverlayTabDefinition(name, css_class=None, enabled=True, description=None)[source]

Bases: builtins.object

This class contains details necessary to render tabs in overlays

context_selected_adapter

Used by FlowController. It will store in current user’s session information about

class tvb.interfaces.web.entities.context_selected_adapter.SelectedAdapterContext[source]

Bases: builtins.object

Responsible for storing/retrieving/removing from session info about currently selected algorithm.

KEY_VIEW_MODEL = 'viewModel'
add_view_model_to_session(view_model)[source]

Put in session information about the view_model

clean_from_session()[source]

Remove info about selected algo from session

get_view_model_from_session()[source]

Get view_model from session

context_simulator

class tvb.interfaces.web.entities.context_simulator.SimulatorContext[source]

Bases: builtins.object

KEY_BURST_CONFIG = 'burst_configuration'
KEY_IS_SIMULATOR_BRANCH = 'is_simulator_branch'
KEY_IS_SIMULATOR_COPY = 'is_simulator_copy'
KEY_IS_SIMULATOR_LOAD = 'is_simulator_load'
KEY_LAST_LOADED_FORM_URL = 'last_loaded_form_url'
KEY_SIMULATOR_CONFIG = 'simulator_configuration'
add_branch_and_copy_to_session(is_simulator_branch, is_simulator_copy)[source]
add_last_loaded_form_url_to_session(last_loaded_form_url)[source]
add_simulator_load_to_session(is_simulator_load)[source]
burst_config[source]
clean_project_data_from_session(remove_project=True)[source]
get_common_params()[source]
init_session_at_burst_loading(burst_config, simulator, last_loaded_form_url)[source]
init_session_at_copy_preparation(burst_config, simulator, last_loaded_form_url)[source]
init_session_at_sim_config_from_zip(burst_config, simulator, last_loaded_form_url)[source]
init_session_at_sim_reset(burst_config, last_loaded_form_url)[source]
last_loaded_fragment_url[source]
logged_user[source]
project[source]
remove_burst_config_from_session()[source]
set_burst_config(burst_config=None)[source]

Create a new burst instance only if one does not exist in the context.

set_simulator(simulator=None)[source]

Create a new simulator instance only if one does not exist in the context.

static set_warning_message(message)[source]
simulator[source]