DOC: add documentation for vector view

European-XFEL · Jul 30, 2020 · 6b88a33 · 6b88a33
1 parent 4b2a142
commit 6b88a33
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 1 deletion.
diff --git a/docs/images/special_suite_vector_view.jpg b/docs/images/special_suite_vector_view.jpg
diff --git a/docs/special_suite.rst b/docs/special_suite.rst
@@ -89,7 +89,7 @@ More info on command line arguments can be obtained as
 General purposed apps
 ---------------------
 
-Camera view, multi-camera view
+:ref:`Camera view`, :ref:`Vector view`, multi-camera view
 
 
 .. _Camera view:
@@ -122,6 +122,37 @@ More small features will be added in the future.
 +----------------------------+--------------------------------------------------------------------+
 
 
+.. _Vector view:
+
+Vector view
+"""""""""""
+
+.. image:: images/special_suite_vector_view.jpg
+   :width: 800
+
+Vector view helps you monitor 1D data like XGM intensity, digitizer pulse integral, pulse-resolved
+ROI FOM and the correlation between them. **Vector view receives processed data from a main EXtra-foam
+instance.**
+
++----------------------------+--------------------------------------------------------------------+
+| Input                      | Description                                                        |
++============================+====================================================================+
+| ``Vector1``                | Vector 1.                                                          |
++----------------------------+--------------------------------------------------------------------+
+| ``Vector2``                | Vector 2 (optional).                                               |
++----------------------------+--------------------------------------------------------------------+
+
+.. note::
+    In order to correlate two vectors, you will need to use the `Pulse slicer` in the data source
+    tree located in the main GUI to select the data.
+
+.. warning::
+    To have the pulse-resolved ROI FOM data, currently you must open the :ref:`Histogram` window
+    in the main GUI and select `ROI FOM` as the analysis type. This will activate the pulse-resolved
+    ROI FOM calculation, which is a little bit expensive. Also, make sure the `Pulse resolved`
+    checkbox is checked.
+
+
 Special purposed apps
 ---------------------