CompuScope SDK Manua.. - Egmont Instruments

gage_acquire_average
Syntax
C:
int32 GAGEAPI gage_acquire_average (int16 channel, int32 nsamples, int32 naverages, int16 sum,
int32 far *avg_buffer, void far *data_buffer,
int32 data_buffer_size, int32 timeout);
Visual BASIC:
Function gage_acquire_average (ByVal channel As Integer, ByVal nsamples As Long,
ByVal naverages As Long, ByVal sum As Integer,
avg_buffer As Long, data_buffer As Any,
data_buffer_size As Long, timeout As Long) As Long
Remarks
gage_acquire_capture finds the average of a number of acquisitions. This routine does the entire capture
and transfer of data internally and does not return until either all captures are completed or an error has
occurred.
channel is the channel where the acquisitions will take place. It has a value of 1 for Board 1 Channel A, 2
for Board 1 Channel B, 3 for Board 2 Channel A, 4 for Board 2 Channel B, etc.
nsamples is the number of points to be sampled for each acquisition.
naverages is the number of traces to sum. The routine will not complete until this number has been
captured by the digitizer.
sum is a flag that is set to one to skip the division by naverages. This will allow an application to make use
of the unaveraged data to increase dynamic range. Normally the average is performed.
*avg_buffer is a pointer to a buffer containing either the sum of all the data traces or the averaged data,
depending on the value of the sum flag. The size of this buffer must be at least nsamples*sizeof(int32).
The buffer must allocated by the calling program.
*data_buffer is a pointer to a buffer for use by this routine to store data points returned from the digitizer
before they are summed into data_buffer. This buffer must be at least as large as (data_buffer_size) and
sized to the sample size of the CompuScope card being used (data_buffer_size * 1 byte for the 8-bit
CompuScope cards and data_buffer_size * 2 bytes per sample for the 12/16-bit CompuScope cards). This
buffer must be allocated by the calling program. This buffer is not used by the calling program, but is only
a scratch space for this routine.
data_buffer_size is the size of the buffer (data_buffer).
timeout is the amount of time the software should wait for the hardware to respond to a trigger event. The
resolution of the timeout is in hundreds of microseconds. A minus one (all bits set) will cause the software
to wait indefinitely for the trigger event to occur (therefore, if no trigger ever occurs then the software will
appear to hang since it is waiting for an event to happen that never will).
CompuScope API Reference Manual 60