CompuScope SDK Manua.. - Egmont Instruments

padding between records exists and this padding is accounted for in the address calculation if chan is set
equal to 0
The chan equals –1 mode refers to the software multiple record. This option is provided primarily as a
means of reading Multiple Record SIG files, stored by GageScope ® or by another Gage software utility.
After a Multiple Record capture, CompuScope memory contains stacked multiple records separated by a
few points of padding, which varies depending on the CompuScope model. GageScope ® is capable of
storing all Multiple Records within a single SIG file. For simplicity, GageScope ® removes the inter-record
padding. So, for instance, for a Multiple Record capture of 2048 records of 1024 points each, GageScope ®
stores exactly 2048 x 1024 points to the SIG file. If a user wanted to read such a Multiple Record SIG file
and to calculate the record addresses within the file, he or she should call gage_calculate_mr_addresses
with chan equals –1. Such a Multiple Record file with no inter-record padding is sometimes called a
“Software Multiple Record SIG file”. The SIG file header contains a field that indicates that it is a
Software Multiple Record SIG file. Refer to the GageScope ® manual for the SIG file format information.
op_mode is the mode that was set when calling gage_capture_mode routine. Use the value that
controlled the most recent data capture, either GAGE_SINGLE_CHAN or GAGE_DUAL_CHAN.
GAGE_QUAD_CHAN can also be used for digital input CompuScopes.
tbs is the "Time Between Samples" in nanoseconds for the captured signal. For example, if you have
sampled the signal at 10 MS/s then this value would be 100.0. Similarly, a signal sampled at 1 kS/s would
require this value to be set to 1000000.0.
*trig will be the address where trigger event occurred. It may be adjusted in software, depending on the
type of hardware being used.
*start will be the first valid address of the group requested for the most recent data capture.
*end will be the last valid address of the group requested for the most recent data capture.
In Multiple Record mode, the start and trigger addresses will typically be the same. In the hardware
multiple record, the difference between the trigger and end addresses may be larger then the requested
depth, depending upon the CompuScope hardware being used. This is due to the architecture of the
hardware and the sample rate being used.
For a Master/Slave CompuScope system, the trigger, start and end addresses should be calculated using
gage_calculate_mr_addresses first for all CompuScopes in the system before a data transfer routine is
called.
Return Value
The return value is equal to the Multiple Record group number that corresponds to the returned addresses.
Normally, this return value will be equal to the group parameter. If the group parameter exceeds the
actual number of groups, however, then the maximum Multiple Record group number is returned.
See also:
gage_multiple_record and the Appendix entitled Multiple Record Mode Operation.
Examples
C: group = gage_calculate_mr_addresses (0L, gage_driver_info.board_type,
gage_driver_info.trigger_depth, gage_driver_info.max_available_memory, 0, GAGE_DUAL_CHAN,
srtable[board.srindex].sr_calc, *trig, *start, *end);
Visual BASIC: group = gage_calculate_mr_addresses(0, gage_driver_info.board_type,
gage_driver_info.trigger_depth, gage_driver_info.max_available_memory, 0, GAGE_DUAL_CHAN,
srtable(board.srindex).sr_calc, trigaddr, startaddr, endaddr)
CompuScope API Reference Manual
23