entities Package

context_model_parameters

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

Bases: SpatialModel

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)

Applies an equation on the given model parameter.

apply_focal_point(model_param, triangle_index)

NOTE: Expects a triangle index

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

get_configure_info()

Returns:

a dictionary which contains information about the applied equations on the model parameters.

get_data_for_model_param(param_name)

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)

Returns:

the applied equation for the given model param OR None if there is no equation applied to this param.

static get_equation_information()

get_focal_points_for_parameter(parameter_name)

Returns:

the list of focal points for the equation applied in the given model param.

remove_focal_point(model_param, triangle_index)

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()

Reset the equations for all the model parameters.

reset_param_equation(model_param)

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)

Bases: 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

Bases: object

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

KEY_VIEW_MODEL = 'viewModel'

add_view_model_to_session(view_model)

Put in session information about the view_model

clean_from_session()

Remove info about selected algo from session

get_view_model_from_session()

Get view_model from session

context_simulator

class tvb.interfaces.web.entities.context_simulator.SimulatorContext

Bases: 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: bool, is_simulator_copy: bool) → None

add_last_loaded_form_url_to_session(last_loaded_form_url: str) → None

add_simulator_load_to_session(is_simulator_load: bool) → None

property burst_config

clean_project_data_from_session(remove_project=True)

get_common_params()

init_session_at_burst_loading(burst_config: BurstConfiguration, simulator: SimulatorAdapterModel, last_loaded_form_url: str) → None

init_session_at_copy_preparation(burst_config: BurstConfiguration, simulator: SimulatorAdapterModel, last_loaded_form_url: str) → None

init_session_at_sim_config_from_zip(burst_config: BurstConfiguration, simulator: SimulatorAdapterModel, last_loaded_form_url: str) → None

init_session_at_sim_reset(burst_config: BurstConfiguration, last_loaded_form_url: str) → None

property last_loaded_fragment_url

property logged_user

property project

remove_burst_config_from_session()

set_burst_config(burst_config: BurstConfiguration | None = None) → None

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

set_simulator(simulator: SimulatorAdapterModel | None = None) → None

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

static set_warning_message(message)

property simulator

context_transfer_vector

class tvb.interfaces.web.entities.context_transfer_vector.TransferVectorContext(current_transfer_function, current_model_param, current_connectivity_measure)

Bases: SpatialModel

apply_transfer_function()

Applies a transfer function on the given model parameter.

get_applied_transfer_functions()

Returns:

a dictionary which contains information about the applied transfer functions on the model parameters.

static get_equation_information()