Skip to main content

A package to view Nifti files in a BIDS dataset and generate QC plots.

Project description

PyPI Downloads

CPAC-QC Plotting App

CPAC-QC

Overview

The CPAC-qc Plotting App is a tool designed to generate quality control plots for the CPAC (Configurable Pipeline for the Analysis of Connectomes) outputs. This app helps in visualizing and assessing the quality of neuroimaging data processed through CPAC.

Features

  • Generate bulk or subject specific plots
  • Outputs PDF (default) and HTML report (with -html flag)

Requirements

  • BIDS dir with .nii.gz images in it.
  • (Optional) A html viewing tool or extension

Installation

pip install CPACqc

Usage

  1. Minimal code
cpacqc -d bids_dir

This will output a pdf report report.pdf in your current directory.

  1. HTML report
cpacqc -d bids_dir -html

This will create a pdf report.pdf along with a results dir with HTML report index.html and related files.

  1. Running single/multiple Subjects
cpacqc -d path/to/bids_dir -o path/to/output-qc-dir -s subject-id_1 subject-id_2

You can hand pick a singl or a few subjects with -s flag

  1. Running Single Subject with defined number of procs
cpacqc -d path/to/bids_dir -o path/to/output-qc-dir -s subject-id -n number-of-procs

Note: if -n is not provided default is 8

  1. Running all Subjects in the dir
cpacqc -d path/to/bids_dir -o path/to/output-qc-dir

or simply

cpacqc -d path/to/bids_dir
  1. Plotting Overlays
cpacqc -d path/to/bids_dir -o qc_dir -c ./overlay.csv

where overlay.csv can be in format

image_1,image_2
desc-preproc_bold, desc-preproc_T1w

and so on.

Viewing

Use any .html viewer extension to view index.html

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

cpacqc-0.2.6.tar.gz (31.1 kB view details)

Uploaded Source

Built Distribution

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

cpacqc-0.2.6-py3-none-any.whl (37.8 kB view details)

Uploaded Python 3

File details

Details for the file cpacqc-0.2.6.tar.gz.

File metadata

  • Download URL: cpacqc-0.2.6.tar.gz
  • Upload date:
  • Size: 31.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for cpacqc-0.2.6.tar.gz
Algorithm Hash digest
SHA256 ee763f274654f719f9e7c3314e7551b43deaa813226d9532b3494497dd2a092d
MD5 ed639da6eb3d72b117ba25600d509373
BLAKE2b-256 3ce31240ba362335502838bc36daadd6bdca174f9841bd4521845f2c78b01332

See more details on using hashes here.

File details

Details for the file cpacqc-0.2.6-py3-none-any.whl.

File metadata

  • Download URL: cpacqc-0.2.6-py3-none-any.whl
  • Upload date:
  • Size: 37.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for cpacqc-0.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 e6b7acbf96fa6b5d699e324289b29f350056e1656bc2387f423bd9e7c5f0c776
MD5 c6383c7d075061b0091cfe274a46737e
BLAKE2b-256 d36ca6188113dce9262b93e9f9aca417bae556c6ae26babf670c5315e97c6276

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