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.5.tar.gz (30.3 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.5-py3-none-any.whl (36.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cpacqc-0.2.5.tar.gz
  • Upload date:
  • Size: 30.3 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.5.tar.gz
Algorithm Hash digest
SHA256 362fd7b53d26057ae5b592adc67a1f5742b3c845db7d7a98251a1ed5b19fb449
MD5 16b84f0417cc195443c33a857974ffe4
BLAKE2b-256 0ccc4e6bc62b9bab86d026f77cc2cb46fc570cb403f16207518abe700de86271

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cpacqc-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 36.9 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 ad13062380175923f305bc07376b4c5da922fc1de4f5384e9969a67cafbc0f52
MD5 b5ac3f40f92c9cb83419406e73ad58d4
BLAKE2b-256 5a3140f6c74e006e9dcbf24eb4804123809a3d9f51e69d9fe2a03e49e587d1aa

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