Skip to main content

A comprehensive toolkit for neuroimaging data processing and analysis

Project description

clabtoolkit logo 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.4.tar.gz (5.2 MB 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.4-py3-none-any.whl (403.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: clabtoolkit-0.4.4.tar.gz
  • Upload date:
  • Size: 5.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for clabtoolkit-0.4.4.tar.gz
Algorithm Hash digest
SHA256 0b0ed17ddf6ed02127ad337554d1336fe34d46b797f71493afd4a610d65b48b0
MD5 79f8e5bcf06fb1ac7b9411ec1bf0c842
BLAKE2b-256 d6a73de8480cbb3d687e32be638e69ee7ffc0011951a50aa5f62babd6b420c84

See more details on using hashes here.

File details

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

File metadata

  • Download URL: clabtoolkit-0.4.4-py3-none-any.whl
  • Upload date:
  • Size: 403.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for clabtoolkit-0.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ab4abb10de32f3bb1cb2277c601c4295d0cb270e7bd7233412248f1f88628cdb
MD5 edc1dae1c05208562c2123820effe7c2
BLAKE2b-256 484d9eb36018b4a6b6ad6167917d7453e39c3b2ed8168ce30f5bad722166556f

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