cmind.pipeline.cmind_alpha

Functions

cmind_alpha(output_dir, alpha_complex_nii[, ...]) ASL labeling efficiency estimation
cmind.pipeline.cmind_alpha.cmind_alpha(output_dir, alpha_complex_nii, generate_figures=True, ForceUpdate=False, verbose=False, logger=None)[source]

ASL labeling efficiency estimation

Parameters:

output_dir : str

directory to store output

alpha_complex_nii : str

filename to the complex alpha .nii.gz volume

generate_figures : bool, optional

if true, generate additional summary images

ForceUpdate : bool,optional

if True, rerun and overwrite any previously existing results

verbose : bool, optional

print additional output (to terminal and log)

logger : logging.Logger or str, optional

logging.Logger object (or string of a filename to log to)

Returns:

alpha_fname : str

text file containing the computed alpha value

alpha : float

alpha value

Notes

primary output is myalpha.txt, containing the computed inversion efficiency

additional output:
alpha.mat alpha_avg_control.nii.gz alpha_avg_control_masked.nii.gz alpha_avg_sub.nii.gz alpha_avg_sub_masked.nii.gz alpha_avg_tag.nii.gz alpha_control_overlay.nii.gz alpha_control_overlay.png alpha_details.png alpha_map_masked.nii.gz alpha_sub_overlay.nii.gz cbar.png myalpha.txt myalpha_old.txt