Skip to main content

A comprehensive toolkit for neuroimaging data processing and analysis

Project description

https://img.shields.io/pypi/v/clabtoolkit.svg https://github.com/connectomicslab/clabtoolkit/actions/workflows/ci.yml/badge.svg Documentation Status https://img.shields.io/pypi/pyversions/clabtoolkit.svg https://codecov.io/gh/connectomicslab/clabtoolkit/branch/main/graph/badge.svg

A comprehensive Python toolkit for neuroimaging data processing and analysis, specifically designed for working with brain connectivity data, BIDS datasets, and various neuroimaging formats.

Installation

Install from PyPI:

pip install clabtoolkit

For development installation:

git clone https://github.com/connectomicslab/clabtoolkit.git
cd clabtoolkit
pip install -e .[dev]

Features

BIDS Tools (clabtoolkit.bidstools)
  • BIDS dataset validation and manipulation

  • Entity extraction from BIDS filenames

  • Conversion between BIDS formats

  • Metadata handling for neuroimaging datasets

Connectivity Tools (clabtoolkit.connectivitytools)
  • Brain connectivity matrix analysis

  • Network-based statistics

  • Graph theory metrics computation

  • Connectivity visualization utilities

FreeSurfer Tools (clabtoolkit.freesurfertools)
  • FreeSurfer output parsing and processing

  • Surface-based analysis utilities

  • Cortical thickness and morphometry tools

  • Integration with FreeSurfer workflows

Image Processing Tools (clabtoolkit.imagetools)
  • Neuroimaging data I/O operations

  • Image registration and transformation

  • Quality control and preprocessing utilities

  • Multi-modal image processing

Parcellation Tools (clabtoolkit.parcellationtools)
  • Brain parcellation scheme handling

  • Region-of-interest (ROI) extraction

  • Atlas-based analysis tools

  • Custom parcellation creation

Surface Tools (clabtoolkit.surfacetools)
  • Surface mesh processing and analysis

  • Cortical surface manipulation

  • Surface-based statistics

  • Visualization of surface data

DWI Tools (clabtoolkit.dwitools)
  • Diffusion-weighted imaging analysis

  • Tractography processing utilities

  • DTI and advanced diffusion modeling

  • White matter analysis tools

Quality Control Tools (clabtoolkit.qcqatools)
  • Automated quality assessment

  • Image artifact detection

  • Quality metrics computation

  • Reporting and visualization

Visualization Tools (clabtoolkit.visualizationtools)
  • Brain visualization utilities

  • Interactive plotting capabilities

  • Publication-ready figures

  • Multi-modal data visualization

Quick Start

import clabtoolkit.bidstools as bids
import clabtoolkit.connectivitytools as conn

# Load BIDS configuration
config = bids.load_bids_json()

# Extract entities from BIDS filename
entities = bids.str2entity("sub-01_ses-M00_T1w.nii.gz")
print(entities)  # {'sub': '01', 'ses': 'M00', 'suffix': 'T1w', 'extension': 'nii.gz'}

# Process connectivity data
# conn_matrix = conn.load_connectivity_matrix("path/to/connectivity.mat")

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

  1. Fork the repository

  2. Create your feature branch (git checkout -b feature/amazing-feature)

  3. Commit your changes (git commit -m 'Add some amazing feature')

  4. Push to the branch (git push origin feature/amazing-feature)

  5. Open a Pull Request

Testing

Run tests with:

pytest

Run tests with coverage:

pytest --cov=clabtoolkit

Changelog

See HISTORY.rst for a detailed changelog.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

clabtoolkit-0.4.1.tar.gz (439.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

clabtoolkit-0.4.1-py3-none-any.whl (385.5 kB view details)

Uploaded Python 3

File details

Details for the file clabtoolkit-0.4.1.tar.gz.

File metadata

  • Download URL: clabtoolkit-0.4.1.tar.gz
  • Upload date:
  • Size: 439.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for clabtoolkit-0.4.1.tar.gz
Algorithm Hash digest
SHA256 12eea075d1ff25a5f5f1781dca13d24601345a1f3b007f99f6d953f6431e0e3e
MD5 0be14c87dc300813b5ba37543aab6186
BLAKE2b-256 b19428414da2db3aeb21d82eb55a2d896d13329615ff1444d1ce7b39dbb1063a

See more details on using hashes here.

File details

Details for the file clabtoolkit-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: clabtoolkit-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 385.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for clabtoolkit-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cc02bbbb98cc04789fb32538e0cf1b0947d10a69a25dd9a9d79e6ea3a41817e0
MD5 428fb409e2a0ae7447cbef371eab57d0
BLAKE2b-256 f8665bb04c42f93b15b3975c60d285bd758f0ac81dcadd4cdd899abaabbe3ea6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page