The Virtual Brain Project

Table Of Contents

Previous topic

file_update_scripts Package

Next topic

db_update_scripts Package

This Page

model Package

Gather together all model classes, for easy import and usage.

model_base

Common parts for all classes in Model.

model_burst

tvb.core.entities.model.model_burst.BurstConfiguration[source]

Contains information required to rebuild the interface of a burst that was already launched.

  • simulator_configuration - hold a dictionary with what entries were displayed in the simulator part
  • dynamic_ids - A list of dynamic id’s associated with the connectivity nodes. Used by the region parameters page

traits on this class:

tvb.core.entities.model.model_burst.Dynamic[source]

traited class Dynamic traits on this class:

class tvb.core.entities.model.model_burst.TabConfiguration[source]

Helper entity to hold data that is currently being configured in a new burst page.

clone()[source]

Return an exact copy of the entity with the exception than none of it’s sub-entities (portlets, workflow steps) are persisted in db.

get_portlet(portlet_id)[source]
Returns:a PortletConfiguration entity.
reset()[source]

Set to None all portlets in current TAB.

model_datatype

Entities for Generic DataTypes, Links and Groups of DataTypes are defined here.

tvb.core.entities.model.model_datatype.DataType[source]

Base class for DB storage of Types. DataTypes, are the common language between Visualizers, Simulator and Analyzers.

traits on this class:

tvb.core.entities.model.model_datatype.DataTypeGroup[source]

All the DataTypes resulted from an operation group will be part from a DataType group.

traits on this class:

Class used to handle shortcuts from one DataType to another project.

traits on this class:

tvb.core.entities.model.model_datatype.MeasurePointsSelection[source]

Interest area. A subset of nodes from a Connectivity or Sensors.

traits on this class:

tvb.core.entities.model.model_datatype.StoredPSEFilter[source]

Interest Area PSE Viewer Filter tool, specific filter configuration user inputs to be stored from multiple elements

traits on this class:

model_operation

Here we define entities for Operations and Algorithms.

tvb.core.entities.model.model_operation.Algorithm[source]

traited class Algorithm traits on this class:

tvb.core.entities.model.model_operation.AlgorithmCategory[source]

A category that will have different boolean attributes e.g.: launchable|rawinput| display, a displayName and a default state for data.

traits on this class:

class tvb.core.entities.model.model_operation.AlgorithmTransientGroup(name, description, subsection=None)[source]

Bases: object

tvb.core.entities.model.model_operation.Operation[source]

The class used to log any action executed in Projects.

traits on this class:

tvb.core.entities.model.model_operation.OperationGroup[source]

We use this group entity, to map in DB a group of operations started in the same time by the user

traits on this class:

tvb.core.entities.model.model_operation.OperationProcessIdentifier[source]

Class for storing for each operation the process identifier under which it was launched so any operation can be stopped from tvb.

traits on this class:

tvb.core.entities.model.model_operation.ResultFigure[source]

Class for storing figures from results, visualize them eventually next to each other. A group of results, with the same session_name will be displayed

traits on this class:

tvb.core.entities.model.model_operation.has_finished(status)[source]

Is the given status indicating a finished operation?

model_project

Here we define entities related to user and project.

tvb.core.entities.model.model_project.Project[source]

Contains the Projects informations and who is the administrator.

traits on this class:

tvb.core.entities.model.model_project.User[source]

Contains the users informations.

traits on this class:

tvb.core.entities.model.model_project.UserPreferences[source]

Contains the user preferences data.

traits on this class:

tvb.core.entities.model.model_project.User_to_Project[source]

Multiple Users can be members of a given Project.

traits on this class:

model_workflow

Here we define entities related to workflows and portlets.

tvb.core.entities.model.model_workflow.Portlet[source]

Store the Portlet entities. One entity will hold: - portlet id; - path to the XML file that declares it; - a name given in the XML - an unique identifier (also from XML) - last date of introspection.

traits on this class:

tvb.core.entities.model.model_workflow.Workflow[source]

Main Workflow class. One Burst can have multiple Workflow entities associated (when launching a range).

traits on this class:

tvb.core.entities.model.model_workflow.WorkflowStep[source]

Analyze/Simulate step inside a workflow. This type of step will generate an operation to be scheduled for execution.

  • step_index - the index of the step into the workflow;
  • fk_operation - the operation that resulted from this workflow step.

traits on this class:

tvb.core.entities.model.model_workflow.WorkflowStepView[source]

View Step inside a workflow.

  • portlet_id - the id of the portlet (or -1 if simulator or result measure);
  • ui_name - custom title given by the user when selecting a portlet.

traits on this class: