Skip to content

Commit

Permalink
Additional information in documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Niko Komin committed Jun 21, 2016
1 parent 39f1255 commit 4ec00fd
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@

This function converts a 3D binary voxel skeleton into a network graph described by nodes and edges.

The input is a 3D binary image containing a one-dimensional voxel skeleton, generated e.g. using the "Skeleton3D" thinning function available on MFEX. The output is the adjacency matrix of the graph, and the nodes and links of the network as MATLAB structure.
The input is a 3D binary image containing a one-dimensional voxel skeleton, generated e.g. using the "Skeleton3D" thinning function available on MFEX. The output is the adjacency matrix of the graph, and the nodes and links of the network as MATLAB structure.

## Usage:

`[A,node,link] = Skel2Graph(skel,THR)`
`[A,node,link] = Skel2Graph(skel,THR)`

where "skel" is the input 3D binary image, and "THR" is a threshold for the minimum length of branches, to filter out skeletonization artifacts.

A is the adjacency matrix, and node/link are the structures describing node and link properties.
A is the adjacency matrix with the length of the links as matrix entries, and node/link are the structures describing node and link properties.

A node has the following properties:

- idx List of voxel indices of this node
- links List of links connected to this node
- conn List of destinations of links of this node
- comX,comY,comZ Center of mass of all voxels of this node
- comX,comY,comZ Center of mass of all voxels of this node
- ep 1 if node is endpoint (degree 1), 0 otherwise

A link has the following properties:
Expand Down
6 changes: 3 additions & 3 deletions readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@ Skel2Graph3D: calculate the network graph of a 3D skeleton

This function converts a 3D binary voxel skeleton into a network graph described by nodes and edges.

The input is a 3D binary image containing a one-dimensional voxel skeleton, generated e.g. using the "Skeleton3D" thinning function available on MFEX. The output is the adjacency matrix of the graph, and the nodes and links of the network as MATLAB structure.
The input is a 3D binary image containing a one-dimensional voxel skeleton, generated e.g. using the "Skeleton3D" thinning function available on MFEX. The output is the adjacency matrix of the graph, and the nodes and links of the network as MATLAB structure.

Usage:

[A,node,link] = Skel2Graph(skel,THR),

where "skel" is the input 3D binary image, and "THR" is a threshold for the minimum length of branches, to filter out skeletonization artifacts.

A is the adjacency matrix, and node/link are the structures describing node and link properties.
A is the adjacency matrix with the length of the links as matrix entries, and node/link are the structures describing node and link properties.

A node has the following properties:

- idx List of voxel indices of this node
- links List of links connected to this node
- conn List of destinations of links of this node
- comX,comY,comZ Center of mass of all voxels of this node
- comX,comY,comZ Center of mass of all voxels of this node
- ep 1 if node is endpoint (degree 1), 0 otherwise

A link has the following properties:
Expand Down

0 comments on commit 4ec00fd

Please # to comment.