intensity_propagation

nighres.intensity.intensity_propagation(image, mask=None, combine='mean', distance_mm=5.0, target='zero', scaling=1.0, save_data=False, overwrite=False, output_dir=None, file_name=None)[source]

Intensity Propogation

Propagates the values inside the mask (or non-zero) into the neighboring voxels

Parameters:
  • image (niimg) – Input image
  • mask (niimg, optional) – Data mask to specify acceptable seeding regions
  • combine ({'min','mean','max'}, optional) – Propagate using the mean (default), max or min data from neighboring voxels
  • distance_mm (float, optional) – Distance for the propagation (note: this algorithm will be slow for large distances)
  • target ({'zero','mask','lower','higher'}, optional) – Propagate into zero (default), masked out, lower or higher neighboring voxels
  • scaling (float, optional) – Multiply the propagated values by a factor <=1 (default is 1)
  • save_data (bool) – Save output data to file (default is False)
  • overwrite (bool) – Overwrite existing results (default is False)
  • output_dir (str, optional) – Path to desired output directory, will be created if it doesn’t exist
  • file_name (str, optional) – Desired base name for output files with file extension (suffixes will be added)
Returns:

Dictionary collecting outputs under the following keys (suffix of output files in brackets)

  • result (niimg): The propagated intensity image
Return type:

dict

Notes

Original Java module by Pierre-Louis Bazin.