Skip to content

Commit

Permalink
Merge pull request #1 from theo258/update-docs-skeleton-to-csgraph
Browse files Browse the repository at this point in the history
added doc remark for returning pixel_coordinates
  • Loading branch information
theo258 committed Sep 1, 2020
2 parents 81fff8b + 0f89589 commit 96dd851
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion skan/csr.py
Expand Up @@ -591,7 +591,9 @@ def skeleton_to_csgraph(skel, *, spacing=1, value_is_height=False,
adjacent ones.
pixel_coordinates : array of float
An array of shape (Nnz + 1, skel.ndim), mapping indices in `graph`
to pixel coordinates in `degree_image` or `skel`.
to pixel coordinates in `degree_image` or `skel`. Array entry
(0,:) contains currently always zeros to index the pixels, which
start at 1, directly to the coordinates.
degree_image : array of int, same shape as skel
An image where each pixel value contains the degree of its
corresponding node in `graph`. This is useful to classify nodes.
Expand Down

0 comments on commit 96dd851

Please sign in to comment.