Py: Refactor

Author: w1th0utnam3

pysplashsurf/pysplashsurf/pysplashsurf.pyi

@@ -336,9 +336,12 @@ def laplacian_smoothing_parallel(mesh:typing.Union[TriMesh3d, MeshWithData], ver
 
 def marching_cubes_cleanup(mesh:typing.Union[TriMesh3d, MeshWithData], grid:UniformGrid, *, max_rel_snap_dist:typing.Optional[builtins.float]=None, max_iter:builtins.int=5, keep_vertices:builtins.bool=False) -> typing.Union[TriMesh3d, MeshWithData]:
     r"""
-    Performs simplification on the given mesh designed for marching cubes reconstructions inspired by the "Compact Contouring"/"Mesh displacement" approach by Doug Moore and Joe Warren
+    Performs simplification on the given mesh inspired by the "Compact Contouring"/"Mesh displacement" approach by Doug Moore and Joe Warren
     
     The simplification is performed inplace and modifies the given mesh.
+    The method is designed specifically for meshes generated by Marching Cubes.
+    See Moore and Warren: `Mesh Displacement: An Improved Contouring Method for Trivariate Data <https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.49.5214&rep=rep1&type=pdf>`_ (1991)
+    or Moore and Warren: "Compact Isocontours from Sampled Data" in "Graphics Gems III" (1992).
     """
 
 def neighborhood_search_spatial_hashing_parallel(particle_positions:numpy.typing.NDArray[typing.Any], domain:Aabb3d, search_radius:builtins.float) -> NeighborhoodLists:

pysplashsurf/src/lib.rs

@@ -18,7 +18,7 @@ mod uniform_grid;
 mod marching_cubes;
 mod neighborhood_search;
 mod pipeline;
-mod post_processing;
+mod postprocessing;
 mod reconstruction;
 
 pub(crate) mod utils;
@@ -44,12 +44,12 @@ fn pysplashsurf(m: &Bound<'_, PyModule>) -> PyResult<()> {
 
     m.add_function(wrap!(reconstruction::reconstruct_surface, m)?)?;
     m.add_function(wrap!(marching_cubes::check_mesh_consistency, m)?)?;
-    m.add_function(wrap!(post_processing::marching_cubes_cleanup, m)?)?;
-    m.add_function(wrap!(post_processing::convert_tris_to_quads, m)?)?;
-    m.add_function(wrap!(post_processing::barnacle_decimation, m)?)?;
-    m.add_function(wrap!(post_processing::laplacian_smoothing_parallel, m)?)?;
+    m.add_function(wrap!(postprocessing::marching_cubes_cleanup, m)?)?;
+    m.add_function(wrap!(postprocessing::convert_tris_to_quads, m)?)?;
+    m.add_function(wrap!(postprocessing::barnacle_decimation, m)?)?;
+    m.add_function(wrap!(postprocessing::laplacian_smoothing_parallel, m)?)?;
     m.add_function(wrap!(
-        post_processing::laplacian_smoothing_normals_parallel,
+        postprocessing::laplacian_smoothing_normals_parallel,
         m
     )?)?;
 

pysplashsurf/src/post_processing.rs pysplashsurf/src/postprocessing.rspysplashsurf/src/post_processing.rs renamed to pysplashsurf/src/postprocessing.rs

@@ -197,9 +197,12 @@ pub fn barnacle_decimation<'py>(
     }
 }
 
-/// Performs simplification on the given mesh designed for marching cubes reconstructions inspired by the "Compact Contouring"/"Mesh displacement" approach by Doug Moore and Joe Warren
+/// Performs simplification on the given mesh inspired by the "Compact Contouring"/"Mesh displacement" approach by Doug Moore and Joe Warren
 ///
 /// The simplification is performed inplace and modifies the given mesh.
+/// The method is designed specifically for meshes generated by Marching Cubes.
+/// See Moore and Warren: `Mesh Displacement: An Improved Contouring Method for Trivariate Data <https://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.49.5214&rep=rep1&type=pdf>`_ (1991)
+/// or Moore and Warren: "Compact Isocontours from Sampled Data" in "Graphics Gems III" (1992).
 #[gen_stub_pyfunction]
 #[pyfunction]
 #[pyo3(name = "marching_cubes_cleanup")]