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

From Slicer Wiki
Jump to: navigation, search
(Moved to readthedocs)
Tags: 2017 source edit, Replaced
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<noinclude>{{documentation/versioncheck}}</noinclude>
+
<noinclude>{{documentation/versioncheck}}
{{ambox
+
</noinclude>
| type  = protection
 
| image = [[File:InProgress.png|40px|alt=Work in progress]]
 
| text  = WARNING: This module is Work in Progress, which means:
 
* the functionality provided by this module may change drastically in the future releases of 3D Slicer
 
* the scenes containing data types specific to this module may not be readable by the future versions of Slicer
 
* the functionality and user interface may change at any time
 
* some functionality may not work as intended
 
* testing and documentation is limited
 
}}
 
  
<!-- ---------------------------- -->
+
{{documentation/banner
{{documentation/{{documentation/version}}/module-header}}
+
| text  = [https://slicer.readthedocs.io/en/latest/user_guide/modules/multivolumeimporter.html This page has been moved to read-the-docs.]
<!-- ---------------------------- -->
+
| background-color = 8FBC8F }}
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}
 
{{documentation/{{documentation/version}}/module-introduction-start|{{documentation/modulename}}}}
 
{{documentation/{{documentation/version}}/module-introduction-row}}
 
This work is supported by NA-MIC, NAC, NCIGT, and the Slicer Community. This work is partially supported by the following grants: P41EB015898, P41RR019703, R01CA111288 and U01CA151261.<br>
 
Author: Andrey Fedorov, Jean-Cristophe Fillion Robin, Julien Finet, Steve Pieper, Ron Kikinis<br>
 
Contact: Andrey Fedorov <email>fedorov@bwh.harvard.edu</email> <br>
 
{{documentation/{{documentation/version}}/module-introduction-row}}
 
{{documentation/{{documentation/version}}/module-introduction-logo-gallery
 
|{{collaborator|logo|ncigt}}|{{collaborator|longname|ncigt}}
 
|{{collaborator|logo|namic}}|{{collaborator|longname|namic}}
 
|{{collaborator|logo|spl}}|{{collaborator|longname|spl}}
 
|{{collaborator|logo|kitware}}|{{collaborator|longname|kitware}}
 
|{{collaborator|logo|nac}}|{{collaborator|longname|nac}}
 
}}
 
{{documentation/{{documentation/version}}/module-introduction-end}}
 
 
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
 
 
 
This module provides support for importing multivolume (multiframe) data.
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Use Cases}}
 
Most frequently used for these scenarios:
 
* importing multiple frames defined in the same coordinate frame, saved as individual volumes in NRRD, NIfTI, or any other [[Documentation/{{documentation/version}}/SlicerApplication/SupportedDataFormat|image format supported by 3D Slicer]]
 
* for the multi-frame data stored in DICOM format, [[Documentation/{{documentation/version}}/Modules/DICOM|DICOM]] module should be used instead; the data should be automatically recognized while parsing the dataset in DICOM module.
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Tutorials}}
 
* Sample datasets are available:
 
** [[File:Cardiac_ECGg_CT.tgz]] (ECG-gated contrast-enhanced cardiac CT). Short [[media:BeatingHeart.mov|movie]]
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Panels and their use}}
 
 
 
{|style="width: 100%"
 
|
 
* '''Basic settings'''
 
** ''Input directory'': location of the input data as a collection of frames.
 
*** '''IMPORTANT''' If you use ''User-defined non-DICOM'' input data type, the frames will be sorted based on the alphanumerical order of the frame filenames. If you have more than 10 frames, you should name them as follows to make sure they are ordered correctly.
 
****<span style="color:#008000">'''Correct naming''': frame001.nrrd, frame002.nrrd, ..., frame023.nrrd, ..., frame912.nrrd</span>
 
****<span style="color:#8B0000">'''Incorrect naming''': frame1.nrrd, frame2.nrrd, ..., frame14.nrrd, ..., frame1045.nrrrd</span>.
 
*** The only files contained in the directory from which you are trying to import should be image volumes. The module will attempt to read each of these files!
 
** ''Output node'': MultiVolume node that will keep the loaded data. You need to create a new node or select and existing one when importing the data.
 
 
 
| align="right" |
 
|
 
[[Image:Slicer4-MultiVolumeImporter_panel-4.2.png|thumb|400px|Settings panel]]
 
|}
 
 
 
* '''Advanced settings''': contains elements that can be changed by the user. These items will be associated with the resulting multivolume, and will be available in case they are needed for the subsequent post-processing of the data (e.g., for pharmacokinetic modeling)
 
** ''DICOM tag'': in all modes, shows the DICOM tag that will be used to separate individual frames/volumes in the DICOM series. This field does not have meaning when the input data type is non-DICOM!
 
** ''Frame identifying units'': automatically populated for pre-defined tags. Needs to be defined for other input data types.
 
** ''Initial value'': values of the frame-identifying units for non-DICOM data type.
 
 
 
* '''Import''' button: once the panels are populated with the appropriate settings, hit this button to import the dataset into Slicer. Note that depending on the size of the data this operation can take significant time, so be patient!
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Related Modules}}
 
Once the multivolume dataset is loaded, it can be viewed and further explored using [[ Documentation/{{documentation/version}}/Modules/MultiVolumeExplorer‎|MultiVolumeExplorer]] module.
 
 
 
[[Documentation/Nightly/Modules/PkModeling]] extension can be used for pharmacokinetic analysis of the DCE MRI data.
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|References}}
 
* Development of this module was initiated at the 2012 NA-MIC Project week at SLC (see http://wiki.na-mic.org/Wiki/index.php/2012_Project_Week:4DImageSlicer4)
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
 
 
 
This module is an external Slicer module. The source code is available on Github here: https://github.com/fedorov/MultiVolumeImporter
 
 
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-footer}}
 
<!-- ---------------------------- -->
 

Latest revision as of 02:43, 14 November 2022

Home < Documentation < Nightly < Modules < MultiVolumeImporter