Skip to content

Commit

Permalink
Wrote user docs for saving data
Browse files Browse the repository at this point in the history
  • Loading branch information
evalott100 committed Jan 23, 2024
1 parent 9187016 commit 63e97dc
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 0 deletions.
Binary file added docs/images/data_bobfile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 38 additions & 0 deletions docs/user/how-to/capture-hdf.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@

Capture data
============

The ``:DATA`` PVs are used to capture data from the panda.
These can be viewed from the DATA screen.

.. image:: /images/data_bobfile.png
:alt: The data screen
:align: center


* The file directory and name are chosen with ``:DATA:HDFDirectory`` and ``:DATA:HDFFileName``.
* ``:DATA:NumCapture`` is the number of frames to capture in the file.
* ``:DATA:NumCaptured`` is the number of frames written to file.
* ``:DATA:NumReceived`` is the number of frames received from the panda.
* ``:DATA:FlushPeriod`` is the frequency that the data is flushed into frames in the client.
* ``:DATA:Capture`` will begin capturing data.
* ``:DATA:CaptureMode`` is one of the three capture modes listed below.


First N mode
------------

Begin capturing data and writing it to file as soon as it is received. Stop capturing once ``NumCapture``
frames have been written or the panda has been disarmed.


Last N mode
-----------

Begin capturing data in a buffer, once capturing has finished write the last ``NumCapture`` frames to disk.


Forever mode
------------

Keep capturing and writing frames. Once the panda has been disarmed wait for it to be armed again and continue writing.
1 change: 1 addition & 0 deletions docs/user/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ side-bar.
:maxdepth: 1

how-to/run-container
how-to/capture-hdf

+++

Expand Down

0 comments on commit 63e97dc

Please sign in to comment.