From 6c2f19cd6d2544f67105f4112243e918de27449d Mon Sep 17 00:00:00 2001 From: rivers Date: Tue, 14 Feb 2012 18:43:06 +0000 Subject: [PATCH] Documented new Time Series records, removed references to MCA module git-svn-id: https://subversion.xor.aps.anl.gov/synApps/areaDetector/trunk@14477 dc6c5ff5-0b8b-c028-a01f-ffb33f00fc8b --- documentation/NDPluginStats.html | 187 ++++++++++++++++++++++++++++--- 1 file changed, 173 insertions(+), 14 deletions(-) diff --git a/documentation/NDPluginStats.html b/documentation/NDPluginStats.html index 9229147..6c9ff9e 100755 --- a/documentation/NDPluginStats.html +++ b/documentation/NDPluginStats.html @@ -10,7 +10,7 @@

areaDetector Plugin NDPluginStats

- August 9, 2011

+ February 12, 2012

Mark Rivers

@@ -48,6 +48,11 @@ be perfomed on arrays of any dimension. Calculations 2 and 3 are restricted to 2-D arrays.

+

+ Time-series arrays of the basic statistics, centroid and sigma statistics can also + be collected. This is very useful for on-the-fly data acquisition, where the NDStats + plugin computes the net or total counts in the detector or an ROI. It can also be + used to quickly plot a time-history of beam position or width, etc.

NDPluginStats inherits from NDPluginDriver. The NDPluginStats class documentation describes this class in detail. @@ -64,7 +69,8 @@ - Parameter Definitions in NDPluginStats.h and EPICS Record Definitions in NDStats.template + Parameter Definitions in NDPluginStats.h and EPICS Record Definitions in NDStats.template + @@ -217,8 +223,7 @@ is ≤ 0 then no background is computed. The net counts is available as an ai record. The net counts is also available as epicsInt32 values in an mca record via callbacks to the drvFastSweep driver. The mca record is very useful for on-the-fly data acquisition - of the net counts in the detector or in an ROI. - + of the net counts in the detector or in an ROI. NET @@ -381,6 +386,162 @@ ai + + + Time-Series data + + + + NDPluginStats
+ TSControl + + asynInt32 + + r/w + + Controls time-series data collection. The enum choices are: +

+ + + TS_CONTROL + + $(P)$(R)TSControl + + mbbo + + + + N.A. + + N.A. + + r/w + + Sends the "Read" command to the TSControl record above. This record can be periodically + processed to update the time-series waveform records. It is scan disabled if TSAcquiring=Done, + so that updates are only performed when time-series acquisition is in progress. + + + N.A. + + $(P)$(R)TSRead + + longout + + + + NDPluginStats
+ TSNumPoints + + asynInt32 + + r/w + + Controls the number of time-series points to collect. There is no maximum value, + the time-series arrays in the plugin are freed and reallocated each time this value + is changed. However, the size of the waveform records is fixed when the IOC is started, + so NELM in those records must be large enough for the largest time-series needed. + + + TS_NUM_POINTS + + $(P)$(R)TSNumPoints + + longout + + + + NDPluginStats
+ TSCurrentPoint + + asynInt32 + + r/o + + The current time-series point. If TSCurrentPoint reaches TSNumPoints then time-series + acquisition is automatically stopped, and callbacks are done on all time-series + waveform records, updating the values. This means that even if TSRead has SCAN=Passive + that the waveform records will update when time-series acquisition is complete. + + + TS_CURRENT_POINT + + $(P)$(R)TSCurrentPoint + + longin + + + + NDPluginStats
+ TSAcquiring + + asynInt32 + + r/o + + Indicates status of time-series data acquisition. Values are 0=Done and 1=Acquiring. + + + TS_ACQUIRING + + $(P)$(R)TSAcquiring + + bi + + + + NDPluginStats
+ TSXXX + + asynFloat64Array + + r/o + + The time series data arrays. XXX is one of the following, corresponding to each + of the basic statistics and centroid and sigma statistics described above: + + + + + + + $(P)$(R)TSXXX + + waveform + X and Y Profiles @@ -807,24 +968,22 @@ NDStats5.png

- The following MEDM screen shows the MCA record containing the total counts from - the Stats1 plugin. This is the total counts as a function of time, and is very useful - for on-the-fly data acquisition, where the NDStats plugin computes the net or total - counts in the detector or an ROI. + The following MEDM screen shows the the total counts from the Stats5 plugin. This + is the total counts as a function of time.

- mca.adl

- NDStatsTotalArray.png + NDTimeSeries.adl

+ NDTimeSeriesTotal.png

- The following MEDM screen shows the MCA record containing the net counts from the - Stats1 plugin. + The following MEDM screen shows the Y centroid as a function of time from the Stats5 + plugin.

- mca.adl

- NDStatsNetArray.png + NDTimeSeries.adl + NDTimeSeriesCentroidY.png