Merge pull request #408 from EIT-ALIVE/fix/add-documentation

psomhorst · web-flow · commit 85a6fd69fd98 · 2025-08-12T20:54:30.000+02:00
Add Plotting documentation
diff --git a/docs/api/plotting/pixelmap.md b/docs/api/plotting/pixelmap.md
@@ -0,0 +1 @@
+::: eitprocessing.plotting.pixelmap.PixelMapPlotting
diff --git a/docs/api/plotting/rate_detection.md b/docs/api/plotting/rate_detection.md
@@ -0,0 +1 @@
+::: eitprocessing.plotting.rate_detection.RateDetectionPlotting
diff --git a/eitprocessing/plotting/rate_detection.py b/eitprocessing/plotting/rate_detection.py
@@ -19,9 +19,9 @@ class RateDetectionPlotting:
     ```python
     >>> rd = RateDetection("adult")
     >>> captures = {}
-    >>> estimated_respiratory_rate, estimated_heart_rate = rd.detect_respiratory_heart_rate(eit_data, captures=captures)
+    >>> rr, hr = rd.apply(eit_data, captures=captures)
     >>> fig = rd.plotting(**captures)
-    >>> fig.savefig(...)
+    >>> fig.savefig("rate_detection.png")  # Save the figure to a file
     ```
     """
 
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -72,6 +72,9 @@ nav:
       - api/parameters.md
       - api/categories.md
       - api/mixins.md
+      - Plotting:
+        - Rate Detection: api/plotting/rate_detection.md
+        - PixelMap: api/plotting/pixelmap.md
   - About:
       - Contributing: contributing_doc.md
       - Code of Conduct: code_of_conduct_doc.md

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+::: eitprocessing.plotting.pixelmap.PixelMapPlotting`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+::: eitprocessing.plotting.rate_detection.RateDetectionPlotting`