Skip to main content

T1 PREProcessing Pipeline (aka PyCAT)

Project description

Python 3.9 | 3.10 | 3.11 | 3.12 License: Apache 2.0 Release

Note: This project is still in development and may contain bugs. Please report issues if you encounter problems.

T1Prep: T1 PREProcessing Pipeline (aka PyCAT)

T1Prep is a Python pipeline for preprocessing and segmenting T1-weighted MRI data. It supports:

  • Bias-field correction and denoising
  • Brain extraction (skull stripping)
  • Tissue segmentation (GM, WM, CSF)
  • Cortical surface reconstruction and thickness estimation
  • Non-linear spatial registration to MNI152 space
  • Atlas-based ROI extraction
  • White matter hyperintensity (WMH/lesion) detection
  • BIDS derivatives output naming

Cortical surface reconstruction uses the cat-surf Python package (pure Python bindings to the CAT-Surface C library — no compiled binaries required).

For full documentation, CLI usage, Docker instructions, and helper scripts see the GitHub repository.


Installation

pip install T1Prep

Download model weights

Model weights are not bundled in the wheel (they are ~500 MB). Download them after installation:

t1prep-download-models

Models are stored alongside the deepmriprep package data and are downloaded automatically on first pipeline use if this step is skipped.


Requirements

  • Python 3.9–3.12
  • ~2 GB disk space for model weights (downloaded separately, see above)
  • For GPU acceleration: CUDA-capable GPU or Apple Silicon (MPS)

Python API

from t1prep import run_t1prep

# Single file — results saved next to input
run_t1prep("/data/sub-01_T1w.nii.gz")

# Single file, BIDS-compatible output
run_t1prep("/data/sub-01/ses-1/anat/sub-01_ses-1_T1w.nii.gz", bids=True)

# Batch processing with options
run_t1prep(
    ["/data/T1/sub-01.nii.gz", "/data/T1/sub-02.nii.gz"],
    out_dir="/results",
    atlas=["neuromorphometrics", "suit"],
    multi=-1,          # auto-detect parallelism
    wp=True,           # save warped segmentations
    p=True,            # save native segmentations
    csf=True,          # save CSF segmentation
    lesions=True,      # save WMH lesion map
    gz=True,           # compress outputs (.nii.gz)
    stream_output=True,
    log_file="/results/T1Prep_run.log",
)

Key parameters

Parameter Type Description
files str or list[str] Input NIfTI file(s)
out_dir str Output directory (default: same as input)
atlas list[str] Atlas names for ROI extraction
surf bool Run cortical surface estimation (default: True)
multi int Parallel workers; -1 = auto (default: 1)
bids bool Use BIDS derivatives naming
gz bool Save compressed NIfTI (.nii.gz)
wp bool Save warped (MNI space) segmentations
p bool Save native space segmentations
csf bool Save CSF segmentation
lesions bool Save WMH/lesion map
amap bool Use AMAP segmentation (CAT12-style)
skullstrip_only bool Only run skull stripping then exit
skip_skullstrip bool Skip skull stripping (pre-stripped input)

Output structure

Non-BIDS (default): subfolders mri/, surf/, report/, label/ in the output directory, with CAT12-compatible filenames (e.g., mwp1sub-01.nii, lh.thickness.sub-01).

BIDS (with bids=True): BIDS derivatives layout <out_dir>/derivatives/T1Prep-v<version>/sub-XX/ses-YY/anat/.


License

Distributed under the Apache License 2.0.

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

t1prep-0.4.5.tar.gz (34.5 MB view details)

Uploaded Source

Built Distribution

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

t1prep-0.4.5-py3-none-any.whl (34.4 MB view details)

Uploaded Python 3

File details

Details for the file t1prep-0.4.5.tar.gz.

File metadata

  • Download URL: t1prep-0.4.5.tar.gz
  • Upload date:
  • Size: 34.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for t1prep-0.4.5.tar.gz
Algorithm Hash digest
SHA256 3ee00e18ec5a27e082e23378052a1bbd430963dbc651ca7dca6ca984db8d6c7a
MD5 8818e9aa9e25d46edbcaed6b3fcbc979
BLAKE2b-256 690273f11a3616bfa6f2abef80647000e7d707a499a0a989bb8df3c830860b3a

See more details on using hashes here.

Provenance

The following attestation bundles were made for t1prep-0.4.5.tar.gz:

Publisher: publish-pypi.yml on ChristianGaser/T1Prep

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file t1prep-0.4.5-py3-none-any.whl.

File metadata

  • Download URL: t1prep-0.4.5-py3-none-any.whl
  • Upload date:
  • Size: 34.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for t1prep-0.4.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c4ac4a6b00a6a62527b81bf65b700910dca849c6c4913bb27c0f8dca855138e4
MD5 fe49b8d868d99c550ff64dc73a0e64c3
BLAKE2b-256 91e7b35f73b269255d21bed9788e8833310e7d4eabce4ed8b07b4189f6924499

See more details on using hashes here.

Provenance

The following attestation bundles were made for t1prep-0.4.5-py3-none-any.whl:

Publisher: publish-pypi.yml on ChristianGaser/T1Prep

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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