Metadata-Version: 2.1
Name: utracto
Version: 0.0.7
Summary: Implementation of UTracto
Home-page: https://github.com/DelinteNicolas/UTracto
Author: Nicolas Delinte
Author-email: nicolas.delinte@uclouvain.be
License: GNU General Public License v3.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Description-Content-Type: text/markdown
License-File: LICENSE

# U-fiber tractography

Welcome to the UTracto's Github repository!

[![PyPI](https://img.shields.io/pypi/v/utracto?label=pypi%20package)](https://pypi.org/project/utracto/)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/utracto)](https://pypi.org/project/utracto/)
![GitHub repo size](https://img.shields.io/github/repo-size/DelinteNicolas/UTracto)

## Description

This repository contains a package facilitating the tracking of sub-cortical U-Fibers. The main function of this package is the creation of angular maps, enabling a tractography with a position-dependent maximum angle between tractography steps. The function creating these angular maps is `wmfod_to_angle` in the [`core.py`](https://github.com/DelinteNicolas/UTracto/blob/main/utracto/core.py) file.

<p align="center">
  <img src="https://user-images.githubusercontent.com/70629561/207111838-6ec3ba60-fd52-47ad-a469-17a29df74513.png" width="600" />
</p>

This angular map is to be used with a forked version of [DIPY](https://github.com/DelinteNicolas/dipy).

## Installing & importing

### Local install

If you want to download the latest version directly from GitHub, you can clone this repository
```
git clone https://github.com/DelinteNicolas/UTracto.git
```

## Example data and code

An example use of the main methods and outputs of UTracto is written in the `example.py` file. 
