From 763a80a7a36a2a079a431937ba3a22e100f73e57 Mon Sep 17 00:00:00 2001 From: Eva Lott Date: Fri, 1 Mar 2024 10:32:57 +0000 Subject: [PATCH] converted doc to markdown --- docs/how-to/capture-hdf.md | 30 +++++++++++++++++++++++++ docs/user/how-to/capture-hdf.rst | 38 -------------------------------- 2 files changed, 30 insertions(+), 38 deletions(-) create mode 100644 docs/how-to/capture-hdf.md delete mode 100644 docs/user/how-to/capture-hdf.rst diff --git a/docs/how-to/capture-hdf.md b/docs/how-to/capture-hdf.md new file mode 100644 index 00000000..f68e644e --- /dev/null +++ b/docs/how-to/capture-hdf.md @@ -0,0 +1,30 @@ +# 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 +:align: center +:alt: The data screen +``` + +- 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. diff --git a/docs/user/how-to/capture-hdf.rst b/docs/user/how-to/capture-hdf.rst deleted file mode 100644 index e966340e..00000000 --- a/docs/user/how-to/capture-hdf.rst +++ /dev/null @@ -1,38 +0,0 @@ - -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. \ No newline at end of file