entities Package

context_model_parameters

class tvb.interfaces.web.entities.context_model_parameters.EquationDisplayer(**kwargs)

Bases: tvb.basic.neotraits._core.HasTraits

Class used for generating the UI related to equations.

model_param_equation : tvb.interfaces.web.entities.context_model_parameters.EquationDisplayer.model_param_equation = Attr(field_type=<class ‘tvb.datatypes.equations.SpatialApplicableEquation’>, default=<tvb.datatypes.equations.Gaussian object at 0x7f718385c810>, required=True)

gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)

model_param_equation

An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.

class tvb.interfaces.web.entities.context_model_parameters.SurfaceContextModelParameters(surface, default_model=None)

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)

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(original_param_name, modified_param_name)

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

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.

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

Bases: builtins.object

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

KEY_CURRENT_ADAPTER_INFO = 'currentAdapterInfo'

KEY_PORTLET_CONFIGURATION = 'portletConfig'

KEY_TREE_DEFAULT = 'defaultTree'

add_adapter_to_session(algorithm, input_tree, default_data=None)

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

add_portlet_to_session(portlet_interface)

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

clean_from_session()

Remove info about selected algo from session

get_current_default(param_name=None)

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

get_current_input_tree()

Get from session previously selected InputTree.

get_current_step()

Get from session previously selected step (category ID).

get_current_substep()

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

get_session_tree_for_key(tree_session_key)

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