Merge pull request #417 from European-XFEL/missing_trains

Add docs for DataCollection.plot_missing_data
European-XFEL · Jun 8, 2023 · b255776 · b255776
2 parents c285c4c + 6e77979
commit b255776
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/docs/_static/plot_missing_data.png b/docs/_static/plot_missing_data.png
diff --git a/docs/reading_files.rst b/docs/reading_files.rst
@@ -365,6 +365,14 @@ Missing data does not necessarily mean that something has gone wrong:
 some devices send data at less than 10 Hz (the train rate), so they always
 have gaps between updates.
 
+You can use :meth:`DataCollection.plot_missing_data` to quickly visualize
+sources that have missing data:
+
+.. class:: DataCollection
+   :noindex:
+
+   .. automethod:: plot_missing_data
+
 Data problems
 -------------
 

diff --git a/extra_data/reader.py b/extra_data/reader.py
@@ -1321,6 +1321,10 @@ def keys_detail(s, keys, prefix=''):
     def plot_missing_data(self, min_saved_pct=95, expand_instrument=False):
         """Plot sources that have missing data for some trains.
 
+        Example output:
+
+        .. image:: _static/plot_missing_data.png
+
         Parameters
         ----------