The Virtual Brain Project

Table Of Contents

Previous topic

spatial Package

This Page

entities Package



Class used for generating the UI related to equations.

traits on this class:

model_param_equation (Equation)

default: <class ‘tvb.datatypes.equations.Gaussian’>
class tvb.interfaces.web.entities.context_model_parameters.SurfaceContextModelParameters(surface, default_model=None)[source]

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

Returns:a dictionary which contains information about the applied equations on the model parameters.
get_data_for_model_param(original_param_name, modified_param_name)[source]
Returns:a dictionary of form {“equation”: $equation, “focal_points”: $list_of_focal_points, “no_of_vertices”: $surface_no_of_vertices} if the user specified any equation for computing the value of the given parameter, OR a string of form: “[$default_model_param_value]” if the user didn’t specified an equation for the given param
Returns:the applied equation for the given model param OR None if there is no equation applied to this param.
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 the equations for all the model parameters.


Resets the equation for the specified model parameter.


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

Bases: object

This class contains details necessary to render tabs in overlays


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

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

Bases: object

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

KEY_CURRENT_ADAPTER_INFO = 'currentAdapterInfo'
KEY_TREE_DEFAULT = 'defaultTree'
add_adapter_to_session(algorithm, input_tree, default_data=None)[source]

Put in session information about currently selected adapter. Will be used by filters and efficiency load.


Add a portlet configuration to the session. Used for applying filters on portlet configurations.


Remove info about selected algo from session


Read from session previously stored default data. :param param_name: When None, return full dictionary with defaults.


Get from session previously selected InputTree.


Get from session previously selected step (category ID).


Get from session previously selected step (algo-group ID).


Get from session previously selected InputTree stored under the :param tree_session_key.