Note
This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the user guide for the big picture.
meierlab.outliers.compute_outlier_nii#
- meierlab.outliers.compute_outlier_nii(nii_img, mask, mean, sd, thresh_above, thresh_below, upper_cap, lower_cap)[source]#
Helper function to compute an individual outlier image.
- Parameters:
- nii_imgimage (
Nifti1Imageor file name) Individual Nifti input file.
- maskimage (
Nifti1Imageor file name) A binary mask image to compute outliers within.
- meanimage (
Nifti1Imageor file name) Mean image of the dataset.
- sd :image (:class:`~nibabel.nifti1.Nifti1Image` or file name)
Standard deviation image of the dataset.
- thresh_aboveimage (
Nifti1Imageor file name) Image of data above the given threshold (usually 3 SD).
- thresh_belowimage (
Nifti1Imageor file name) Image of data below the given threshold (usually 3 SD).
- upper_capimage (
Nifti1Imageor file name) Image of data forming the upper limit.
- lower_capimage (
Nifti1Imageor file name) Image of data forming the lower limit.
- nii_imgimage (
- Returns:
Nifti1ImageReturns a Nifti image with outlier data.