You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/databases.rst
+19-10Lines changed: 19 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,7 +87,8 @@ minimum, maximum, and other statistics, including a histogram of array values.
87
87
- All
88
88
- Acquire command. This command turns acquisition from the device on (1) and off (0)
89
89
Since it is a "busy" record the device can be used for step-scanning with the sscan
90
-
record when AcquireMode=Single, **Important note:** Operation in Single mode with the sscan record also requires
90
+
record when AcquireMode=Single. |br|
91
+
**Important note:** Operation in Single mode with the sscan record also requires
91
92
that the statistics plugins be set to have CallbacksBlock=Yes so that the driver
92
93
waits for the statistics plugins to compute before it sets Acquire back to 0.
93
94
* - QE_READ_FORMAT
@@ -212,16 +213,18 @@ minimum, maximum, and other statistics, including a histogram of array values.
212
213
- The AH401 series, NSLS_EM, and the APS_EM have 2 input channels, which we call Ping
213
214
and Pong here. This doubles the speed of the unit, because one channel is being
214
215
digitized while the other is integrating. This record selects how the two channels
215
-
are treated., On the AH401 series the choices are "Off" (0) and "On" (1). "Off" only returns the
216
+
are treated. |br|
217
+
On the AH401 series the choices are "Off" (0) and "On" (1). "Off" only returns the
216
218
data from the Ping channel. This reduces noise because only a single integration
217
219
capacitor is used, but it reduces the data rate by a factor of two, because data
218
220
are only returned on every other integration time. "On" returns the data from both
219
-
channels, which doubles the data rate at some expense in noise.
221
+
channels, which doubles the data rate at some expense in noise. |br|
220
222
On the NSLS_EM the choices are "Phase0" (0), "Phase1" (1), and "Both (2). "Phase0"
221
223
only returns the data from the Phase0 channel, Phase1 from the Phase1 channel, and
222
224
Both from both Phase0 and Phase1. The device can only return Phase0 and Phase1 correctly
223
225
when ValuesPerRead=1. The driver automatically sets PingPong=Both if ValuesPerRead
224
-
is not 1., On the APS_EM both values are always transmitted from the device. The choices are
226
+
is not 1. |br|
227
+
On the APS_EM both values are always transmitted from the device. The choices are
225
228
#1 (Ping), #2 (Pong), and Avg. which averages the values from the Ping and Pong
226
229
channels. Note that if Range=External and the two external capacitors are different,
227
230
then one should not use Avg. because that will mix data from two different gains.
@@ -233,10 +236,13 @@ minimum, maximum, and other statistics, including a histogram of array values.
233
236
- AH401 series, NSLS_EM, APS_EM
234
237
- Selects the integration time of the amplifier. As the integration time is increased
235
238
the sensitivity increases, but the number of readings/sec sent from the device is
236
-
decreased., For the AH401 series values range from 0.001s to 1.000s. The data are sent after
237
-
one integration time if PingPong="On" or after 2 integration times if PingPong="Off"., For the NSLS_EM the values range from .0004s to 1.0 s. Both the Phase0 (Ping) and
239
+
decreased. |br|
240
+
For the AH401 series values range from 0.001s to 1.000s. The data are sent after
241
+
one integration time if PingPong="On" or after 2 integration times if PingPong="Off". |br|
242
+
For the NSLS_EM the values range from .0004s to 1.0 s. Both the Phase0 (Ping) and
238
243
Phase1 (Pong) values are sent at after a time period equal to IntegrationTime *
239
-
ValuesPerRead., For the APS_EM the values range from .000615s to 0.1311s. The data are sent to the
244
+
ValuesPerRead. |br|
245
+
For the APS_EM the values range from .000615s to 0.1311s. The data are sent to the
240
246
VME card from the amplifier after 2 integration times, one value in the Ping channel
241
247
and one value in the Pong channel. The data period is thus 0.00123 to 0.02622 s,
242
248
or a frequency range of about 813 Hz to 38.1 Hz.
@@ -343,7 +349,8 @@ minimum, maximum, and other statistics, including a histogram of array values.
343
349
microseconds per sample). The minimum value of NRSAMP (and hence ValuesPerRead)
344
350
in Binary mode is 5, which means the maximum number of values per second is 20000.
345
351
Setting ValuesPerRead to 100, for example, will average 100 readings in the TetrAMM,
346
-
and thus result in a 1000 values per second sent from the TetrAMM to EPICS., , On the NSLS_EM and NSLS2_EM this record controls the number of readings that are
352
+
and thus result in a 1000 values per second sent from the TetrAMM to EPICS. |br|
353
+
On the NSLS_EM and NSLS2_EM this record controls the number of readings that are
347
354
summed in the hardware., For all other models ValuesPerRead controls the number of values that are read from
348
355
the meter in a single call. These values are averaged in the driver before it does
349
356
any callbacks. The default is 1 (no averaging). |br|
@@ -430,14 +437,16 @@ minimum, maximum, and other statistics, including a histogram of array values.
430
437
they are read out into NDArray objects and any registered plugins are called. AveragingTime
431
438
is actually used to compute NumAverage_RBV=AveragingTime/SampleTime_RBV. The callbacks
432
439
are done when the number of values in the ring buffer equals NumAverage_RBV, and
433
-
exactly NumAverage_RBV values will be passed to the plugins., However, setting AveragingTime=0 will set NumAverage_RBV=0 as well, and will disable
440
+
exactly NumAverage_RBV values will be passed to the plugins. |br|
441
+
However, setting AveragingTime=0 will set NumAverage_RBV=0 as well, and will disable
434
442
automatic callbacks to areaDetector plugins. In this case data will only be read
435
443
from the ring buffer when the ReadData record is processed. This will read out all
436
444
available data from ring buffer, and the actual number of values read will be NumAveraged_RBV.
437
445
This mode could be useful when the quadEM is being used for data acquisition, for
438
446
example in a scan. In this case processing the ReadData record will read all values
439
447
that have accumulated in the ring buffer since ReadData was last processed. ReadData
440
-
must be processed frequently enough to avoid ring-buffer overflow., On the TetrAMM in External Bulb mode and on the AH501BE in External Gate mode AveragingTime
448
+
must be processed frequently enough to avoid ring-buffer overflow. |br|
449
+
On the TetrAMM in External Bulb mode and on the AH501BE in External Gate mode AveragingTime
441
450
should be set to 0. The driver will force the averaging to occur each time it detects
442
451
the falling edge of the gate pulse. This means that it will use the readings that
0 commit comments