surface_inflation¶
-
nighres.surface.surface_inflation(surface_mesh, step_size=0.75, max_iter=2000, max_curv=10.0, method='area', regularization=0.0, save_data=False, overwrite=False, output_dir=None, file_name=None)[source]¶ Surface inflation
Inflate a surface with the method of Tosun et al _[1].
Parameters: - surface_mesh (mesh) – Mesh model of the surface
- step_size (float) – Relaxation rate in [0, 1]: values closer to 1 are more stable but slower (default is 0.75)
- max_iter (int) – Maximum number of iterations (default is 2000)
- max_curv (float) – Desired maximum curvature (default is 10.0)
- method (str) – Method used for averaging: ‘area’ based on the area of the triangle, ‘dist’ based on the vertex distance, ‘numv’ based on number of vertices (default is ‘area’)
- regularization (float) – Regularization parameter for reducing local singularities (default is 0.0)
- 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 (mesh): Surface mesh dictionary of “points”, “faces” and “data” showing the SOM coordinates on the mesh
Return type: Notes
Original Java module by Pierre-Louis Bazin
