Python package for evaluating neuron segmentations in terms of the number of splits and merges
Project description
segmentation-skeleton-metrics
Python package for performing a skeleton-based evaluation of a predicted segmentation of neural arbors. This tool detects topological mistakes (i.e. splits and merges) in a predicted segmentation by comparing a set of ground truth skeletons to it. Once this comparison is complete, several statistics (e.g. edge accuracy, split count, merge count) are computed and returned in a dictionary.
Usage
Here is a simple example of evaluating a predicted segmentation. Note that this package supports a number of different input types, see documentation for details.
import os
from aind_segmentation_evaluation.evaluate import run_evaluation
from aind_segmentation_evaluation.conversions import volume_to_graph
from tifffile import imread
if __name__ == "__main__":
# Initializations
data_dir = "./resources"
target_graphs_dir = os.path.join(data_dir, "target_graphs")
path_to_target_labels = os.path.join(data_dir, "target_labels.tif")
pred_labels = imread(os.path.join(data_dir, "pred_labels.tif"))
pred_graphs = volume_to_graph(pred_labels)
# Evaluation
stats = run_evaluation(
target_graphs_dir,
path_to_target_labels,
pred_graphs,
pred_labels,
filetype="tif",
output="tif",
output_dir=data_dir,
permute=[2, 1, 0],
scale=[1.101, 1.101, 1.101],
)
# Write out results
print("Graph-based evaluation...")
for key in stats.keys():
print(" {}: {}".format(key, stats[key])
Installation
To use the software, in the root directory, run
pip install -e .
To develop the code, run
pip install -e .[dev]
To install this package from PyPI, run
pip install aind-segmentation-evaluation
Pull requests
For internal members, please create a branch. For external members, please fork the repository and open a pull request from the fork. We'll primarily use Angular style for commit messages. Roughly, they should follow the pattern:
<type>(<scope>): <short summary>
where scope (optional) describes the packages affected by the code changes and type (mandatory) is one of:
- build: Changes that affect build tools or external dependencies (example scopes: pyproject.toml, setup.py)
- ci: Changes to our CI configuration files and scripts (examples: .github/workflows/ci.yml)
- docs: Documentation only changes
- feat: A new feature
- fix: A bugfix
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature
- test: Adding missing tests or correcting existing tests
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for segmentation_skeleton_metrics-4.8.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 77142f3aaafdf6180f871e30e765906299ccfb3603d7e5c42e57383df4cfe6ee |
|
MD5 | 43764e3e741a59424c6f208103311727 |
|
BLAKE2b-256 | 71df9142b9637d16c7a211257692ae1a83d5a8b360b42e0f706cad81b5dc3e29 |
Hashes for segmentation_skeleton_metrics-4.8.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf82e5d7cce9087e0bfb4fbb7d92e6998473b6b533fbbb2234bde7acb443b3ba |
|
MD5 | 13abf1949dc9177e48eecb49d21b50a8 |
|
BLAKE2b-256 | 57635f0eda935bad5670781fcb004cabdea1b7642e2b303706c8177d4d6b280d |