Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Develop #8

Merged
merged 13 commits into from
Oct 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,27 @@
[![codecov](https://codecov.io/gh/LOAMRI/asltk/graph/badge.svg?token=1W8GQ7SLU9)](https://codecov.io/gh/LOAMRI/asltk)
![CI_main](https://github.com/LOAMRI/asltk/actions/workflows/ci_main.yaml/badge.svg)
[![CI_develop](https://github.com/LOAMRI/asltk/actions/workflows/ci_develop.yaml/badge.svg)](https://github.com/LOAMRI/asltk/actions/workflows/ci_develop.yaml)
[![PyPI version](https://badge.fury.io/py/asltk.svg)](https://badge.fury.io/py/asltk)

# Arterial Spin Labeling Toolkit (asltk)

Welcome to the ASLtk project!
Welcome to the ASL toolkit!

This library was designed to assist users in processing Arterial Spin Labeling (ASL) MRI images, from basic imaging protocols to the state-of-the-art models provided in the scientific literature.

The major objective of this project is to give an open-source alternative to researchers in the MRI field. A profound knowledge of computing and data modelling is not a prior demand. It is expected that a simple set of Python commands can be helpful in fast prototyping an ASL experiment or even collecting simple quantitative ASL-based information.

Please read the [full documentation](https://asltk.readthedocs.io/en/main/) to get more details about the usage, implementation and updates in the `asltk` library.

Also, feel free to contribute directly to the project! Check it out the [issues](https://github.com/LOAMRI/asltk/issues) at the repository and get in touch to the developers of the project.

Access the [full documentation](https://asltk.readthedocs.io/en/main/) to check the usage and development of this tool.

## How to install

Requires Python 3.10 or higher:
A quick to use install is via `pip`, as follows:

> [!NOTE]
> The installation requires Python 3.10 or higher

```bash
pip install asltk
Expand Down
4 changes: 2 additions & 2 deletions asltk/asldata.py
Original file line number Diff line number Diff line change
Expand Up @@ -162,11 +162,11 @@ def set_te(self, te_values: list):
self._parameters['te'] = te_values

def get_dw(self):
"""Obtain the PLD array values"""
"""Obtain the Diffusion b values array"""
return self._parameters['dw']

def set_dw(self, dw_values: list):
"""Set the DW values.
"""Set the Diffusion b values.

The proper way to inform the values here is using a list of int or
float data. The total quantity of values depends on the image
Expand Down
Loading