feat: Add mesh statistic tools

README.md

@@ -145,7 +145,14 @@ If you would like to contribute to GEOS Python packages, please respect the foll
 
 1. Create a new branch named from this template: `[CONTRIBUTOR]/[TYPE]/[TITLE]` where CONTRIBUTOR is the name of the contributor, TYPE is the type of contribution among 'feature', 'refactor', 'doc', 'ci', TITLE is a short title for the branch.
 2. Add your code trying to integrate into the current code architecture.
-3. Push the branch, open a new PR respecting naming [semantics](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716), and add reviewers
+3. Run mypy, ruff and yapf in this order
+  ```
+  python -m pip install --upgrade mypy ruff yapf
+  python -m mypy --config-file ./.mypy.ini --check-untyped-defs ./<PACKAGE_NAME>
+  python -m ruff check --fix --config .ruff.toml ./<PACKAGE_NAME>
+  python -m yapf -r -i --style .style.yapf ./<PACKAGE_NAME>
+  ```
+4. Push the branch, open a new PR respecting naming [semantics](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716), and add reviewers
 
 If you do not have the rights to push the code and open new PRs, consider opening a new issue to explain what you want to do and ask for the dev rights.
 

docs/geos_mesh_docs/model.rst

@@ -4,10 +4,18 @@ Model
 The `model` module of `geos-mesh` package contains data model.
 
 
-geos.mesh.model.CellTypeCounts filter
+geos.mesh.model.CellTypeCounts module
 --------------------------------------
 
 .. automodule:: geos.mesh.model.CellTypeCounts
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+geos.mesh.model.QualityMetricSummary module
+--------------------------------------------
+
+.. automodule:: geos.mesh.model.QualityMetricSummary
     :members:
     :undoc-members:
     :show-inheritance:

docs/geos_mesh_docs/processing.rst

@@ -4,6 +4,14 @@ Processing filters
 The `processing` module of `geos-mesh` package contains filters to process meshes.
 
 
+geos.mesh.processing.meshQualityMetricHelpers module
+-----------------------------------------------------
+
+.. automodule:: geos.mesh.processing.meshQualityMetricHelpers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 geos.mesh.processing.SplitMesh filter
 --------------------------------------
 

docs/geos_mesh_docs/stats.rst

@@ -4,10 +4,18 @@ Mesh stats tools
 The `stats` module of `geos-mesh` package contains filter to compute statistics on meshes.
 
 
-geos.mesh.stats.CellTypeCounter filter
---------------------------------------
+geos.mesh.stats.CellTypeCounterEnhanced filter
+-----------------------------------------------
 
-.. automodule:: geos.mesh.stats.CellTypeCounter
+.. automodule:: geos.mesh.stats.CellTypeCounterEnhanced
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+geos.mesh.stats.MeshQualityEnhanced filter
+-------------------------------------------
+
+.. automodule:: geos.mesh.stats.MeshQualityEnhanced
     :members:
     :undoc-members:
     :show-inheritance:

geos-mesh/pyproject.toml

@@ -32,6 +32,7 @@ dependencies = [
     "pandas >= 2.2",
     "meshio >= 5.3",
     "typing_extensions >= 4.12",
+    "geos-utils @ file:./geos-utils",
 ]
 
 [project.scripts]

geos-mesh/src/geos/mesh/doctor/checks/collocated_nodes.py

@@ -20,7 +20,7 @@ class Result:
 
 
 def __check( mesh, options: Options ) -> Result:
-    points = mesh.GetPoints()
+    points: vtkPoints = mesh.GetPoints()
 
     locator = vtkIncrementalOctreePointLocator()
     locator.SetTolerance( options.tolerance )

geos-mesh/src/geos/mesh/model/CellTypeCounts.py

@@ -10,6 +10,21 @@
 
 __doc__ = """
 CellTypeCounts stores the number of elements of each type.
+
+To use the filter:
+
+.. code-block:: python
+
+    from geos.mesh.model.CellTypeCounts import CellTypeCounts
+
+    counts: CellTypeCounts = CellTypeCounts()
+
+    # set data
+    counts.addType( cellType )
+    counts.setTypeCount( cellType, count )
+
+    # get data
+    count: int counts.getTypeCount( cellType )
 """
 
 
@@ -43,6 +58,14 @@ def __add__( self: Self, other: Self ) -> 'CellTypeCounts':
         newCounts._counts = self._counts + other._counts
         return newCounts
 
+    def getCounts( self: Self ) -> npt.NDArray[ np.int64 ]:
+        """Get all counts.
+
+        Returns:
+            npt.NDArray[ np.int64 ]: counts
+        """
+        return self._counts
+
     def addType( self: Self, cellType: int ) -> None:
         """Increment the number of cell of input type.
 
@@ -74,6 +97,10 @@ def getTypeCount( self: Self, cellType: int ) -> int:
         """
         return int( self._counts[ cellType ] )
 
+    def reset( self: Self ) -> None:
+        """Reset counts."""
+        self._counts = np.zeros( VTK_NUMBER_OF_CELL_TYPES, dtype=float )
+
     def _updateGeneralCounts( self: Self, cellType: int, count: int ) -> None:
         """Update generic type counters.