icon

nifti-snapshot

nifti-snapshot is a tool to quickly capture nifti image as a png or jpeg figures.

$ pip install nifti_snapshot

For full documentation: Here

TBSS figures

From commandline

Snapshot of an `tbss_fill` image

fw=tbss_FW_tfce_corrp_tstat2_filled.nii.gz

./nifti_snapshot \
    --input ${fw} \
    --tbss \
    --output_file cli_test_fw.png \
    --cmap "Blues_r" \
    --title "Significant changes in FW in group A" \
    --cbar_title 'Increased FW'

output

Snapshot of two `tbss_fill` images with overlap highlight

fa=tbss_FA_tfce_corrp_tstat1_filled.nii.gz
fat=tbss_FAt_tfce_corrp_tstat1_filled.nii.gz

./nifti_snapshot \
    --input ${fa} ${fat} \
    --tbss \
    --output_file cli_test.png \
    --cmap "Blues_r" "autumn" \
    --title "Significant changes in FA and FAt in group A" \
    --cbar_title 'Reduced' 'Reduced FAt' 'Overlap' \
    --overlap \
    --overlap_cmap "summer" \
    --overlap_alpha 0.8

output

From python

Snapshot of an `tbss_fill` image

from nifti_snapshot import nifti_snapshot
fw = 'tbss_FA_tfce_corrp_tstat1_filled.nii.gz'
fw_color = 'Blues_r'

tbssFigure = nifti_snapshot.TbssFigure(
        image_files=[fw],
        output_file='docs/fw_example.png',
        cmap_list=[fw_color],
        cbar_titles=['Increased FW'],
        alpha_list=[0.8],
        title='Increased Freewater in group A',
        cbar_x=0.35, cbar_width=0.3)
tbssFigure.create_figure_one_map()

Snapshot of two `tbss_fill` images with overlap highlight

from nifti_snapshot import nifti_snapshot
fa = 'tbss_FA_tfce_corrp_tstat1_filled.nii.gz'
fat = 'tbss_FAt_tfce_corrp_tstat1_filled.nii.gz'

fa_color_1 = 'Blues_r'
fa_color_2 = 'autumn'
fa_color_overlap = 'summer'

tbssFigure = nifti_snapshot.TbssFigure(
    image_files=[fa, fat],
    output_file='docs/fa_fat_example.png',
    cmap_list=[fa_color_1, fa_color_2],
    overlap_cmap=fa_color_overlap,
    cbar_titles=[
        'Reduced FA',
        'Reduced FAt',
        'Overlap'],
    alpha_list=[1, 1, 0.8],
    title='Significant changes in FA and FAt in group A')
tbssFigure.create_figure_two_maps_and_overlap()

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nifti_snapshot-0.1.20.tar.gz (9.7 kB view details)

Uploaded Jun 27, 2023 Source

File details

Details for the file nifti_snapshot-0.1.20.tar.gz.

File metadata

Download URL: nifti_snapshot-0.1.20.tar.gz
Upload date: Jun 27, 2023
Size: 9.7 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.64.1 CPython/3.8.11

File hashes

Hashes for nifti_snapshot-0.1.20.tar.gz
Algorithm	Hash digest
SHA256	`f9e86d63b9cfcf7f5898a010e4ae6b53673d47124ac8bbe95fea87dbe3f145c4`
MD5	`da806854dc3d28b3b66576f7191e4aae`
BLAKE2b-256	`1894e81e1d14f4f034cbab8b7ee879c964384549f0c26724fc38708096974d3b`