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.applymask

brainprep.interfaces.applymask(image_file, mask_file, output_dir, entities)[source]

Apply an isotropic resampling transformation to a BIDS-compliant image file using FSL’s fslmaths.

Parameters:
image_fileFile

Path to the input image file.

mask_fileFile

Path to a binary mask file.

output_dirDirectory

Directory where the masked image will be saved.

entitiesdict

A dictionary of parsed BIDS entities including modality.

Returns:
commandlist[str]

Masking command-line.

outputstuple[File]
  • masked_image_file : File - masked input image file.