Skip to content

Commit

Permalink
converted doc to markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
evalott100 committed Mar 1, 2024
1 parent e08387d commit 3056f1f
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 38 deletions.
30 changes: 30 additions & 0 deletions docs/how-to/capture-hdf.md
Original file line number Diff line number Diff line change
@@ -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.
38 changes: 0 additions & 38 deletions docs/user/how-to/capture-hdf.rst

This file was deleted.

0 comments on commit 3056f1f

Please sign in to comment.