surfaceskeleton.txt

.. _surfaceskeleton:

surfaceskeleton
***************


**Syntax:** :code:`surfaceskeleton(image, retain surfaces)`

Calculates skeleton of the foreground of the given image. Positive pixels are assumed to belong to the foreground. The skeleton may contain both lines and plates. This command is not guaranteed to give the same result in both normal and distributed processing mode. Despite that, both modes should give a valid result.

This command can be used in the distributed processing mode. Use :ref:`distribute` command to change processing mode from local to distributed.

Arguments
---------

image [input & output]
~~~~~~~~~~~~~~~~~~~~~~

**Data type:** uint8 image, uint16 image, uint32 image, uint64 image, int8 image, int16 image, int32 image, int64 image, float32 image

Image to process.

retain surfaces [input]
~~~~~~~~~~~~~~~~~~~~~~~

**Data type:** boolean

**Default value:** True

Set to false to allow thinning of surfaces to lines if the surface does not surround a cavity.

See also
--------

:ref:`surfacethin`, :ref:`surfaceskeleton`, :ref:`linethin`, :ref:`lineskeleton`, :ref:`tracelineskeleton`, :ref:`classifyskeleton`