Difference between revisions of "Documentation/Nightly/Modules/DataStore"

From Slicer Wiki
Jump to: navigation, search
 
(24 intermediate revisions by 3 users not shown)
Line 4: Line 4:
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}
 
{{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}
Author: Charles Marion, Jean-Baptiste Berger and Jean-Christophe Fillion-Robin (Kitware)<br>
+
'''Author:''' Charles Marion, Jean-Baptiste Berger and Jean-Christophe Fillion-Robin (Kitware)<br>
Contact: Charles Marion, <email>charles.marion@kitware.com</email><br>
+
'''Contact:''' Charles Marion, <email>charles.marion@kitware.com</email><br>
Project website: http://slicer.kitware.com/midas3/slicerdatastore<br>
+
'''Project website:''' http://slicer.kitware.com/midas3/slicerdatastore<br>
License: [http://www.slicer.org/pages/LicenseText Slicer license]
+
'''License:''' [http://www.slicer.org/pages/LicenseText Slicer license]
  
 
The Slicer Data Store is hosted by Kitware using Midas Platform.  
 
The Slicer Data Store is hosted by Kitware using Midas Platform.  
Line 23: Line 23:
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/extension-section|Use Cases}}
+
{{documentation/{{documentation/version}}/extension-section|How To Use}}
 
==Download a dataset==
 
==Download a dataset==
<gallery widths="200px" perrow="4">
+
<gallery widths="250px" heights="250px" perrow="4">
Image:DownloadFile 1.jpg|The Data Store module appears under the Utilities category.
+
Image:DownloadFile 1.jpg|The Data Store module appears under the Utilities category. The module has three tabs: Local Datasets, Download Datasets and Upload Datasets
Image:DownloadFile_2.jpg|The module allows an user to browse the content of the database. To view the details of a dataset, click on the dataset's thumbnail.
+
Image:DownloadFile_2.jpg|The Download Dataset tab: This page allows a user to browse the .mrb files in the database. To see more information about the dataset, click on the dataset's thumbnail.
Image:DownloadFile_3.jpg|This page allows an user to rate, comment and download the dataset. Once downloaded, the dataset will automatically be opened in 3D Slicer's main view.
+
Image:DownloadFile_3.jpg|This page allows a user to review the Sceneviews that are inside the .mrb file. A viewer can rate, comment and download the dataset. Once downloaded, the dataset will automatically be opened in 3D Slicer's main view.
 
</gallery>
 
</gallery>
  
 
==Delete or load a cached file==
 
==Delete or load a cached file==
When you download a file from the remote database, the module will keep of a copy of the dataset.
+
When you download a dataset from the remote database, the module will keep of a copy of the Sceneviews.
<gallery widths="200px" perrow="4">
+
<gallery widths="250px" heights="250px" perrow="4">
 
Image:UploadFile_1.jpg|First of all, start the module
 
Image:UploadFile_1.jpg|First of all, start the module
 
Image:DeleteFile_2.jpg|Select the "Local datasets" tab.
 
Image:DeleteFile_2.jpg|Select the "Local datasets" tab.
Image:DeleteFile_3.jpg|This page lists all the datasets your previously downloaded. You can load them or delete the local copy.
+
Image:DeleteFile_3.jpg|This page lists all the Sceneviews your previously downloaded. You can load them or delete the local copy.
 
</gallery>
 
</gallery>
  
 
==Upload a dataset==
 
==Upload a dataset==
<gallery widths="200px" perrow="4">
+
In order to upload a dataset, you need a Slicer Midas account. (http://slicer.kitware.com/midas3).
Image:UploadFile_1.jpg|The module allows an user to upload the current opened dataset. To upload it, click on "Display Datastore"
+
You can create a new one directly from the module.
 +
 
 +
<gallery widths="250px" heights="250px" perrow="4">
 +
Image:UploadFile_1.jpg|The module allows an user to upload the current opened Sceneviews. To upload it, click on "Display Datastore"
 
Image:UploadFile_2.jpg|Select the Upload tab and log in. You can create a new account by clicking on "Register Here"
 
Image:UploadFile_2.jpg|Select the Upload tab and log in. You can create a new account by clicking on "Register Here"
Image:UploadFile_3.jpg|Define the Name and the Category of the dateset and click on "Start the  Upload".  
+
Image:UploadFile_3.jpg|Define the Name and the Category of the Sceneviews and click on "Start the  Upload".  
 
Image:UploadFile_4.jpg|The upload is complete.
 
Image:UploadFile_4.jpg|The upload is complete.
 
</gallery>
 
</gallery>
  
 
==Delete an uploaded dataset on the remote database==
 
==Delete an uploaded dataset on the remote database==
<gallery widths="200px" perrow="4">
+
<gallery widths="250px" heights="250px" perrow="4">
File:DeleteRemote_1.jpg|Go to the dataset"s page (see Download a dataset use case)".
+
File:DeleteRemote_1.jpg|Go to the Sceneviews' page (see Download a dataset use case)".
 
File:DeleteRemote_2.jpg|Authenticate using one of the "login" link
 
File:DeleteRemote_2.jpg|Authenticate using one of the "login" link
File:DeleteRemote_3.jpg|If you are the owner of the dataset, you will be able to click on "Delete the dataset".
+
File:DeleteRemote_3.jpg|If you are the owner of the Sceneviews, you will be able to click on "Delete the dataset".
 
</gallery>
 
</gallery>
  
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/extension-footer}}
+
{{documentation/{{documentation/version}}/module-footer}}
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->

Latest revision as of 19:56, 29 June 2016

Home < Documentation < Nightly < Modules < DataStore


For the latest Slicer documentation, visit the read-the-docs.


Introduction and Acknowledgements

Author: Charles Marion, Jean-Baptiste Berger and Jean-Christophe Fillion-Robin (Kitware)
Contact: Charles Marion, <email>charles.marion@kitware.com</email>
Project website: http://slicer.kitware.com/midas3/slicerdatastore
License: Slicer license

The Slicer Data Store is hosted by Kitware using Midas Platform.

This work was supported by NIH Grant 3P41RR013218-12S1, NA-MIC, NAC, and the Slicer community.

Extension Description

The Data Store extension allows an user to easily upload and download dataset files.

Highlights:

  • Browse and search datasets in a remote databae
  • Download, Review and comment the datasets
  • Upload new datasets

How To Use

Download a dataset

Delete or load a cached file

When you download a dataset from the remote database, the module will keep of a copy of the Sceneviews.

Upload a dataset

In order to upload a dataset, you need a Slicer Midas account. (http://slicer.kitware.com/midas3). You can create a new one directly from the module.

Delete an uploaded dataset on the remote database