Difference between revisions of "Modules:EMSegmentBatch-Documentation-3.4"

From Slicer Wiki
Jump to: navigation, search
(Add Register Images BatchMake Module documentation)
 
(Add EMSegmentBatchMake module documentation)
Line 2: Line 2:
 
__NOTOC__
 
__NOTOC__
 
===Module Name===
 
===Module Name===
−
Register Images BatchMake
+
EM Segment BatchMake
 +
{|
 +
|[Image:RegisterImagesBatchMakeModule.png|thumb|580px|EM Segment BatchMake module GUI ]]
 +
|}
  
 
== General Information ==
 
== General Information ==
Line 12: Line 15:
  
 
===Authors, Collaborators & Contact===
 
===Authors, Collaborators & Contact===
−
* Authors: Julien Finet, Stephen Aylward
+
* Authors: Julien Finet, Brad Davis and Julien Jomier
 
* Contact: julien.finet at kitware.com
 
* Contact: julien.finet at kitware.com
  
 
===Module Description===
 
===Module Description===
−
This Module is the BatchMake version of [http://wiki.slicer.org/slicerWiki/index.php/Modules:RegisterImages-Documentation-3.4 Register Images module], an integrated framework providing access to ITK registration technologies. N moving images can be registered with a single fixed image on a computational grid. The moving images are the images filenames that match a mask in a directory.
+
This module is the BatchMake version of [http://wiki.slicer.org/slicerWiki/index.php/Modules:EMSegment-Simple-Documentation-3.4 EM Segment Simple], a simplified "one-click" GUI interface for the EMSegment Command-line Executable. The interface is simple because the number of required command-line parameters is minimized, and it is flexible because any EM algorithm parameter can be modified, within the MRML scene, via the EMSegment GUI interface.  
 +
The batch processing feature allows the user to run the EMSegment module on multiple patients. By defining a patient root directory and a mask to iterate through the patients, EMSegment simple will be run for each images found in the matched images.
  
 
== Usage ==
 
== Usage ==
−
Fixed Image = the fixed image <br>
+
MRML Scene = the mrml file name that contains all the parameters previously defined with EMSegment Template Builder module<br>
−
Moving Image Directory = the directory the moving images share with each others<br>
+
Data directory = where the patients images are ( T1, T2 images )
−
Moving Image Mask = a mask (concatenated to the Moving Image Directoy) that is used to select only the moving images. If the moving images are in sub directories, separate the sub directories with the '/' character.
+
Directory mask = to be a valid input, the patients directories located in "Data directory" must match the mask
−
Resampled Image Directory = the output directory where the registered images will be saved
+
Target 1 mask = T1 image mask that must be matched inside the patients directories
−
Resampled Image Mask = the name of the resampled images created by Register Images. To ensure uniqueness of the name, you can use the ${movingImage} BatchMake variable that contains the name of each moving image.
+
Target 2 mask = T2 image mask that must be matched inside the patients directories
−
 
+
Output directory = where the results are saved
−
For the other parameters, please see the [http://wiki.slicer.org/slicerWiki/index.php/Modules:RegisterImages-Documentation-3.4 Register Images module documentation].
 
  
 
===Examples, Use Cases & Tutorials===
 
===Examples, Use Cases & Tutorials===
Line 31: Line 34:
 
For the following file tree:<br>
 
For the following file tree:<br>
 
* Images
 
* Images
−
** Target.mha
+
** EMSegmentParameters.mrml
 +
** Atlas
 +
*** ...
 
** Patient1
 
** Patient1
−
*** 00001.txt
+
*** Patient1.txt
−
*** 00001.mha  
+
*** Patient1-T1.mha
 +
*** Patient1-T2.mha
 
** Patient2
 
** Patient2
−
*** 00001.txt
+
*** Patient2.txt
−
*** 00001.mha  
+
*** Patient2-T1.mha
 +
*** Patient2-T2.mha
 
** Patient3
 
** Patient3
−
*** 00001.txt
+
*** Patient3.txt
−
*** 00001.mha
+
*** Patient3-T1.mha
−
* Result
+
*** Patient3-T2.mha
−
Parameters could be:<br>
+
* Results
−
Fixed Image: "Images/Target.mha"<br>
+
Parameters are:<br>
−
Moving Image Directory: "Images"<br>
+
MRMLScene: "Images/EMSegmentParameters.mrml"<br>
−
Moving Image Mask: "Patient*/*.mha"<br>
+
Data Directory: "Images"<br>
−
Resampled Image Directory: "Result"<br>
+
Directory Mask: Patient*<br>
−
Resampled Image Mask: "Resampled-{movingImage}"<br>
+
Target 1 Mask: *T1.mha<br>
 +
Target 2 Mask: *T2.mha<br>
 +
Output directory: "Results"<br>
  
 
===Quick Tour of Features and Use===
 
===Quick Tour of Features and Use===
  
−
To run the module on a condor grid, open the BatchMake parameter group and choose "condor" as running mode. Set the Input, Output, Executable and Working directories.<br>
+
To run the module on a condor grid, open the BatchMake parameter group and choose "condor" as running mode. Make sure your data are accessible by all the condor machines.  
−
Input directory = Moving Image directory (probably on the network)<br>
 
−
Output directory = Resampled Image directory (probably on the network)<br>
 
−
Executable directory = directory where all your applications are: bmGridStore, bmGridSend, RegisterImages...). This directory shall be the same for all of your condor machines.<br>
 
−
Working directory = directory where the BatchMake and condor scripts will be written (probably on the network)<br>
 
  
 
== Development ==
 
== Development ==
Line 61: Line 66:
 
===Dependencies===
 
===Dependencies===
  
−
Register Images module
+
EMSegment Simple module
  
 
===Known bugs===
 
===Known bugs===
Line 73: Line 78:
 
===Source code & documentation===
 
===Source code & documentation===
  
−
Source Code: [http://www.na-mic.org/ViewVC/index.cgi/trunk/Applications/CLI/BatchMakeApplications/GenericBatchMakeModule/BatchMakeModule.cxx?view=annotate BatchMakeModule.cxx]
+
Source Code: [http://www.na-mic.org/ViewVC/index.cgi/trunk/Applications/CLI/BatchMakeApplications/EMSegmentBatchMakeModule/EMSegmentBatchMakeModule.cxx?view=annotate EMSegmentBatchMakeModule.cxx]
  
−
XML Description: [http://www.na-mic.org/ViewVC/index.cgi/trunk/Applications/CLI/BatchMakeApplications/RegisterImagesBatchMakeModule/RegisterImagesBatchMakeModule.xml?view=co RegisterImagesBatchMakeModule.xml]
+
XML Description: [http://www.na-mic.org/ViewVC/index.cgi/trunk/Applications/CLI/BatchMakeApplications/EMSegmentBatchMakeModule/EMSegmentBatchMakeModule.xml?view=co EMSegmentBatchMakeModule.xml]
  
 
Documentation:
 
Documentation:

Revision as of 17:57, 6 April 2009

Home < Modules:EMSegmentBatch-Documentation-3.4

Return to Slicer 3.4 Documentation

Module Name

EM Segment BatchMake

thumb|580px|EM Segment BatchMake module GUI ]]

General Information

Module Type & Category

Type: CLI

Category: Batch Processing

Authors, Collaborators & Contact

  • Authors: Julien Finet, Brad Davis and Julien Jomier
  • Contact: julien.finet at kitware.com

Module Description

This module is the BatchMake version of EM Segment Simple, a simplified "one-click" GUI interface for the EMSegment Command-line Executable. The interface is simple because the number of required command-line parameters is minimized, and it is flexible because any EM algorithm parameter can be modified, within the MRML scene, via the EMSegment GUI interface. The batch processing feature allows the user to run the EMSegment module on multiple patients. By defining a patient root directory and a mask to iterate through the patients, EMSegment simple will be run for each images found in the matched images.

Usage

MRML Scene = the mrml file name that contains all the parameters previously defined with EMSegment Template Builder module
Data directory = where the patients images are ( T1, T2 images ) Directory mask = to be a valid input, the patients directories located in "Data directory" must match the mask Target 1 mask = T1 image mask that must be matched inside the patients directories Target 2 mask = T2 image mask that must be matched inside the patients directories Output directory = where the results are saved

Examples, Use Cases & Tutorials

For the following file tree:

  • Images
    • EMSegmentParameters.mrml
    • Atlas
      • ...
    • Patient1
      • Patient1.txt
      • Patient1-T1.mha
      • Patient1-T2.mha
    • Patient2
      • Patient2.txt
      • Patient2-T1.mha
      • Patient2-T2.mha
    • Patient3
      • Patient3.txt
      • Patient3-T1.mha
      • Patient3-T2.mha
  • Results

Parameters are:
MRMLScene: "Images/EMSegmentParameters.mrml"
Data Directory: "Images"
Directory Mask: Patient*
Target 1 Mask: *T1.mha
Target 2 Mask: *T2.mha
Output directory: "Results"

Quick Tour of Features and Use

To run the module on a condor grid, open the BatchMake parameter group and choose "condor" as running mode. Make sure your data are accessible by all the condor machines.

Development

Dependencies

EMSegment Simple module

Known bugs

Follow this link to the Slicer3 bug tracker.

Usability issues

Follow this link to the Slicer3 bug tracker. Please select the usability issue category when browsing or contributing.

Source code & documentation

Source Code: EMSegmentBatchMakeModule.cxx

XML Description: EMSegmentBatchMakeModule.xml

Documentation:

More Information

Acknowledgment

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. Information on the National Centers for Biomedical Computing can be obtained from National Centers for Biomedical Computing.

References

Retrieved from "https://www.slicer.org/w/index.php?title=Modules:EMSegmentBatch-Documentation-3.4&oldid=8801"