View source for Slicer3:Remote Data Handling

'''[[Slicer3:Developers#Slicer_3_Projects | Back to Slicer3 Projects List ]]'''

= Current TODO: =
* Finalizing performance profiling and optimizing performance
* detection of 'localhost' in uri should default to local file loading scheme
* XNE web-services client development
* Interfaces for data management:
** XND improvements that include slicer compatibility
** Qt-dcmtk interface and Qt SqlLite adaptor for Slicer Data Management
** Qt-based XNAT query/browse/retrieve widget

= XNAT-related Slicer projects =

== [[Image:Sketch.png]] [[Slicer3:UIDesign:WorkingProblems:SlicerInformatics:Draft1|Link to Fetch Medical Informatics (FetchMI) implementation 1 notes]]==

== [[Image:Sketch.png]] [[Slicer3:UIDesign:WorkingProblems:SlicerInformatics:Profiling_and_Refining|Link to Fetch Medical Informatics (FetchMI) and RemoteIO profiling/refining notes]]==

== [[Image:Sketch.png]] [http://www.na-mic.org/Wiki/index.php/CTSC_Ellen_Grant,_CHB  Link to CTSC Use-case: Grant & Pienaar at Children's Hospital Boston] ==

== [[Image:Sketch.png]] [http://www.na-mic.org/Wiki/index.php/CTSC_Brad_Dickerson,_MGH  Link to CTSC Use-case: Brad Dickerson at Mass General NMR] ==

== [[Image:Sketch.png]] [http://www.na-mic.org/Wiki/index.php/CTSC_Simon_Warfield,_CHB  Link to CTSC Use-case: Warfield & Weisen at Children's] ==

== [[Image:Sketch.png]] [http://www.na-mic.org/Wiki/index.php/CTSC_IGT,_BWH  Link to CTSC Use-case: Managing Image Guided Therapy (NCIGT) Restrospective Data at Brigham & Women's Hospital] ==

== [[Image:Sketch.png]] [http://www.na-mic.org/Wiki/index.php/CTSC_Slicer_XNE Link to FetchMI XNE extension planning (work with Curtis Lisle)] ==

= BIRN-related Presentations, Uses Cases and Pseudo Code =

* [[media:XCEDE-Use-Cases-2008-03-19.ppt | March 2008 mBIRN meeting, XCEDE use cases]]  
* [[media:XCEDE-Web-Services-2008-03-19.ppt | March 2008 mBIRN meeting, pseudo code for web services]] 
* [[media:Slicer3-RemoteIO-And-Informatics.ppt | April 2008 fBIRN meeting, Remote data handling architecture]]
* [[media:XCEDE-Use-Cases-2008-04-25-1.ppt | April 2008 fBIRN meeting, User-scenarios for web services and client tools discussion ]]

= Development history and notes =
== Slicer's original (local) data handling schematic==
Originally, MRML files, XCEDE catalog files, XNAT archives and individual datasets were only loadable from local disk, and remote datasets were downloaded (via web interface or command line) outside of Slicer. In the BIRN 2007 AHM we demonstrated downloading .xar files from a remote database, and loading .xar and .xcat files into Slicer from local disk using Slicer's XNAT archive reader and XCEDE2.0 catalog reader. This original scheme for data handling is shown below:

[[image:DataLoadingCurrent.png]]
=

= Goal for how Slicer would upload/download from remote data stores ==
Eventually, we would like to query web services, download data remotely or locally from the Application itself, and have the option of uplaoding to remote stores as well. A sketch of the architecture planned in a meeting (on 2/14/08 with Steve Pieper, Nicole Aucoin and Wendy Plesniak) is shown below, including: 
* a collection of vtkURIHandlers, 
* an (asynchronous) Data I/O Manager and 
* a Cache manager, 

all created by the main application and pointed to by the MRMLScene.:

[[image:DataLoadingTarget.png ]]

== Two general use cases used to drive a first pass implementation ==

* '''First''', is loading a combined FIPS/FreeSurfer analysis, specified in an Xcede catalog (.xcat) file that contains uris pointing to remote datasets, and view this with Slicer's QueryAtlas. (Prior to fBIRN AHM in 2008, it was not possible to get an .xcat via the HID web GUI; our approach was to manually upload a test Xcede catalog file and its constituent datasets to SRB. A copy of the .xcat file was kept locally, and SRB was accessed for each uri listed in it.)
* '''Second''', is running a batch job in Slicer that processes a set of remotely held datasets. Each iteration would take as arguments the XML file parameterizing the EMSegmenter, the uri for the remote dataset, and a uri for storing back the segmentation results. This use case has not yet been implemented. 
 
The schematic of the functionality we'll need is shown below:

[[image:DataLoadingStartPlan.png]]

== Current MRML, Logic and GUI Components ==
Slicer's Remote data handling architecture has been implemented to support remote download and upload of uris. Its components include a Cache Manager, a Data I/O Manager, and a URI Handler Collection in MRML; a Data I/O Manager Logic that engages the Application Logic's queueing and multi-threading mechanisms; and a Cache and Data I/O Manager GUI to provide feedback, information and control on the desktop. These components can also be configured through the Application Settings Interface, and these user preferences are saved in the Application Registry. Schematic and screenshots are shown below:

[[image:RemoteIO.png]]


[[image:S3CacheAndRemoteIOSettings.png ]]

[[image:S3CacheAndRemoteIOGUI.png ]]


= Test-case URIs: =

* [http://www.na-mic.org/Wiki/images/7/7b/RemoteTest.mrml RemoteTest.mrml] - points to [http://www.na-mic.org/Wiki/images/e/e1/CTHeadAxial.nrrd CTHeadAxial.nrrd] (the xml file is there, it may not render in your browser)
* [http://wiki.na-mic.org/Wiki/images/c/cd/RemoteTestVtk.mrml RemoteTestVtk.mrml] - points to [http://wiki.na-mic.org/Wiki/images/1/16/Aseg_17_Left-Hippocampus.vtk Aseg_17_Left-Hippocampus.vtk], [http://wiki.na-mic.org/Wiki/images/e/e4/Aseg_53_Right-Hippocampus.vtk Aseg_53_Right-Hippocampus.vtk]
* [http://wiki.na-mic.org/Wiki/images/7/70/RemoteTestMgzVtk.mrml RemoteTestMgzVtk.mrml] points to the above vtk files as well as [http://wiki.na-mic.org/Wiki/images/6/63/Aseg.mgz Aseg.mgz]
* [http://www.na-mic.org/Wiki/images/e/ec/RemoteTestColours.mrml RemoteTestColours.mrml] points to [http://wiki.na-mic.org/Wiki/images/6/63/Aseg.mgz Aseg.mgz] and the colour file [http://slicerl.bwh.harvard.edu/data/FSColorLabelsTest.ctbl FSColorLabelsTest.ctbl]
* [http://www.na-mic.org/Wiki/images/3/3d/RemoteTestMgzVtkPial.mrml RemoteTestMgzVtkPial.mrml] points to [http://wiki.na-mic.org/Wiki/images/6/63/Aseg.mgz Aseg.mgz], [http://wiki.na-mic.org/Wiki/images/e/e4/Aseg_53_Right-Hippocampus.vtk Aseg_53_Right-Hippocampus.vtk], and [http://slicerl.bwh.harvard.edu/data/lh.pial lh.pial]
* [http://www.na-mic.org/Wiki/images/3/37/RemoteTestSRBVtk.mrml RemoteTestSRBVtk.mrml] points to a file on the BIRN SRB [https://portal.nbirn.net/gridsphere/gridsphere?cid=srbfilebrowser&gs_action=downloadTheFile&Rpz_filename=%2Fhome%2Fnaucoin.harvard-bwh%2Faseg_17_left-hippocampus.vtk&up=Rpz /home/naucoin.harvard-bwh/aseg_17_left-hippocampus.vtk] (for now, requires that the uri string start with srb://) You must install and set up the SRB clients following the instructions [http://xwiki.nbirn.net:8080/xwiki/bin/view/BIRN%2Dsoftware/SRB+3_4_2+Clients here].
* [http://slicerl.bwh.harvard.edu/data/bert/RemoteBertSurfAndOverlays.mrml RemoteBertSurfAndOverlays.mrml] points to files on http://slicerl.bwh.harvard.edu/data, tests new overlay storage nodes'
* [http://slicerl.bwh.harvard.edu/data/fBIRN/fBIRN-AHM2007.xcat fBIRN-AHM2007.xcat] a sample xcat file pointing to files on http://slicerl.bwh.harvard.edu/data/fBIRN (must download manually)
* [http://slicerl.bwh.harvard.edu/data/fBIRN/BIRN-QA-XNAT.xcat BIRN-QA-XNAT.xcat] a sample xcat file pointing to files on host http://central.xnat.org 
* [http://wiki.na-mic.org/Wiki/images/a/ac/BIRN-QA-SRB.xcat BIRN-QA-SRB.xcat] points to files on the BIRN SRB [https://portal.nbirn.net/gridsphere/gridsphere?cid=srbfilebrowser&gs_action=downloadTheFile&Rpz_filename=%2Fhome%2Fnaucoin.harvard-bwh%2Faseg_17_left-hippocampus.vtk&up=Rpz /home/Public/FIPS-FreeSurfer-XCAT] (for now, requires that the uri string start with srb://) You must install and set up the SRB clients following the instructions [http://xwiki.nbirn.net:8080/xwiki/bin/view/BIRN%2Dsoftware/SRB+3_4_2+Clients here].
* [http://slicer.spl.harvard.edu/slicerWiki/images/e/ed/RemoteTwoFileVolumeSRB.mrml RemoteTwoFileVolumeSRB.mrml] Points to a two part volume on the SRB (a test label map, should see three colours): [https://portal.nbirn.net:443/gridsphere/gridsphere?cid=srbfilebrowser&gs_action=selectFile&tpm_filename=%2Fhome%2Fnaucoin.harvard-bwh%2Fsegvolume.hdr&up=tpm /home/naucoin.harvard-bwh/segvolume.hdr] and 
[https://portal.nbirn.net:443/gridsphere/gridsphere?cid=srbfilebrowser&gs_action=selectFile&up=OJ9&OJ9_filename=%2Fhome%2Fnaucoin.harvard-bwh%2Fsegvolume.img /home/naucoin.harvard-bwh/segvolume.img]

= XNAT questions =

* when we upload a file, can we get back a URI that includes ticket information? (we can use this to write a MRML file)
* can XNAT-generated uris end with the filename.extension, so that firefox will know to save them to disk, rather than to interpret them as html?

== Implementation: new classes ==
===MRML extensions===

'''MRML-specific implementations and extensions''' of the following classes:
* vtkDataIOManager 
* vtkMRMLStorageNode methods 
* vtkMRML<DataType>StorageNode methods 
* vtkPasswordPrompter 
* vtkDataTransfer 
* vtkCacheManager
* vtkURIHandler

===GUI extensions===

'''GUI implementations''' of the following classes:
* vtkSlicerDataTransferWidget
* vtkSlicerCacheAndDataIOManagerGUI 
* vtkSlicerPasswordPrompter

===Logic extensions===

* vtkDataIOManagerLogic

===Application Interface extensions===

* Set CacheDirectory ''default = Slicer3 temp dir''
* Set CacheFreeBufferSize ''default = 10Mb''
* Set CacheLimit ''default = 20Mb''
* Enable/Disable CacheOverwriting  ''default = true''
* Enable/Disable ForceRedownload ''default = false''
* Enable/Disable asynchronous I/O ''default = false''
* Instance & Register URI Handlers (?)

===Important Notes===

* MRML Scene file reading will always be synchronous.
* Read/write of individual datasets referenced in the scene should work with or without the asynchronous read/write turned on, and with or without the dataIOManager GUI interface.

== ITK-based mechanism handling remote data (for command line modules, batch processing, and grid processing) (Nicole) ==

This one is tenatively on hold for now.

== Workflows to support ==

The first goal is to figure out what workflows to support, and a good implementation approach.

Currently, '''Load Scene''', '''Import Scene''', and '''Add Data''' options in Slicer all encapsulate two steps: 
* locating a dataset, usually accomplished through a file browser, and
* selecting a dataset to initiate loading.
Then MRML files, Xcede catalog files, or individual datasets are loaded from local disk. 

For loading remote datasets, the following options are available:
* break these two steps apart explicitly (easiest option), 
* bind them together under the hood,
* or support both of these paradigms.

For now, we choose the first option.

===workflows:===

'''Possible workflow A'''
* User downloads .xcat or .xml (MRML) file to disk using the HID or an XNAT web interface
* From the Load Scene file browser, user selects the .xcat or .xml archive. If no locally cached versions exist, each remote file listed in the archive is downloaded to /tmp directory (always locally cached) by the Data I/O Manager, and then cached (local) uri is passed to vtkMRMLStorageNode method when download is complete.

'''Possible workflow B'''
* User downloads .xcat or .xml (MRML) file to disk using the HID or an XNAT web interface
* From the Load Scene file browser, user selects the .xcat or .xml archive. If no locally cached versions exist, each remote file in the archive is downloaded to /tmp (only if a flag is set) by the Data IO Manager, and loaded directly into Slicer via a vtkMRMLStorageNode method when download is complete. (How does load work if we don't save to disk first?)

'''Workflow C'''
* describe batch processing example here, which includes saving to local or remote.

In each workflow, the data gets saved to disk first and then loaded into StorageNode or uploaded to remote location from cache.

=== What data do we need in an .xcat file? ===
For the fBIRN QueryAtlas use case, we need a combination of '''FreeSurfer morphology analysis''' and a '''FIPS analysis''' of the same subject. With the combined data in Slicer, we can view activation overlays co-registered to and overlayed onto the high resolution structural MRI using the FIPS analysis, and determine the names of brain regions where activations occur using the co-registered morphology analysis.

The required analyses including all derived data are in two standard directory structures on local disk, and *hopefully* somewhere on the HID within a standard structure (check with Burak). These directory trees contain a LOT of files we don't need... Below are the files we *do* need for fBIRN QueryAtlas use case.

====FIPS analysis (.feat) directory and required data====
For instance, the FIPS output directory in our example dataset from Doug Greve at MGH is called sirp-hp65-stc-to7-gam.feat. Under this directory, QueryAtlas needs the following datasets:
* sirp-hp65-stc-to7-gam.feat/reg/example_func.nii
* sirp-hp65-stc-to7-gam.feat/reg/freesurfer/anat2exf.register.dat
* sirp-hp65-stc-to7-gam.feat/stats/(all statistics files of interest)
* sirp-hp65-stc-to7-gam.feat/design.gif (this image relates statistics files to experimental conditions)

====FreeSurfer analysis directory, and required data ====
For instance, the FreeSurfer morphology analysis directory in our example dataset from Doug Greve at MGH is called fbph2-000670986943. Under this directory, QueryAtlas needs the following datasets:

* fbph2-000670986943/mri/brain.mgz
* fbph2-000670986943/mri/aparc+aseg.mgz
* fbph2-000670986943/surf/lh.pial
* fbph2-000670986943/surf/rh.pial
* fbph2-000670986943/label/lh.aparc.annot
* fbph2-000670986943/label/rh.aparc.annot

== What do we want HID webservices to provide? ==

* Question: are FIPS and FreeSurfer analyses (including QueryAtlas required files listed above) for subjects available on the HID yet? --Burak says not yet.

* Given that, can we manually upload an example .xcat and the datasets it points to the SRB, and download each dataset from the HID in Slicer, using some helper application (like curl)?

* (Eventually.) The BIRN HID webservices shouldn't really need to know the subset of data that QueryAtlas needs... maybe the web interface can take a BIRN ID and create a FIPS/FreeSurfer xcede catalog with all uris (http://....) in the FIPS and FreeSurfer directories, and package these into an Xcede catalog. 

* (Eventually.) The catalog could be requested and downloaded from the HID web GUI, with a name like .xcat or .xcat.gzip or whatever. QueryAtlas could then open this file (or unzip and open) and filter for the relevant uris for an fBIRN or Qdec QueryAtlas session. 


* Then, for each uri in a catalog (or .xml MRML file), we'll use (curl?) to download; so we need all datasets to be publicly readable.

* Can we create a directory (even a temporary one) on the SRB/BWH HID for Slicer data uploads?

* We need some kind of upload service, a function call that takes a dataset and a BIRNID and uploads data to appropriate remote directory.

[[ Slicer3:XCEDE_use_cases | For more info, see this page for more discussion of QueryAtlas's current use of Xcede catalogs, and assumptions... ]]