.. AUTO-GENERATED FILE -- DO NOT EDIT!

interfaces.slicer.filtering.extractskeleton
===========================================


.. _nipype.interfaces.slicer.filtering.extractskeleton.ExtractSkeleton:


.. index:: ExtractSkeleton

ExtractSkeleton
---------------

`Link to code <file:///build/nipype-1.1.9/nipype/interfaces/slicer/filtering/extractskeleton.py#L39>`__

Wraps the executable command ``ExtractSkeleton ``.

title: Extract Skeleton

category: Filtering

description: Extract the skeleton of a binary object.  The skeleton can be limited to being a 1D curve or allowed to be a full 2D manifold.  The branches of the skeleton can be pruned so that only the maximal center skeleton is returned.

version: 0.1.0.$Revision: 2104 $(alpha)

documentation-url: http://wiki.slicer.org/slicerWiki/index.php/Documentation/4.1/Modules/ExtractSkeleton

contributor: Pierre Seroul (UNC), Martin Styner (UNC), Guido Gerig (UNC), Stephen Aylward (Kitware)

acknowledgements: The original implementation of this method was provided by ETH Zurich, Image Analysis Laboratory of Profs Olaf Kuebler, Gabor Szekely and Guido Gerig.  Martin Styner at UNC, Chapel Hill made enhancements.  Wrapping for Slicer was provided by Pierre Seroul and Stephen Aylward at Kitware, Inc.

Inputs::

        [Optional]
        InputImageFileName: (an existing file name)
                Input image
                argument: ``%s``, position: -2
        OutputImageFileName: (a boolean or a file name)
                Skeleton of the input image
                argument: ``%s``, position: -1
        type: ('1D' or '2D')
                Type of skeleton to create
                argument: ``--type %s``
        dontPrune: (a boolean)
                Return the full skeleton, not just the maximal skeleton
                argument: ``--dontPrune ``
        numPoints: (an integer (int or long))
                Number of points used to represent the skeleton
                argument: ``--numPoints %d``
        pointsFile: (a unicode string)
                Name of the file to store the coordinates of the central (1D)
                skeleton points
                argument: ``--pointsFile %s``
        args: (a unicode string)
                Additional parameters to the command
                argument: ``%s``
        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', nipype default value: {})
                Environment variables

Outputs::

        OutputImageFileName: (an existing file name)
                Skeleton of the input image
