nipype.interfaces.slicer.segmentation.specialized module¶
Autogenerated file - DO NOT EDIT If you spot a bug, please report it on the mailing list and/or change the generator.
BRAINSROIAuto¶
Bases: SEMLikeCommandLine
Wrapped executable:
BRAINSROIAuto.title: Foreground masking (BRAINS)
category: Segmentation.Specialized
description: This tool uses a combination of otsu thresholding and a closing operations to identify the most prominent foreground region in an image.
version: 2.4.1
license: https://www.nitrc.org/svn/brains/BuildScripts/trunk/License.txt
contributor: Hans J. Johnson, hans-johnson -at- uiowa.edu, http://wwww.psychiatry.uiowa.edu
acknowledgements: Hans Johnson(1,3,4); Kent Williams(1); Gregory Harris(1), Vincent Magnotta(1,2,3); Andriy Fedorov(5), fedorov -at- bwh.harvard.edu (Slicer integration); (1=University of Iowa Department of Psychiatry, 2=University of Iowa Department of Radiology, 3=University of Iowa Department of Biomedical Engineering, 4=University of Iowa Department of Electrical and Computer Engineering, 5=Surgical Planning Lab, Harvard)
- Optional Inputs:
ROIAutoDilateSize (a float) – This flag is only relevant when using ROIAUTO mode for initializing masks. It defines the final dilation size to capture a bit of background outside the tissue region. At setting of 10mm has been shown to help regularize a BSpline registration type so that there is some background constraints to match the edges of the head better. Maps to a command-line argument:
--ROIAutoDilateSize %f.args (a string) – Additional parameters to the command. Maps to a command-line argument:
%s.closingSize (a float) – The Closing Size (in millimeters) for largest connected filled mask. This value is divided by image spacing and rounded to the next largest voxel number. Maps to a command-line argument:
--closingSize %f.environ (a dictionary with keys which are a bytes or None or a value of class ‘str’ and with values which are a bytes or None or a value of class ‘str’) – Environment variables. (Nipype default value:
{})inputVolume (a pathlike object or string representing an existing file) – The input image for finding the largest region filled mask. Maps to a command-line argument:
--inputVolume %s.numberOfThreads (an integer) – Explicitly specify the maximum number of threads to use. Maps to a command-line argument:
--numberOfThreads %d.otsuPercentileThreshold (a float) – Parameter to the Otsu threshold algorithm. Maps to a command-line argument:
--otsuPercentileThreshold %f.outputClippedVolumeROI (a boolean or a pathlike object or string representing a file) – The inputVolume clipped to the region of the brain mask. Maps to a command-line argument:
--outputClippedVolumeROI %s.outputROIMaskVolume (a boolean or a pathlike object or string representing a file) – The ROI automatically found from the input image. Maps to a command-line argument:
--outputROIMaskVolume %s.outputVolumePixelType (‘float’ or ‘short’ or ‘ushort’ or ‘int’ or ‘uint’ or ‘uchar’) – The output image Pixel Type is the scalar datatype for representation of the Output Volume. Maps to a command-line argument:
--outputVolumePixelType %s.thresholdCorrectionFactor (a float) – A factor to scale the Otsu algorithm’s result threshold, in case clipping mangles the image. Maps to a command-line argument:
--thresholdCorrectionFactor %f.- Outputs:
outputClippedVolumeROI (a pathlike object or string representing an existing file) – The inputVolume clipped to the region of the brain mask.
outputROIMaskVolume (a pathlike object or string representing an existing file) – The ROI automatically found from the input image.
EMSegmentCommandLine¶
Bases: SEMLikeCommandLine
Wrapped executable:
EMSegmentCommandLine.
- title:
EMSegment Command-line
- category:
Segmentation.Specialized
- description:
This module is used to simplify the process of segmenting large collections of images by providing a command line interface to the EMSegment algorithm for script and batch processing.
documentation-url: http://www.slicer.org/slicerWiki/index.php/Documentation/4.0/EMSegment_Command-line
contributor: Sebastien Barre, Brad Davis, Kilian Pohl, Polina Golland, Yumin Yuan, Daniel Haehn
acknowledgements: Many people and organizations have contributed to the funding, design, and development of the EMSegment algorithm and its various implementations.
- Optional Inputs:
args (a string) – Additional parameters to the command. Maps to a command-line argument:
%s.atlasVolumeFileNames (a list of items which are a pathlike object or string representing an existing file) – Use an alternative atlas to the one that is specified by the mrml file - note the order matters ! . Maps to a command-line argument:
--atlasVolumeFileNames %s....disableCompression (a boolean) – Don’t use compression when writing result image to disk. Maps to a command-line argument:
--disableCompression.disableMultithreading (an integer) – Disable multithreading for the EMSegmenter algorithm only! Preprocessing might still run in multi-threaded mode. -1: Do not overwrite default value. 0: Disable. 1: Enable. Maps to a command-line argument:
--disableMultithreading %d.dontUpdateIntermediateData (an integer) – Disable update of intermediate results. -1: Do not overwrite default value. 0: Disable. 1: Enable. Maps to a command-line argument:
--dontUpdateIntermediateData %d.dontWriteResults (a boolean) – Used for testing. Don’t actually write the resulting labelmap to disk. Maps to a command-line argument:
--dontWriteResults.environ (a dictionary with keys which are a bytes or None or a value of class ‘str’ and with values which are a bytes or None or a value of class ‘str’) – Environment variables. (Nipype default value:
{})generateEmptyMRMLSceneAndQuit (a boolean or a pathlike object or string representing a file) – Used for testing. Only write a scene with default mrml parameters. Maps to a command-line argument:
--generateEmptyMRMLSceneAndQuit %s.intermediateResultsDirectory (a pathlike object or string representing an existing directory) – Directory where EMSegmenter will write intermediate data (e.g., aligned atlas data). Maps to a command-line argument:
--intermediateResultsDirectory %s.keepTempFiles (a boolean) – If flag is set then at the end of command the temporary files are not removed. Maps to a command-line argument:
--keepTempFiles.loadAtlasNonCentered (a boolean) – Read atlas files non-centered. Maps to a command-line argument:
--loadAtlasNonCentered.loadTargetCentered (a boolean) – Read target files centered. Maps to a command-line argument:
--loadTargetCentered.mrmlSceneFileName (a pathlike object or string representing an existing file) – Active MRML scene that contains EMSegment algorithm parameters. Maps to a command-line argument:
--mrmlSceneFileName %s.parametersMRMLNodeName (a string) – The name of the EMSegment parameters node within the active MRML scene. Leave blank for default. Maps to a command-line argument:
--parametersMRMLNodeName %s.registrationAffineType (an integer) – Specify the accuracy of the affine registration. -2: Do not overwrite default, -1: Test, 0: Disable, 1: Fast, 2: Accurate. Maps to a command-line argument:
--registrationAffineType %d.registrationDeformableType (an integer) – Specify the accuracy of the deformable registration. -2: Do not overwrite default, -1: Test, 0: Disable, 1: Fast, 2: Accurate. Maps to a command-line argument:
--registrationDeformableType %d.registrationPackage (a string) – Specify the registration package for preprocessing (CMTK or BRAINS or PLASTIMATCH or DEMONS). Maps to a command-line argument:
--registrationPackage %s.resultMRMLSceneFileName (a boolean or a pathlike object or string representing a file) – Write out the MRML scene after command line substitutions have been made. Maps to a command-line argument:
--resultMRMLSceneFileName %s.resultStandardVolumeFileName (a pathlike object or string representing an existing file) – Used for testing. Compare segmentation results to this image and return EXIT_FAILURE if they do not match. Maps to a command-line argument:
--resultStandardVolumeFileName %s.resultVolumeFileName (a boolean or a pathlike object or string representing a file) – The file name that the segmentation result volume will be written to. Maps to a command-line argument:
--resultVolumeFileName %s.targetVolumeFileNames (a list of items which are a pathlike object or string representing an existing file) – File names of target volumes (to be segmented). The number of target images must be equal to the number of target images specified in the parameter set, and these images must be spatially aligned. Maps to a command-line argument:
--targetVolumeFileNames %s....taskPreProcessingSetting (a string) – Specifies the different task parameter. Leave blank for default. Maps to a command-line argument:
--taskPreProcessingSetting %s.verbose (a boolean) – Enable verbose output. Maps to a command-line argument:
--verbose.- Outputs:
generateEmptyMRMLSceneAndQuit (a pathlike object or string representing an existing file) – Used for testing. Only write a scene with default mrml parameters.
resultMRMLSceneFileName (a pathlike object or string representing an existing file) – Write out the MRML scene after command line substitutions have been made.
resultVolumeFileName (a pathlike object or string representing an existing file) – The file name that the segmentation result volume will be written to.
RobustStatisticsSegmenter¶
Bases: SEMLikeCommandLine
Wrapped executable:
RobustStatisticsSegmenter.title: Robust Statistics Segmenter
category: Segmentation.Specialized
description: Active contour segmentation using robust statistic.
version: 1.0
documentation-url: http://wiki.slicer.org/slicerWiki/index.php/Documentation/4.1/Modules/RobustStatisticsSegmenter
contributor: Yi Gao (gatech), Allen Tannenbaum (gatech), Ron Kikinis (SPL, BWH)
acknowledgements: This work is part of the National Alliance for Medical Image Computing (NAMIC), funded by the National Institutes of Health
- Optional Inputs:
args (a string) – Additional parameters to the command. Maps to a command-line argument:
%s.curvatureWeight (a float) – Given sphere 1.0 score and extreme rough boundary/surface 0 score, what is the expected smoothness of the object?. Maps to a command-line argument:
--curvatureWeight %f.environ (a dictionary with keys which are a bytes or None or a value of class ‘str’ and with values which are a bytes or None or a value of class ‘str’) – Environment variables. (Nipype default value:
{})expectedVolume (a float) – The approximate volume of the object, in mL. Maps to a command-line argument:
--expectedVolume %f.intensityHomogeneity (a float) – What is the homogeneity of intensity within the object? Given constant intensity at 1.0 score and extreme fluctuating intensity at 0. Maps to a command-line argument:
--intensityHomogeneity %f.labelImageFileName (a pathlike object or string representing an existing file) – Label image for initialization. Maps to a command-line argument:
%s(position: -2).labelValue (an integer) – Label value of the output image. Maps to a command-line argument:
--labelValue %d.maxRunningTime (a float) – The program will stop if this time is reached. Maps to a command-line argument:
--maxRunningTime %f.originalImageFileName (a pathlike object or string representing an existing file) – Original image to be segmented. Maps to a command-line argument:
%s(position: -3).segmentedImageFileName (a boolean or a pathlike object or string representing a file) – Segmented image. Maps to a command-line argument:
%s(position: -1).- Outputs:
segmentedImageFileName (a pathlike object or string representing an existing file) – Segmented image.