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.

brainprep.interfaces.plot_defacing_mosaic

brainprep.interfaces.plot_defacing_mosaic(im_file, mask_file, output_dir, entities, dryrun=False)

Generates a defacing mosaic image by overlaying a mask on an anatomical image.

Parameters:

im_fileFile

Path to the anatomical image.

mask_fileFile

Path to the defacing mask.

output_dirDirectory

Directory where the mosaic image will be saved.

entitiesdict

A dictionary of parsed BIDS entities including modality.

dryrunbool

If True, skip actual computation and file writing. Default False.

Returns:

mosaic_fileFile

Path to the saved mosaic image.