Difference between revisions of "Documentation/Nightly/Extensions/XNATSlicer"

From Slicer Wiki
Jump to: navigation, search
(Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887)
Line 3: Line 3:
 
{{documentation/{{documentation/version}}/module-header}}
 
{{documentation/{{documentation/version}}/module-header}}
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}
 
{{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}
 
{{documentation/{{documentation/version}}/module-introduction-start|{{documentation/modulename}}}}
 
{{documentation/{{documentation/version}}/module-introduction-start|{{documentation/modulename}}}}
 
{{documentation/{{documentation/version}}/module-introduction-row}}
 
{{documentation/{{documentation/version}}/module-introduction-row}}
[[File:XNATSlicer-Med.png]]<br>
+
[[File:XNATSlicer-MainIcon.png|center|700px]]<br>
 
Extension: [[Documentation/{{documentation/version}}/Extensions/XNATSlicer|XNATSlicer]]<br>
 
Extension: [[Documentation/{{documentation/version}}/Extensions/XNATSlicer|XNATSlicer]]<br>
 
Acknowledgments: TBD<br>
 
Acknowledgments: TBD<br>
Author: Sunil Kumar (Washington University in St. Louis)<br>
+
Author: Sunil Kumar (Moka Creative, LLC / Washington University in St. Louis)<br>
 
Contributors: Dan Marcus (Washington University in St. Louis), Steve Pieper ({{collaborator|name|spl}}) <br>
 
Contributors: Dan Marcus (Washington University in St. Louis), Steve Pieper ({{collaborator|name|spl}}) <br>
Contact: Sunil Kumar, <email>kumars@mir.wustl.edu</email><br>
+
Contact: Sunil Kumar, <email>sunilk@mokacreativellc.com</email><br>
 
{{documentation/{{documentation/version}}/module-introduction-row}}
 
{{documentation/{{documentation/version}}/module-introduction-row}}
 
{{documentation/{{documentation/version}}/module-introduction-logo-gallery
 
{{documentation/{{documentation/version}}/module-introduction-logo-gallery
Line 24: Line 23:
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
Secure GUI-based IO with any XNAT server.  Powered by PyXNAT.  Win64 for now.<br>
+
Secure GUI-based IO with any XNAT server.  For Slicer 4.3+<br>
  
 
   
 
   
Features:<br>
+
Features
*;Download and view
+
----
**Scans (individual or batch)
+
* Visualize XNAT hosted images in Slicer.
**Bundled Slicer scenes (*.mrb)
+
* Create, modify and save Slicer scenes directly from/to XNAT.
**Any Slicer-readable file
+
* Toggle and customize XNAT metadata.
 +
* Create new projects, subjects and experiments on the fly.
 +
* Search projects, subjects and experiments.
 +
* Fluid interaction between Slicer and XNAT.
 +
* Secure login and host management.
  
*;Upload
 
**Bundled Slicer scenes (*.mrb)
 
  
*;Other
 
**Project and folder creation
 
**File deletion 
 
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/module-section|Install Instructions}}
+
{{documentation/{{documentation/version}}/module-section|Use Cases}}
 +
{|
 +
Coming Soon!
 +
|}
  
 +
<!-- ---------------------------- -->
 +
{{documentation/{{documentation/version}}/module-section|Tutorials}}
  
<br><br><b>The only step needed is to make sure you have Read+Write permissions for your Slicer install directory.  (If you already do, you can proceed to the [[#First Login|First Login]] section.)</b><br><br><br>
 
 
<gallery widths=230px heights=230px perrow=4>
 
File:XNATSlicer-Perms1.jpg|1. Navigate to the directory where Slicer is installed (or the master-build directory if you are using the compiled version)
 
File:XNATSlicer-Perms2.jpg|2. Right click on the Slicer install folder and go to "Properties."
 
File:XNATSlicer-Perms3-4.jpg|3. Go to the "Security" Tab. Click on "Users" (or the equivalent group) under the "Groups or user names:" category.  Then click the "edit button".  A "Permissions" window will pop up.  In the "Permissions" window, select "Users" again and make sure "Allow" is checked for all options. Hit "OK."
 
File:XNATSlicer-Perms5.jpg|4. You should now see that Users have Read+Write access for the Slicer install folder.
 
</gallery>
 
You're all set.  Just load up the XNATSlicer module and click the "Login" button, and the module will install the additional libraries for you.  If you need a walkthrough, look [[#First Login|below]].<br>
 
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/module-section|First Login}}
+
{{documentation/{{documentation/version}}/module-section|Panels and their use}}
{|
 
|}
 
<gallery widths=230px heights=230px perrow=4>
 
File:XNATSlicer-LibInstall1.jpg|1. During your first login, the XNATSlicer module will install it's external libraries for you.  Just click the "Login" button.
 
File:XNATSlicer-LibInstall2.jpg|2. You'll be notified that the module will install external libraries.  Hit "OK."
 
File:XNATSlicer-LibInstall3.jpg|3. You'll be warned that you need full [[#Install Instructions|Read+Write]] access to your Slicer install directory.  Assuming you followed the [[#Install Instructions|instructions above]], hit "OK."
 
File:XNATSlicer-LibInstall4.jpg|4. A popup will appear telling you what libraries are being installed.
 
File:XNATSlicer-LibInstall5.jpg|5. You'll be asked to restart Slicer.  Afterwards, just log in to your XNAT host of choice and you're all set.  See the [[#Panels and their use|"Panels and their use"]] section.
 
</gallery>
 
  
  
<!-- ---------------------------- -->
+
<b>For Users</b>
{{documentation/{{documentation/version}}/module-section|Use Cases}}
 
 
{|
 
{|
 +
[[File:UserDesc_MainPanel.png|800px]]
 
|}
 
|}
  
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Tutorials}}
 
  
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Panels and their use}}
 
  
 +
<b>For Developers</b>
 
{|
 
{|
|[[Image:XNATSlicer-Panel.png|thumb|340px|XNATSlicer]]
+
[[File:DeveloperDesc_MainPanel.png|800px]]
|
 
* Secure login
 
* Status updater
 
* Project and file browser
 
** Traverse via tree
 
** Download/view
 
** Upload
 
** Create projects and folders
 
** Delete folders and files
 
 
|}
 
|}
  
Line 100: Line 73:
 
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
 
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
 
{{documentation/{{documentation/version}}/module-developerinfo}}
 
{{documentation/{{documentation/version}}/module-developerinfo}}
Source code: https://github.com/sunilk-wustl/XNATSlicer
+
Source code: https://github.com/skumar221/XNATSlicer
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->

Revision as of 19:12, 24 November 2013

Home < Documentation < Nightly < Extensions < XNATSlicer


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


Introduction and Acknowledgements

XNATSlicer-MainIcon.png

Extension: XNATSlicer
Acknowledgments: TBD
Author: Sunil Kumar (Moka Creative, LLC / Washington University in St. Louis)
Contributors: Dan Marcus (Washington University in St. Louis), Steve Pieper (SPL)
Contact: Sunil Kumar, <email>sunilk@mokacreativellc.com</email>

National Alliance for Medical Image Computing (NA-MIC)  
The Neuroinformatics Research Group - WUSTL  

Module Description

Secure GUI-based IO with any XNAT server. For Slicer 4.3+


Features


  • Visualize XNAT hosted images in Slicer.
  • Create, modify and save Slicer scenes directly from/to XNAT.
  • Toggle and customize XNAT metadata.
  • Create new projects, subjects and experiments on the fly.
  • Search projects, subjects and experiments.
  • Fluid interaction between Slicer and XNAT.
  • Secure login and host management.


Use Cases

Coming Soon!

Tutorials

Panels and their use

For Users

UserDesc MainPanel.png


For Developers

DeveloperDesc MainPanel.png

Similar Modules

References

Information for Developers


Source code: https://github.com/skumar221/XNATSlicer