From 4ec00fd61e6f25d67dd4a64e2ae6699d04442398 Mon Sep 17 00:00:00 2001 From: Niko Komin Date: Tue, 21 Jun 2016 11:57:22 +0200 Subject: [PATCH] Additional information in documentation. --- README.md | 8 ++++---- readme.txt | 6 +++--- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 409f4be..4293516 100644 --- a/README.md +++ b/README.md @@ -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: diff --git a/readme.txt b/readme.txt index 35c74c7..68daabf 100644 --- a/readme.txt +++ b/readme.txt @@ -2,7 +2,7 @@ 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: @@ -10,14 +10,14 @@ Usage: 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: