profile_averaging

nighres.laminar.profile_averaging(profile_surface_image, intensity_image, roi_image, save_data=False, overwrite=False, output_dir=None, file_name=None)[source]

Sampling data on multiple intracortical layers

Parameters:
  • profile_surface_image (niimg) – 4D image containing levelset representations of different intracortical surfaces on which data should be sampled
  • intensity_image (niimg) – Image from which data should be sampled
  • roi_image (niimg) – Label image of the region to sample
  • 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)

  • weights (niimg): weight image, representing the weighting of profiles in the estimation (_lpa-weight)
  • best ([float]): the estimated best profile
  • median ([float]): the estimated median profile
  • iqr ([float]): the estimated IQR profile

Return type:

dict

Notes

Original Java module by Pierre-Louis Bazin