surface_mesh_mapping

nighres.surface.surface_mesh_mapping(intensity_image, surface_mesh, inflated_mesh=None, mapping_method='closest_point', save_data=False, overwrite=False, output_dir=None, file_name=None)[source]

Surface mesh mapping

Maps volumetric data onto a surface mesh. A second mesh with the same graph topology (e.g. an inflated cortical surface) can also be mapped with the same data.

Parameters:
  • intensity_image (niimg) – Intensity image to map onto the surface mesh
  • surface_mesh (mesh) – Mesh model of the surface
  • inflated_mesh (mesh, optional) – Mesh model of the inflated surface
  • mapping_method ({"closest_point","linear_interp","highest_value"}, optional) – Choice of mapping method
  • save_data (bool, optional) – Save output data to file (default is False)
  • overwrite (bool, optional) – 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)

  • original (mesh): Surface mesh dictionary of “points” and “faces” (_map-orig)
  • inflated (mesh): Surface mesh dictionary of “points” and “faces” (_map-inf)
Return type:

dict

Notes

Ported from original Java module by Pierre-Louis Bazin