The Virtual Brain Project

Table Of Contents

Previous topic

help Package

Next topic

spatial Package

This Page

project Package

figure_controller

Controller class for managing Figures saved in TVB.

class tvb.interfaces.web.controllers.project.figure_controller.EditPreview(*args, **kw)[source]

Bases: formencode.schema.Schema

Validate edit action on Stored Preview

Messages

badDictType:
The input must be dict-like (not a %(type)s: %(value)r)
badType:
The input must be a string (not a %(type)s: %(value)r)
empty:
Please enter a value
missingValue:
Missing value
noneType:
The input must be a string (not None)
notExpected:
The input field %(name)s was not expected.
singleValueExpected:
Please provide only one value
chained_validators = []
declarative_count = 102
fields = {'session_name': <All [<UnicodeString object 100 inputEncoding='utf-8' not_empty=True outputEncoding='utf-8'>]>, 'name': <All [<UnicodeString object 98 inputEncoding='utf-8' not_empty=True outputEncoding='utf-8'>]>}
pre_validators = []
class tvb.interfaces.web.controllers.project.figure_controller.FigureController[source]

Bases: tvb.interfaces.web.controllers.project.project_controller.ProjectController

Resulting Figures are user-saved figures with specific visualizers or TVB pages which are considered important.

displayresultfigures(*a, **b)[source]

Collect and display saved previews, grouped by session.

displayzoomedimage(*a, **b)[source]

Displays the image with the specified id in an overlay dialog.

downloadimage(*a, **b)[source]

Allow a user to download a figure.

editresultfigures(*a, **b)[source]

This method knows how to handle the following actions: remove figure, update figure, remove session and update session.

storeresultfigure(*a, **b)[source]

Create preview for current displayed canvas and store image in current session, for future comparison.

project_controller

This file will handle Projects related part. This represents the Controller part (from MVC).

class tvb.interfaces.web.controllers.project.project_controller.EditForm(*args, **kw)[source]

Bases: formencode.schema.Schema

Validate creation of a Project entity.

Messages

badDictType:
The input must be dict-like (not a %(type)s: %(value)r)
badType:
The input must be a string (not a %(type)s: %(value)r)
empty:
Please enter a value
missingValue:
Missing value
noneType:
The input must be a string (not None)
notExpected:
The input field %(name)s was not expected.
singleValueExpected:
Please provide only one value
chained_validators = []
declarative_count = 97
fields = {'administrator': <UnicodeString object 94 inputEncoding='utf-8' not_empty=False outputEncoding='utf-8'>, 'users': <ForEach object 93 validators=[<Int object 92>]>, 'visited_pages': <UnicodeString object 96 inputEncoding='utf-8' not_empty=False outputEncoding='utf-8'>, 'name': <All [<UnicodeString object 88 inputEncoding='utf-8' not_empty=True outputEncoding='utf-8'>, <PlainText object 89 regex=<_sre.SRE_Pattern object at 0x7f9de6264920>>]>, 'project_id': <UnicodeString object 95 inputEncoding='utf-8' not_empty=False outputEncoding='utf-8'>, 'description': <UnicodeString object 91 inputEncoding='utf-8' outputEncoding='utf-8'>}
invalis_name_msg = 'Please enter a name composed only of letters, numbers and underscores.'
pre_validators = []
class tvb.interfaces.web.controllers.project.project_controller.ProjectController[source]

Bases: tvb.interfaces.web.controllers.base_controller.BaseController

Displays pages which deals with Project data management.

KEY_OPERATION_FILTERS = 'operationfilters'
PRROJECTS_LINKED_KEY = 'projectslinked'
create_json(*a, **b)[source]

Method used for creating a JSON representation of a graph.

Delegate the creation of the actual link to the flow service.

downloaddata(*a, **b)[source]

Export the data to a default path of TVB_STORAGE/PROJECTS/project_name

downloadproject(*a, **b)[source]

Export the data from a whole project.

editone(*a, **b)[source]

Create or change Project. When project_id is empty we create a new entity, otherwise we are to edit and existent one.

editstructure(*a, **b)[source]

Return the page skeleton for displaying the project structure.

fill_default_attributes(template_dictionary, subsection='project')[source]

Overwrite base controller to add required parameters for adapter templates.

generate_call_out_control(*a, **b)[source]

Returns the content of a confirmation dialog, with a given question.

get_data_uploader_overlay(*a, **b)[source]

Returns the html which displays a dialog which allows the user to upload certain data into the application.

get_datatype_details(*a, **b)[source]

Returns the HTML which contains the details for the given dataType. :param back_page: if different from ‘null’ (the default) it will redirect to it after saving metedata changes

get_linkable_projects(*a, **b)[source]

Returns the HTML which displays the link-able projects for the given dataType

get_operation_details(*a, **b)[source]

Returns the HTML which contains the details for the given operation.

get_project_structure_grouping()[source]
get_project_uploader_overlay(*a, **b)[source]

Returns the html which displays a dialog which allows the user to upload an entire project.

getmemberspage(*a, **b)[source]

Retrieve a new page of Project members.

index(*a, **b)[source]

Display project main-menu. Choose one project to work with.

launchloader(*a, **b)[source]

Start Upload mechanism

noderemove(*a, **b)[source]

AJAX exposed method, to execute operation of data removal.

projectupload(*a, **b)[source]

Upload Project from TVB ZIP.

readjsonstructure(*a, **b)[source]

AJAX exposed method. Will return the complete JSON for Project’s structure, or filtered tree (filter only Relevant entities or Burst only Data).

Delegate the creation of the actual link to the flow service.

set_project_structure_grouping(first, second)[source]
set_visibility(*a, **b)[source]

Method used for setting the relevancy/visibility on a DataType(Group)/Operation(Group.

show_confirmation_overlay(*a, **b)[source]

Returns the content of a confirmation dialog, with a given question.

updatemetadata(*a, **b)[source]

Submit MetaData edited for DataType(Group) or Operation(Group).

viewall(*a, **b)[source]

Display all existent projects. Choose one project to work with.

viewoperations(*a, **b)[source]

Display table of operations for a given project selected