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

From Slicer Wiki
Jump to: navigation, search
 
(17 intermediate revisions by 2 users not shown)
Line 14: Line 14:
 
'''Contributor1:''' Pat Marion ({{collaborator|name|kitware}})<br>
 
'''Contributor1:''' Pat Marion ({{collaborator|name|kitware}})<br>
 
'''Contributor2:''' Steve Pieper ({{collaborator|name|isomics}})<br>
 
'''Contributor2:''' Steve Pieper ({{collaborator|name|isomics}})<br>
 +
'''Contributor3:''' Atsushi Yamada (Shiga University of Medical Science)<br>
 
'''Contact:''' Jean-Christophe Fillion-Robin, <email>jchris.fillionr@kitware.com</email><br>
 
'''Contact:''' Jean-Christophe Fillion-Robin, <email>jchris.fillionr@kitware.com</email><br>
 
{{documentation/{{documentation/version}}/module-introduction-row}}
 
{{documentation/{{documentation/version}}/module-introduction-row}}
Line 19: Line 20:
 
|{{collaborator|logo|kitware}}|{{collaborator|longname|kitware}}
 
|{{collaborator|logo|kitware}}|{{collaborator|longname|kitware}}
 
|{{collaborator|logo|namic}}|{{collaborator|longname|isomics}}
 
|{{collaborator|logo|namic}}|{{collaborator|longname|isomics}}
 +
|Image:SumsLogo2014.jpg|Shiga University of Medical Science
 
}}
 
}}
  
Line 29: Line 31:
  
 
[http://www.kiwiviewer.org/ KiwiViewer] is a free, open-source visualization app for exploring scientific and medical datasets that runs on Android and iOS mobile devices with multi-touch interaction. [http://www.kiwiviewer.org/ KiwiViewer] supports a variety of file formats, including obj, stl, ply, and vtk. Datasets may be loaded into [http://www.kiwiviewer.org/ KiwiViewer] from the SD card, email attachments, or Midas, or DropBox, or downloaded from a URL.
 
[http://www.kiwiviewer.org/ KiwiViewer] is a free, open-source visualization app for exploring scientific and medical datasets that runs on Android and iOS mobile devices with multi-touch interaction. [http://www.kiwiviewer.org/ KiwiViewer] supports a variety of file formats, including obj, stl, ply, and vtk. Datasets may be loaded into [http://www.kiwiviewer.org/ KiwiViewer] from the SD card, email attachments, or Midas, or DropBox, or downloaded from a URL.
 +
 +
The following tutorials will provide steo-by-step instructions to:
 +
* [[#Saving_a_MRML_scene_as_KiwiViewer_scene_file|Export a Slicer MRML scene into KiwiViewer scene file]]
 +
* [[#Uploading_KiwiViewer_Scene_file_to_Midas|Upload the exported file onto a shared data source]]
 +
* [[#Loading_KiwiViewer_Scene_file_from_Midas|Load the exported file into KiwiViewer]]
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Use Cases}}
 
{{documentation/{{documentation/version}}/module-section|Use Cases}}
 +
 +
Interactively show an audience models created using slicer on an iPad.
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
Line 38: Line 47:
 
== Saving a MRML scene as KiwiViewer scene file ==
 
== Saving a MRML scene as KiwiViewer scene file ==
 
<gallery widths=450px perrow=2>
 
<gallery widths=450px perrow=2>
 +
File:SlicerToKiwiExporter-Slicer-install.png|Install extension named "SlicerToKiwiExporter". [[Documentation/{{documentation/version}}/SlicerApplication/ExtensionsManager#Installing_an_extension|Need help?]]
 
File:SlicerToKiwiExporter SaveDialog Select-file-format 1.png| (1) Open save dialog and (2) select <code>KiwiViewer File (*.kiwi.zip)</code> file format.
 
File:SlicerToKiwiExporter SaveDialog Select-file-format 1.png| (1) Open save dialog and (2) select <code>KiwiViewer File (*.kiwi.zip)</code> file format.
 
File:SlicerToKiwiExporter SaveDialog Select-dest-directory 2.png| (3 & 4) Choose destination directory
 
File:SlicerToKiwiExporter SaveDialog Select-dest-directory 2.png| (3 & 4) Choose destination directory
 
File:SlicerToKiwiExporter SaveDialog ClickSave 3.png| (5) Click on "Save" to export the MRML scene.
 
File:SlicerToKiwiExporter SaveDialog ClickSave 3.png| (5) Click on "Save" to export the MRML scene.
File:SlicerToKiwiExporter_CheckLog_4.png| Open error dialog (View -> Error Log) and check log. File has been exported to <code>/home/jchris/Desktop/MyKiwiFiles/nac-hncma-atlas2013-Slicer4Version.kiwi.zip</code>
+
File:SlicerToKiwiExporter_CheckLog_4.png| Open error dialog (View -> Error Log) and check log.  
 +
In this example, we can confirm that the MRML scene has been exported to <code>/home/jchris/Desktop/MyKiwiFiles/nac-hncma-atlas2013-Slicer4Version.kiwi.zip</code>
 
</gallery>
 
</gallery>
 
  
 
== Uploading KiwiViewer Scene file to Midas ==
 
== Uploading KiwiViewer Scene file to Midas ==
Line 63: Line 73:
 
</pre></li>
 
</pre></li>
  
</ol>
+
<li><p>Go to http://slicer.kitware.com, click on Communities (1) and select "NA-MIC" (2)</p>
 +
[[File:SlicerToKiwiExporter-UploadMidas SelectNAMIC Community.png|450px]]
 +
 
 +
<li><p>Browse, select the destination folder "Kiwiviewer" (3) and click on "Upload here" (4)</p>
 +
[[File:SlicerToKiwiExporter-UploadMidas Upload.png|450px]]
 +
</li>
 +
 
 +
<li><p>Select one or more files (5) and click "Upload" button (6)</p>
 +
[[File:SlicerToKiwiExporter-UploadMidas SelectFile-and-upload.png|450px]]
 +
</li>
  
 +
<li><p>Upload is complete</p>
 +
[[File:SlicerToKiwiExporter-UploadMidas complete.png|450px]]
 +
</li>
  
 +
</ol>
  
 
== Loading KiwiViewer Scene file from Midas ==
 
== Loading KiwiViewer Scene file from Midas ==
  
{{wip}}
+
<gallery widths=265px heights=350px perrow=4>
 +
File:SlicerToKiwiExporter Kiwiviewer 1.PNG|Tap on "Info" (1) and enter "http://slicer.kitware.com/midas3" for "Midas Host"
 +
File:SlicerToKiwiExporter Kiwiviewer 2.PNG|Tap on "Documents", then tap on "Midas" in the available Network Data Sources
 +
File:SlicerToKiwiExporter Kiwiviewer 3.PNG|Tap on "NA-MIC"
 +
File:SlicerToKiwiExporter Kiwiviewer 4.PNG|Tap on "Public"
 +
File:SlicerToKiwiExporter Kiwiviewer 5.PNG|Tap on "KiwiViewer"
 +
File:SlicerToKiwiExporter Kiwiviewer 6.PNG|Tap on KiwiViewer scene file to download and visualize.
 +
File:SlicerToKiwiExporter Kiwiviewer 7.PNG|Download in progress ...
 +
File:SlicerToKiwiExporter Kiwiviewer 8.PNG|Downloaded file is automatically loaded
 +
File:SlicerToKiwiExporter Kiwiviewer 9.PNG|Tap on "Settings" icon to see data properties
 +
</gallery>
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
Line 83: Line 116:
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
 
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
 +
 +
Source: https://github.com/jcfr/SlicerToKiwiExporter
 +
 
{{documentation/{{documentation/version}}/module-developerinfo}}
 
{{documentation/{{documentation/version}}/module-developerinfo}}
  

Latest revision as of 00:57, 2 April 2015

Home < Documentation < Nightly < Modules < SlicerToKiwiExporter


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


Introduction and Acknowledgements

Extension: SlicerToKiwiExporter
Acknowledgments: This work is part of the National Alliance for Medical Image Computing (NAMIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149.
Author: Jean-Christophe Fillion-Robin (Kitware)
Contributor1: Pat Marion (Kitware)
Contributor2: Steve Pieper (Isomics, Inc.)
Contributor3: Atsushi Yamada (Shiga University of Medical Science)
Contact: Jean-Christophe Fillion-Robin, <email>jchris.fillionr@kitware.com</email>

Kitware, Inc.  
Isomics, Inc.  
Shiga University of Medical Science  

Module Description

The SlicerToKiwiExporter module provides Slicer user with any easy way to export models into a KiwiViewer scene file.

KiwiViewer is a free, open-source visualization app for exploring scientific and medical datasets that runs on Android and iOS mobile devices with multi-touch interaction. KiwiViewer supports a variety of file formats, including obj, stl, ply, and vtk. Datasets may be loaded into KiwiViewer from the SD card, email attachments, or Midas, or DropBox, or downloaded from a URL.

The following tutorials will provide steo-by-step instructions to:

Use Cases

Interactively show an audience models created using slicer on an iPad.

Tutorials

Saving a MRML scene as KiwiViewer scene file

Uploading KiwiViewer Scene file to Midas

  1. Create an account on the extension server: http://slicer.kitware.com by clicking on the Register link in the top right corner

  2. Slicer-midas-extensions-server-registration.png

    This image shows the top portion of http://slicer.kitware.com after it has been expanded by clicking the Register button.

  3. Go to NA-MIC community and click on Join community

  4. If not already done, send an email on the slicer users list asking to be granted write permission on the KiwiViewer folder.

    To: slicer-user@bwh.harvard.edu
    Subject: Asking permission to write to the KiwiViewer folder
    Hi, 
    
    I am user KiwiView application to [...]
    
    Could you grant user YourUserName write access to the KiwiViewer folder ?
    
    
  5. Go to http://slicer.kitware.com, click on Communities (1) and select "NA-MIC" (2)

    SlicerToKiwiExporter-UploadMidas SelectNAMIC Community.png

  6. Browse, select the destination folder "Kiwiviewer" (3) and click on "Upload here" (4)

    SlicerToKiwiExporter-UploadMidas Upload.png

  7. Select one or more files (5) and click "Upload" button (6)

    SlicerToKiwiExporter-UploadMidas SelectFile-and-upload.png

  8. Upload is complete

    SlicerToKiwiExporter-UploadMidas complete.png

Loading KiwiViewer Scene file from Midas

Panels and their use

Similar Modules

References

Information for Developers

Source: https://github.com/jcfr/SlicerToKiwiExporter