compress_image

bidsaid.io.compress_image(nifti_file, dst_dir=None, remove_src_file=False, return_dst_file=False, compression_level=6)

Compresses a “.nii” image to a “.nii.gz” image.

Parameters

nifti_filestr or Path

Path to the NIfTI image.

dst_dirstr or Path, default=None

Destination directory for the NIfTI image. If None, image is saved in the source directory.

remove_src_filebool, default=False

Deletes the original source image file.

return_dst_filebool, default=False

Return the path to the compressed file.

compression_levelint, default=6

Level of compression from 0 to 9. Higher levels are slower but produce smaller file sizes.

Returns

Path or None

Path to compressed file if return_dst_file is True else None.