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

PDF Report

PDF report example PDF report here: PDF REPORT

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.

Updates

  • Outputs only PDF report now.
  • Default config has overlays.
  • Images on PDF report will follow the order mentioned in overlay.csv provided or default.
  • Added Bookmarks on PDF report for easy navigation.

Features

  • Generate bulk or subject specific plots and reports.

Requirements

  • BIDS dir with .nii.gz images in it.
  • PDF viewer

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. Providing output dir
cpacqc -d bids_dir -o output_dir

output_dir will be created if not available. Make sure to have write permissions.

  1. Running single/multiple Subjects
cpacqc -d bids_dir -s subject-id_1 subject-id_2

You can hand pick a single or a multiple subjects with -s flag

  1. With defined number of procs
cpacqc -d bids_dir  -n number-of-procs

Note: if -n is not provided default is 8

  1. Providing custom Overlays config
cpacqc -d path/to/bids_dir -c ./overlay.csv

where overlay.csv can be in format

output,underlay,datatype
desc-preproc_bold,desc-preproc_T1w,func

and so on. If not provided a default config will be used.

Viewing

Use any PDF viewer to view *report.pdf file.

If -html enabled, Use any .html viewer extension to view index.html in the results dir.

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.12.tar.gz (28.8 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.12-py3-none-any.whl (37.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cpacqc-0.2.12.tar.gz
  • Upload date:
  • Size: 28.8 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.12.tar.gz
Algorithm Hash digest
SHA256 bb695182a1e81b91ca805eb823a0d8c863e38d4b2730dc47ecfc754f38557577
MD5 1da64c1109977890d3039c8a8862485e
BLAKE2b-256 e98387bc5ad7372669fb42eadf9c783ea521b89719d8471868f9506543b71e2a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cpacqc-0.2.12-py3-none-any.whl
  • Upload date:
  • Size: 37.0 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.12-py3-none-any.whl
Algorithm Hash digest
SHA256 a860da3dac829a48e2d69673511b20144bd09edb7182f73a6a0321d23281664f
MD5 9a915af28e06e27b69ae89b564037771
BLAKE2b-256 2e07041f0bdc9ff9becbf13e8cc5b48a4da2f2f015dd0adf3c3fcecd01544525

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