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_sd_thresholds#
- meierlab.outliers.compute_sd_thresholds(mean, sd, threshold=3)[source]#
Helper function to create Nifti images that are a certain standard deviation above and below the mean, as determined by the given threshold (default 3).
- Parameters:
- meanimage (
Nifti1Imageor file name) Mean image of the dataset.
- sdimage (
Nifti1Imageor file name) Standard deviation image of the dataset.
- thresholdint, optional
Outlier threshold, by default 3.
- meanimage (
- Returns:
- tuple
thresh_above corresponding to the data <threshold> SD above the mean. thresh_below corresponding to the data <threshold> SD below the mean. upper_cap containing a Nifti-like image at the upper limit of data. lower_cap containing a Nifti-like image at the lower limit of data.