PROGRAMMER’S REFERENCE MANUAL AGILENT ACQIRIS INSTRUMENTS
Manual Part Number U1092-90002 Edition H-RevF, June 2008 The information in this document is subject to change without notice and may not be construed in any way as a commitment by Agilent Technologies, Inc. While Agilent makes every effort to ensure the accuracy and contents of the document it assumes no responsibility for any errors that may appear. All software described in the document is furnished under license. The software may only be used and copied in accordance with the terms of license.
CONTENTS 1. INTRODUCTION................................................................................................................................................ 6 1.1. Message to the User ....................................................................................................................................... 6 1.2. Using this Manual .......................................................................................................................................... 6 1.3.
2.3.44 2.3.45 2.3.46 2.3.47 2.3.48 2.3.49 2.3.50 2.3.51 2.3.52 2.3.53 2.3.54 2.3.55 2.3.56 2.3.57 2.3.58 2.3.59 2.3.60 2.3.61 2.3.62 2.3.63 2.3.64 2.3.65 2.3.66 2.3.67 2.3.68 2.3.69 2.3.70 2.3.71 2.3.72 2.3.73 2.3.74 2.3.75 2.3.76 2.3.77 2.3.78 2.3.79 2.3.80 2.3.81 2.3.82 2.3.83 2.3.84 2.3.85 2.3.86 2.3.87 2.3.88 2.3.89 2.3.90 2.3.91 2.3.92 2.3.93 2.3.94 2.3.95 2.3.96 2.3.97 2.3.98 AcqrsD1_configMode............................................................................................................
2.3.99 2.3.100 2.3.101 2.3.102 2.3.103 2.3.104 2.3.105 2.3.106 2.3.107 2.3.108 2.3.109 2.3.110 2.3.111 2.3.112 2.3.113 2.3.114 2.3.115 AcqrsT3_acqDone.................................................................................................................................. 188 AcqrsT3_acquire ................................................................................................................................ 189 AcqrsT3_configAcqConditions..................................................
1. Introduction 1.1. Message to the User Congratulations on having purchased an Agilent Technologies Acqiris data conversion product. Acqiris Digitizers, Averagers, Analyzers, and Time-to-Digital Converters are high-speed data acquisition modules designed for capturing high frequency electronic signals. To get the most out of the products we recommend that you read the accompanying product User Manual, the Programmer's Guide and this Programmer’s Reference Manual carefully.
1.3. Conventions Used in This Manual The following conventions are used in this manual: This icon to the left of text warns that an important point must be observed. WARNING Denotes a warning, which advises you of precautions to take to avoid being electrically shocked. CAUTION Denotes a caution, which advises you of precautions to take to avoid electrical, mechanical, or operational damages. NOTE Denotes a note, which alerts you to important information.
2. Device Driver Function Reference All function calls require the argument instrumentID in order to identify the Acqiris Instrument to which the call is directed.
Acqiris Error Codes ACQIRIS_ERROR_READ_TIMEOUT ACQIRIS_ERROR_INTERRUPTED ACQIRIS_ERROR_WAIT_TIMEOUT ACQIRIS_ERROR_FIRMWARE_NOT_AUTHORIZED ACQIRIS_ERROR_FPGA_1_LOAD ACQIRIS_ERROR_FPGA_2_LOAD ACQIRIS_ERROR_FPGA_3_LOAD ACQIRIS_ERROR_FPGA_4_LOAD ACQIRIS_ERROR_FPGA_5_LOAD ACQIRIS_ERROR_FPGA_6_LOAD ACQIRIS_ERROR_FPGA_7_LOAD ACQIRIS_ERROR_FPGA_8_LOAD ACQIRIS_ERROR_SELFCHECK_MEMORY ACQIRIS_ERROR_ATTR_NOT_FOUND ACQIRIS_ERROR_ATTR_WRONG_TYPE ACQIRIS_ERROR_ATTR_IS_READ_ONLY ACQIRIS_ERROR_ATTR_IS_WRITE_ONLY ACQIRIS_ERR
Error code Hex value VI_SUCCESS VI_ERROR_PARAMETER1 VI_ERROR_PARAMETER2 VI_ERROR_PARAMETER3 VI_ERROR_PARAMETER4 VI_ERROR_PARAMETER5 VI_ERROR_PARAMETER6 VI_ERROR_PARAMETER7 VI_ERROR_PARAMETER8 VI_ERROR_FAIL_ID_QUERY VI_ERROR_INV_RESPONSE 0 BFFC0001 BFFC0002 BFFC0003 BFFC0004 BFFC0005 BFFC0006 BFFC0007 BFFC0008 BFFC0011 BFFC0012 Decimal value 0 -1074003967 -1074003966 -1074003965 -1074003964 -1074003963 -1074003962 -1074003961 -1074003960 -1074003951 -1074003950 Table 2-2 VXIplug&play Error Codes If impo
Generic Utility Functions Version Acqrs_getVersion Error Message Acqrs_errorMessage Reset Acqrs_reset Set LED Color Acqrs_setLEDColor Close an instrument Acqrs_close Close all instruments Acqrs_closeAll AcqirisD1Interface.h is the header file for these functions: Digitizer Initialization Functions Function Name Number of Physical Instruments (deprec.) AcqrsD1_getNbrPhysicalInstruments MultiInstrument Auto Define AcqrsD1_multiInstrAutoDefine Initialization (deprec.
Start Acquisition (Extended) AcqrsD1_acquireEx Query Acquisition Status AcqrsD1_acqDone Software Trigger AcqrsD1_forceTrig Software Trigger (Extended) AcqrsD1_forceTrigEx Stop Acquisition AcqrsD1_stopAcquisition Wait for End of Acquisition AcqrsD1_waitForEndOfAcquisition Number of Acquired Segments AcqrsD1_reportNbrAcquiredSegments Digitizer Data Transfer Functions Universal Waveform Read AcqrsD1_readData Accumulate Data AcqrsD1_accumulateData Averaged Data AcqrsD1_averagedData Read Freq
Error Message AcqrsD1_errorMessage Extended Error Message AcqrsD1_errorMessageEx Reset (deprec.) AcqrsD1_reset Reset Digitizer Memory AcqrsD1_resetDigitizerMemory Restore Internal Registers AcqrsD1_restoreInternalRegisters Set LED Color AcqrsD1_setLEDColor Close all instruments (deprec.) AcqrsD1_closeAll AcqirisT3Interface.
2.3. API Function descriptions This section describes each function in the Device Driver. The functions appear in alphabetical order. 2.3.1 Acqrs_calibrate Purpose Performs an auto-calibration of the instrument. Parameters Input Name instrumentID Type ViSession Instrument identifier Description Type ViStatus Description Refer to Table 2-1 for error codes.
2.3.2 Acqrs_calibrateEx Purpose Performs a (partial) auto-calibration of the instrument. Parameters Input Name instrumentID calType Type ViSession ViInt32 modifier ViInt32 flags ViInt32 Description Instrument identifier = 0 calibrate the entire instrument = 1 calibrate only the current channel configuration = 2 calibrate external clock timing. Requires operation in External Clock (Continuous).
LabWindowsCVI/Visual C++ Representation ViStatus status = Acqrs_calibrateEx(ViSession instrumentID, ViInt32 calType, ViInt32 modifier, ViInt32 flags); LabVIEW Representation Acqiris Bx.lvlib: (or Aq Bx) CalibrateEx Instrument.vi Visual Basic .
2.3.3 Acqrs_close Purpose Closes an instrument. Parameters Input Name instrumentID Type ViSession Instrument identifier Description Type ViStatus Description Refer to Table 2-1 for error codes. Return Value Name status Discussion Close the specified instrument. Once closed, this instrument is not available anymore and needs to be reenabled using 'InitWithOptions' or 'init'. 10-bit-FAMILY digitizers will have their power consumption lowered.
2.3.4 Acqrs_closeAll Purpose Closes all instruments in preparation for closing the application. Return Value Name status Type ViStatus Description Refer to Table 2-1 for error codes. Discussion This function should be the last call to the driver, before closing an application. Make sure to stop all instruments beforehand. 10-bit-FAMILY digitizers will have their power consumption lowered. Appropriate warm-up time may be needed when they are used again.
2.3.5 Acqrs_configLogicDevice Purpose Configures (programs) on-board logic devices, such as user-programmable FPGA’s. NOTE: With the exception of AC and SC Analyzers, this function now needs to be used only by VxWorks users to specify the filePath for FPGA .bit files.
LabWindowsCVI/Visual C++ Representation ViStatus status = Acqrs_configLogicDevice(ViSession instrumentID, ViChar deviceName[], ViChar filePathName[], ViInt32 flags); LabVIEW Representation Acqiris Bx.lvlib: (or Aq Bx) Configure Logic Device.vi Visual Basic .
2.3.6 Acqrs_errorMessage Purpose Translates an error code into a human readable form.
LabWindowsCVI/Visual C++ Representation ViStatus status = Acqrs_errorMessage(ViSession instrumentID, ViStatus errorCode, ViChar errorMessage[], ViInt32 errorMessageSize); LabVIEW Representation Acqiris Bx.lvlib: (or Aq Bx) Error Message.vi Visual Basic .
2.3.7 Acqrs_getDevType Purpose Returns the deviceType which indicates which family of the API functions can be used. Parameters Input Name instrumentID Type ViSession Description Instrument identifier Output Name devTypeP Type ViInt32* Description Pointer to a device type (see AqDevType) with 1 = Digitizer (AcqrsD1) 2 = RC2xx Generator (AcqrsG2) 4 = TC Time-to-Digital Converter (AcqrsT3) Type ViStatus Description Refer to Table 2-1 for error codes.
2.3.8 Acqrs_getDevTypeByIndex Purpose Returns the deviceType which indicates which family of API functions can be used. Parameters Input Name devIndex Type ViInt32 Description Device Index (the integer part of the resource name as used in Acqrs_initWithOptions. See the Programmer’s Guide section 3.2.
2.3.9 Acqrs_getInstrumentData Purpose Returns some basic data about a specified instrument. Parameters Input Name instrumentID Type ViSession Description Instrument identifier Output name Name Type ViChar [ ] serialNbr busNbr slotNbr ViInt32 ViInt32 ViInt32 Description Pointer to user-allocated string, into which the model name is returned (length < 32 characters). Serial number of the module. Bus number of the module location. Slot number of the module location.
2.3.10 Acqrs_getInstrumentInfo Purpose Returns general information about a specified instrument. Parameters Input Name instrumentID parameterString Type ViSession ViString Description Instrument identifier Character string defining the requested parameter. See below for the list of accepted strings. Type ViAddr Description Requested information value. ViAddr resolves to void* in C/C++. The user must allocate the appropriate variable type (as listed below) and supply its address as 'infoValue'.
Parameter String Returned Type "OverloadStatus ALL" ViInt32 "PosInCrate" "SSRTimeStamp" "TbNextSegmentPad" ViInt32 ViReal64 ViInt32 "TbSegmentPad" ViInt32 "Temperature m" "TrigLevelRange chan" “VersionUserDriver” ViInt32 ViReal64 ViChar[ ] Description chan takes on the same values as 'channel' in AcqrsD1_configTrigSource. Returns 1 if any of the signal or external trigger inputs is in overload, 0 otherwise. Use the "OverloadStatus chan " string to determine which channel is in overload.
LabWindowsCVI/Visual C++ Representation ViStatus status = Acqrs_getInstrumentInfo(ViSession instrumentID, ViString parameterString, ViAddr infoValue); LabVIEW Representation Acqiris Bx.lvlib: (or Aq Bx) Query Instrument Information.vi NOTE: The type of the returned value depends on the parameter requested. In LabVIEW, the correct returned type should be supplied as input to the VI, and the appropriate output wire connected. Any other wire will always return zero. Visual Basic .
2.3.11 Acqrs_getNbrChannels Purpose Returns the number of channels on the specified module. Parameters Input Name instrumentID Type ViSession Instrument identifier Description Type ViInt32 Description Number of channels in the specified module Type ViStatus Description Refer to Table 2-1 for error codes.
2.3.12 Acqrs_getNbrInstruments Purpose Returns the number of Acqiris instruments found on the computer. Parameters Output Name nbrInstruments Type ViInt32 Description Number of Acqiris instruments found on the computer Type ViStatus Description Refer to Table 2-1 for error codes. Return Value Name status LabWindowsCVI/Visual C++ Representation ViStatus status = Acqrs_getNbrInstruments(ViInt32* nbrInstruments); LabVIEW Representation Acqiris Bx.lvlib: (or Aq Bx) Query Number of Instruments.
2.3.13 Acqrs_getVersion Purpose Returns version numbers associated with a specified instrument or current device driver. Parameters Input Name instrumentID versionItem Type ViSession ViInt32 Description Instrument identifier 1 for version of Kernel-Mode Driver 2 for version of EEPROM Common Section 3 for version of EEPROM Instrument Section 4 for version of CPLD firmware Type ViInt32 Description version number of the requested item Type ViStatus Description Refer to Table 2-1 for error codes.
2.3.14 Acqrs_init Purpose Initializes an instrument. Parameters Input Name resourceName Type ViRsrc IDQuery resetDevice ViBoolean ViBoolean Description ASCII string which identifies the module to be initialized. See discussion below. Currently ignored If set to 'TRUE', resets the module after initialization. Type ViSession Instrument identifier Type ViStatus Description Refer to Table 2-1 for error codes.
2.3.15 Acqrs_InitWithOptions Purpose Initializes an instrument with options. Parameters Input Name resourceName Type ViRsrc IDQuery resetDevice ViBoolean ViBoolean optionsString ViString Description ASCII string which identifies the instrument to be initialized. See discussion below. Currently ignored If set to 'TRUE', resets the instrument after initialization. ASCII string that specifies options. Syntax: "optionName=bool" where bool is TRUE (1) or FALSE (0).
LabWindowsCVI/Visual C++ Representation ViStatus status = Acqrs_InitWithOptions(ViRsrc resourceName, ViBoolean IDQuery, ViBoolean resetDevice, ViString optionsString, ViSession* instrumentID); LabVIEW Representation Acqiris Bx.lvlib: (or Aq Bx) Initialize with Options.vi Visual Basic .
2.3.16 Acqrs_logicDeviceIO Purpose Reads/writes a number of 32-bit data values from/to a user-defined register in on-board logic devices, such as user-programmable FPGAs. It is useful for AC/SC Analyzers only. Parameters Input Name instrumentID deviceName Type ViSession ViChar [ ] registerID nbrValues dataArray readWrite flags ViInt32 ViInt32 ViInt32 [ ] ViInt32 ViInt32 Description Instrument identifier Identifies which device to read from or write to.
LabWindowsCVI/Visual C++ Representation ViStatus status = Acqrs_logicDeviceIO(ViSession instrumentID, ViChar deviceName[], ViInt32 registerID, ViInt32 nbrValues, ViInt32 dataArray[], readWrite, ViInt32 flags); ViInt32 LabVIEW Representation Acqiris Bx.lvlib: (or Aq Bx) Logic Device IO.vi Visual Basic .
2.3.17 Acqrs_reset Purpose Resets an instrument. Parameters Input Name instrumentID Type ViSession Instrument identifier Description Type ViStatus Description Refer to Table 2-1 for error codes. Return Value Name status Discussion There is no known situation where this action is to be recommended. LabWindowsCVI/Visual C++ Representation ViStatus status = Acqrs_reset(ViSession instrumentID); LabVIEW Representation Acqiris Bx.lvlib: (or Aq Bx) Reset.vi Visual Basic .
2.3.18 Acqrs_resetMemory Purpose Resets the instrument’s memory to a known default state. Parameters Input Name instrumentID Type ViSession Instrument identifier Description Type ViStatus Description Refer to Table 2-1 for error codes. Return Value Name status Discussion Each byte of the digitizer memory is overwritten sequentially with the values 0xaa, 0x55, 0x00 and 0xff. This functionality is mostly intended for use with battery backed-up memories.
2.3.19 Acqrs_setAttributeString Purpose Sets an attribute with a string value (for use in SC Streaming Analyzers ONLY). Parameters Input Name instrumentID channel name Type ViSession ViInt32 ViConstString value ViConstString Description Instrument identifier 1...Nchan ASCII string that specifies options “odlTxBitRate” is currently the only one used For “odlTxBitRate” can have values like “2.5G”,”2.125G”, or “1.
2.3.20 Acqrs_setLEDColor Purpose Sets the front panel LED to the desired color. Parameters Input Name instrumentID color Type ViSession ViInt32 Description Instrument identifier 0 = OFF (return to normal acquisition status indicator) 1 = Green 2 = Red 3 = Yellow Type ViStatus Description Refer to Table 2-1 for error codes. Return Value Name status LabWindowsCVI/Visual C++ Representation ViStatus status = Acqrs_setLEDColor(ViSession instrumentID, ViInt32 color); LabVIEW Representation Acqiris Bx.
2.3.21 Acqrs_setSimulationOptions Purpose Sets one or several options which will be used by the function Acqrs_InitWithOptions, provided that the optionsString supplied with that function contains the string "simulate=TRUE". Parameters Input Name simOptionString Type ViString Description String listing the desired simulation options. See discussion below. Type ViStatus Description Refer to Table 2-1 for error codes. Return Value Name status Discussion See the Programmer’s Guide section 3.2.
2.3.22 AcqrsD1_accumulateData Purpose Returns a waveform as an array and accumulates it in a client array. Parameters Input Name instrumentID channel readPar Type ViSession ViInt32 AqReadParameters Description Instrument identifier 1...Nchan Requested parameters for the acquired waveform. Name dataArray Type ViAddr sumArray ViInt32 [ ] dataDesc segDescArray AqDataDescriptor ViAddr Description User-allocated waveform destination array of type char or byte.
LabWindowsCVI/Visual C++ Representation ViStatus AcqrsD1_accumulateData (ViSession instrumentID, ViInt32 channel, AqReadParameters* readPar, void* dataArray, ViInt32 sumArray[], AqDataDescriptor* dataDesc, void* segDescArray); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Accumulate Data.vi This Vi is polymorphic, the sample data is returned in an array of type I8 or I16.
2.3.23 AcqrsD1_acqDone Purpose Checks if the acquisition has terminated. Parameters Input Name instrumentID Type ViSession Description Instrument identifier Output Name done Type ViBoolean Description done = VI_TRUE if the acquisition is terminated VI_FALSE otherwise Type ViStatus Description Refer to Table 2-1 for error codes.
2.3.24 AcqrsD1_acquire Purpose Starts an acquisition. Parameters Input Name instrumentID Type ViSession Instrument identifier Description Type ViStatus Description Refer to Table 2-1 for error codes. Return Value Name status LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_acquire(ViSession instrumentID); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Start Acquisition.vi Visual Basic Representation Acquire (ByVal instrumentID As Long) As Long Visual Basic .
2.3.25 AcqrsD1_acquireEx Purpose Starts an acquisition. Parameters Input Name instrumentID acquireMode Type ViSession ViInt32 acquireFlags ViInt32 acquireParams reserved ViInt32 ViInt32 Description Instrument identifier = 0, normal = 2, continue to accumulate (AP Averagers only) = 0, normal = 4, resets the time stamp counter (10-bit-Family only) Parameters, currently not used Currently not used Type ViStatus Description Refer to Table 2-1 for error codes.
2.3.26 AcqrsD1_averagedData Purpose This function is intended for single instrument, single channel operation. Perform a series of acquisitions and get the resulting averaged waveform. Parameters Input Name instrumentID channel readPar nbrAcq calculateMean Type ViSession ViInt32 AqReadParameters ViInt32 ViBoolean timeout ViReal64 Description Instrument identifier 1...Nchan Requested parameters for the acquired waveform Number of acquisitions to be performed.
Discussion Because the acquisition control loop is done inside this function, it is suitable only for single instrument, single channel operation. This function uses the AcqrsD1_readData routine. However, only 'readPar->nbrSegments = 1' and 'readPar>readMode = 0' (ReadModeStdW) are supported. 'readPar->dataType = 3' (real) and 'readPar->dataType = 2' (long) are NOT supported. The sumArray contains either the average values (calculateMean = TRUE), or the sample-by-sample sums (calculateMean = FALSE).
Visual Basic Representation AveragedData (ByVal instrumentID As Long, _ ByVal channel As Long, _ readPar As AqReadParameters, _ ByVal nbrAcq As Long, _ ByVal calculateMean As Boolean, _ ByVal timeout As Double, _ dataArray As Any, _ sumArray As Long, _ dataDesc As AqDataDescriptor, _ segDescArray As Any) As Long Visual Basic .
2.3.27 AcqrsD1_bestNominalSamples Purpose Helper function to simplify digitizer configuration. It returns the maximum nominal number of samples that fit into the available memory. Parameters Input Name instrumentID Type ViSession Instrument identifier Description Type ViInt32 Description Maximum number of data samples available Type ViStatus Description Refer to Table 2-1 for error codes.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_bestNominalSamples(ViSession instrumentID, ViInt32* nomSamples); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Query Best Nominal Samples.vi Visual Basic Representation BestNominalSamples (ByVal instrumentID As Long, _ nomSamples As Long) As Long Visual Basic .
2.3.28 AcqrsD1_bestSampInterval Purpose Helper function to simplify digitizer configuration. It returns the best possible sampling rate for an acquisition, which covers the timeWindow with no more than maxSamples. The calculation takes into account the requested state of the instrument, in particular the requested number of segments. In addition, this routine returns the "real" nominal number of samples that can be accommodated (it is computed as timeWindow/samplingInterval!).
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_bestSampInterval(ViSession instrumentID, ViInt32 maxSamples, ViReal64 timeWindow, ViReal64* sampInterval, ViInt32* nomSamples); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Query Best Sampling Interval.
2.3.29 AcqrsD1_calibrate (DEPRECATED) Purpose Performs an auto-calibration of the instrument. See Acqrs_calibrate. Parameters Input Name instrumentID Type ViSession Instrument identifier Description Type ViStatus Description Refer to Table 2-1 for error codes.
2.3.30 AcqrsD1_calibrateEx (DEPRECATED) Purpose Performs a (partial) auto-calibration of the instrument. See Acqrs_calibrateEx Parameters Input Name instrumentID calType Type ViSession ViInt32 modifier ViInt32 flags ViInt32 Description Instrument identifier = 0 calibrate the entire instrument = 1 calibrate only the current channel configuration = 2 calibrate external clock timing. Requires operation in External Clock (Continuous).
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_calibrateEx(ViSession instrumentID, ViInt32 calType, ViInt32 modifier, ViInt32 flags); LabVIEW Representation See Acqrs_calibrateEx Visual Basic Representation CalibrateEx (ByVal ByVal ByVal ByVal instrumentID As Long, _ calType As Long, _ modifier As Long, _ flags As Long) As Long Visual Basic .
2.3.31 AcqrsD1_close (DEPRECATED) Purpose Closes an instrument. See Acqrs_close. Parameters Input Name instrumentID Type ViSession Instrument identifier Description Type ViStatus Description Refer to Table 2-1 for error codes. Return Value Name Status Discussion Close the specified instrument. Once closed, this instrument is not available anymore and needs to be reenabled using 'InitWithOptions' or 'init'.
2.3.32 AcqrsD1_closeAll (DEPRECATED) Purpose Closes all instruments in preparation for closing the application. See Acqrs_closeAll. Return Value Name Status Type ViStatus Description Refer to Table 2-1 for error codes. Discussion This function should be the last call to the driver, before closing an application. Make sure to stop all instruments beforehand. If this function is not called, closing the application might crash the computer in some situations, particularly in multi-threaded applications.
2.3.33 AcqrsD1_configAvgConfig Purpose Configures a parameter for averager/analyzer operation. Parameters Input Name instrumentID channelNbr Type ViSession ViInt32 parameterString ViString value ViAddr Description Instrument identifier Channel number. A value = 0 will be treated as =1 for compatibility. Character string defining the requested parameter. See below for the list of accepted strings. Value to set. ViAddr resolves to void* in C/C++.
Parameter String Data Type "NoiseBase" ViReal64 "P1Control" ViInt32 "P2Control" ViInt32 "PostSamples" ViInt32 "PreSamples" ViInt32 "StartDelay" ViInt32 "StartDeltaNegPeak" ViInt32 "StartDeltaPosPeak" ViInt32 "StartDeltaPosPeakV" ViReal64 "StartVetoEnable" ViInt32 "StopDelay " ViInt32 "TdcHistogramDepth" ViInt32 "TdcHistogramHorzRes" ViInt32 Programmer’s Reference Manual Description Value in Volts of the value to be added in Noise Supressed Averaging. For Averagers ONLY.
Parameter String Data Type "TdcHistogramIncrement" ViInt32 "TdcHistogramMode" ViInt32 "TdcHistogramVertRes" ViInt32 "TdcMinTOT" ViInt32 "TdcOverlaySegments" ViInt32 "TdcProcessType" ViInt32 "ThresholdEnable" ViInt32 "Threshold" ViReal64 "TrigAlways" ViInt32 "TriggerTimeout" ViInt32 "TrigResync" ViInt32 "ValidDeltaNegPeak" ViInt32 "ValidDeltaPosPeak" ViInt32 "ValidDeltaPosPeakV" ViReal64 Description The desired increment to be applied for each entry; 1 means increment by 1, for
The channelNbr is used to designate the channel number for those parameters whose values can be different for the two channels of an AP240/AP235 in dual-channel mode. These parameters are indicated in bold in the list above. The granularity for "NbrSamples","StartDelay", and "StopDelay" is 16 for the AP100/AP101 and the AP240/AP235 in Dual-Channel mode and 32 for the AP200/AP201 and the AP240/AP235 in SingleChannel mode.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_configAvgConfig(ViSession instrumentID, ViInt32 channelNbr, ViString parameterString, ViAddr value); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Extended Configure Averager.vi This Vi is polymorphic, the value can be either I32 or DBL. Visual Basic Representation ConfigAvgConfig (ByVal ByVal ByVal value instrumentID As Long, _ channelNbr As Long, _ parameterString As String, _ As Any) As Long Visual Basic .
2.3.34 AcqrsD1_configAvgConfigInt32 Purpose Configures a long parameter for averager/analyzer operation. Parameters Input Name instrumentID channelNbr Type ViSession ViInt32 parameterString ViString value ViInt32 Description Instrument identifier Channel number. A value = 0 will be treated as =1 for compatibility. Character string defining the requested parameter. See below for the list of accepted strings. Value to set. Type ViStatus Description Refer to Table 2-1 for error codes.
Parameter String Data Type "P1Control" ViInt32 "P2Control" ViInt32 "PostSamples" ViInt32 "PreSamples" ViInt32 "StartDelay" ViInt32 "StartDeltaNegPeak" ViInt32 "StartDeltaPosPeak" ViInt32 "StartVetoEnable" ViInt32 "StopDelay " ViInt32 "TdcHistogramDepth" ViInt32 "TdcHistogramHorzRes" ViInt32 "TdcHistogramIncrement" ViInt32 Programmer’s Reference Manual Description May assume 0 = not enabled For AP240/AP235 Averagers ONLY.
Parameter String Data Type "TdcHistogramMode" ViInt32 "TdcHistogramVertRes" ViInt32 "TdcMinTOT" ViInt32 "TdcOverlaySegments" ViInt32 "TdcProcessType" ViInt32 "ThresholdEnable" ViInt32 "TrigAlways" ViInt32 "TriggerTimeout" ViInt32 "TrigResync" ViInt32 "ValidDeltaNegPeak" ViInt32 "ValidDeltaPosPeak" ViInt32 Description The type of histogram for PeakTDC mode ONLY. 0 means no histogram. Data only is available for each acquisition. 1 for a histogram.
If P1Control and/or P2Control are enabled for the Add/Subtract mode then the data will be added if the signal, or the or of both signals, is in the high state. The same rule holds if they are used for trigger enable. The P1Control/P2Control "average (out)" signal goes high after the first trigger is accepted for an average and drops back down when the last trigger's acquition is complete.
2.3.35 AcqrsD1_configAvgConfigReal64 Purpose Configures a double parameter for averager/analyzer operation. Parameters Input Name instrumentID channelNbr Type ViSession ViInt32 parameterString ViString value ViReal64 Description Instrument identifier Channel number. A value = 0 will be treated as =1 for compatibility. Character string defining the requested parameter. See below for the list of accepted strings. Value to set. Type ViStatus Description Refer to Table 2-1 for error codes.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_configAvgConfigReal64(ViSession instrumentID, ViInt32 channelNbr, ViString parameterString, ViReal64 value); LabVIEW Representation Please use the Acqiris Dx.lvlib: (or Aq Dx) Extended Configure Averager.vi described in AcqrsD1_configAvgConfig. Visual Basic Representation ConfigAvgConfigReal64 (ByVal instrumentID As Long, _ ByVal channelNbr As Long, _ ByVal parameterString As String, _ ByVal value As Double) As Long Visual Basic .
2.3.36 AcqrsD1_configChannelCombination Purpose Configures how many converters are to be used for which channels. This routine is for use with some DC271-FAMILY instruments, the 10-bit-FAMILY, the AC/SC240, and the AP240/AP235 Signal Analyzer platforms.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_configChannelCombination( ViSession instrumentID, ViInt32 nbrConvertersPerChannel, ViInt32 usedChannels); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Configure Channel Combination.vi Visual Basic Representation ConfigChannelCombination (ByVal instrumentID As Long, _ ByVal nbrConvertersPerChannel As Long, _ ByVal usedChannels As Long) As Long Visual Basic .
2.3.37 AcqrsD1_configControlIO Purpose Configures a ControlIO connector.
Connector Type Front Panel Trigger Out PXI Bus 10 MHz PXI Bus Star Trigger Possible Values of signal and qualifierX The value of signal is interpreted as a signal offset in mV. E.g. signal = -500 offsets the output signal by –500 mV. The accepted range of signal is [-2500,2500], i.e. ± 2.5 V with a resolution of ~20 mV. The value of qualifier1 controls if the trigger output is resynchronized to the clock or maintains a precise timing relation to the trigger input.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_configControlIO(ViSession instrumentID, ViInt32 connector, ViInt32 signal, ViInt32 qualifier1, ViReal64 qualifier2); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Configure Control IO Connectors.vi Visual Basic Representation ConfigControlIO (ByVal ByVal ByVal ByVal ByVal instrumentID As Long, _ connector As Long, _ signal As Long, _ qualifier1 As Long, _ qualifier2 As Double) As Long Visual Basic .
2.3.38 AcqrsD1_configExtClock Purpose Configures the external clock of the digitizer.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_configExtClock(ViSession instrumentID, ViInt32 clockType, ViReal64 inputThreshold, ViInt32 delayNbrSamples, ViReal64 inputFrequency, ViReal64 sampFrequency); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Configure External Clock.
2.3.39 AcqrsD1_configFCounter Purpose Configures a frequency counter measurement Parameters Input Name instrumentID signalChannel type Type ViSession ViInt32 ViInt32 targetValue ViReal64 apertureTime ViReal64 reserved flags ViReal64 ViInt32 Description Instrument identifier Signal input channel Type of measurement = 0 Frequency (default) = 1 Period (1/frequency) = 2 Totalize by Time = 3 Totalize by Gate User-supplied estimate of the expected value, may be 0.0 if no estimate is available.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_configFCounter(ViSession instrumentID, ViInt32 signalChannel, ViInt32 type, ViReal64 targetValue, ViReal64 apertureTime,ViReal64 reserved, ViInt32 flags); LabVIEW Representation AqDx Configure FCounter.
2.3.40 AcqrsD1_configHorizontal Purpose Configures the horizontal control parameters of the digitizer. Parameters Input Name instrumentID sampInterval delayTime Type ViSession ViReal64 ViReal64 Description Instrument identifier Sampling interval in seconds Trigger delay time in seconds, with respect to the beginning of the record. A positive number corresponds to a trigger before the beginning of the record (post-trigger recording). A negative number corresponds to pre-trigger recording.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_configHorizontal(ViSession instrumentID, ViReal64 sampInterval, ViReal64 delayTime); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Configure Horizontal Settings.vi Visual Basic Representation ConfigHorizontal (ByVal instrumentID As Long, _ ByVal sampInterval As Double, _ ByVal delayTime As Double) As Long Visual Basic .
2.3.41 AcqrsD1_configLogicDevice (DEPRECATED) Purpose Configures (programs) on-board Acqrs_configLogicDevice. logic devices, such as user-programmable FPGA’s. See NOTE: With the exception of AC and SC Analyzers, this function now needs to be used only by VxWorks users to specify the filePath for FPGA .bit files.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_configLogicDevice(ViSession instrumentID, ViChar deviceName[], ViChar filePathName[], ViInt32 flags); LabVIEW Representation See Acqrs_configLogicDevice Visual Basic Representation ConfigLogicDevice (ByVal ByVal ByVal ByVal instrumentID As Long, _ deviceName As String, _ filePathName As String, _ modifier As Long) As Long Visual Basic .
2.3.42 AcqrsD1_configMemory Purpose Configures the memory control parameters of the digitizer. Parameters Input Name instrumentID nbrSamples nbrSegments Type ViSession ViInt32 ViInt32 Description Instrument identifier Nominal number of samples to record (per segment!) Number of segments to acquire. 1 corresponds to the normal single-trace acquisition mode. Type ViStatus Description Refer to Table 2-1 for error codes.
2.3.43 AcqrsD1_configMemoryEx Purpose Extended configuration of the memory control parameters of the digitizer including 10-bit-FAMILY & U1071A-FAMILY SAR mode. Parameters Input Name instrumentID nbrSamplesHi nbrSamplesLo nbrSegments Type ViSession ViUInt32 ViUInt32 ViInt32 nbrBanks flags ViInt32 ViInt32 Description Instrument identifier Must be set to 0 (reserved for future use) Nominal number of samples to record (per segment!) Number of segments to acquire.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_configMemoryEx(ViSession instrumentID, ViUInt32 nbrSamplesHi, ViUInt32 nbrSamplesLo, ViInt32 nbrSegments, ViInt32 nbrBanks, ViInt32 flags); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Configure Extended Memory Settings.
2.3.44 AcqrsD1_configMode Purpose Configures the operational mode of Averagers and Analyzers and certain special Digitizer acquisition modes Parameters Input Name instrumentID mode Type ViSession ViInt32 modifier flags ViInt32 ViInt32 Description Instrument identifier 0 = normal data acquisition 1 = AC/SC stream data to DPU 2 = averaging mode (only in real-time averagers) 3 = buffered data acquisition (only in AP101/AP201 analyzers) 5 = PeakTDC mode for Analyzers with this option.
• flags = 10: SAR mode. This mode allows simultaneous data acquisition and readout and is available on some models only. AcqrsD1_configMemoryEx must be used to set the desired number of banks. When SAR mode is active any external memory present is not available. The averaging mode (2) has the following differences from the default mode (0): • The function AcqrsD1_acquire(): In mode 0, it starts a normal waveform acquisition, whereas in mode 2, it makes the instrument run as a real-time averager.
MATLAB MEX Representation [status]= AqD1_configMode(instrumentID, mode, modifier, flags) Note: The older form Aq_configMode is deprecated. Please convert to the newer version.
2.3.45 AcqrsD1_configMultiInput Purpose Selects the active input when there are multiple inputs on a channel. It is useful for Averagers, Analyzers, and some digitizer models. Parameters Input Name instrumentID channel input Type ViSession ViInt32 ViInt32 Description Instrument identifier 1...Nchan = 0 set to input connection A = 1 set to input connection B Type ViStatus Description Refer to Table 2-1 for error codes.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_configMultiInput(ViSession instrumentID, ViInt32 channel, ViInt32 input); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Configure Multiplexer Input.vi Visual Basic Representation ConfigMultiInput (ByVal instrumentID As Long, _ ByVal channel As Long, _ ByVal connection As Long) As Long Visual Basic .
2.3.46 AcqrsD1_configSetupArray Purpose Sets the configuration for an array of configuration values. It is useful for Analyzers only. Parameters Input Name instrumentID channel setupType Type ViSession ViInt32 ViInt32 nbrSetupObj setupData ViInt32 ViAddr Description Instrument identifier 1...Nchan Type of setup. 0 = GateParameters Number of setup objects in the array Pointer to an array containing the setup objects ViAddr resolves to void* in C/C++.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_configSetupArray(ViSession instrumentID, ViInt32 channel, ViInt32 setupType, ViInt32 nbrSetupObj, ViAddr setupData); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Configure Setup Array.vi Visual Basic Representation ConfigSetupArray (ByVal instrumentID As Long, _ ByVal channel As Long, _ ByVal setupType As Long, _ ByVal nbrSetupObj As Long, _ setupData As Any) As Long Visual Basic .
2.3.47 AcqrsD1_configTrigClass Purpose Configures the trigger class control parameters of the digitizer.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_configTrigClass(ViSession instrumentID, ViInt32 trigClass, ViInt32 sourcePattern, ViInt32 validatePattern, ViInt32 holdType, ViReal64 holdoffTime, ViReal64 reserved); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Configure Trigger Class.
2.3.48 AcqrsD1_configTrigSource Purpose Configures the trigger source control parameters for the specified trigger source (channel or External). Parameters Input Name instrumentID channel Type ViSession ViInt32 trigCoupling ViInt32 trigSlope ViInt32 trigLevel1 ViReal64 trigLevel2 ViReal64 Description Instrument identifier = 1...(Number of IntTrigSources) for internal sources = -1..-(Number of ExtTrigSources) for external sources See discussion below.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_configTrigSource(ViSession instrumentID, ViInt32 channel, ViInt32 trigCoupling, ViInt32 trigSlope, ViReal64 trigLevel1, ViReal64 trigLevel2); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Configure Extended Trigger Source.
2.3.49 AcqrsD1_configTrigTV Purpose Configures the TV trigger parameters (12-bit-FAMILY only). Parameters Input Name instrumentID channel Type ViSession ViInt32 standard ViInt32 field ViInt32 line ViInt32 Description Instrument identifier = -1..-(Number of ExtTrigSources) for external sources See discussion below.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_configTrigTV (ViSession instrumentID, ViInt32 channel, ViInt32 standard, ViInt32 field, ViInt32 line); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Configure Trigger TV.vi Visual Basic Representation ConfigTrigTV (ByVal instrumentID As Long, _ ByVal Channel As Long, _ ByVal standard As Long, _ ByVal field As Long, _ ByVal line AS Long) As Long Visual Basic .
2.3.50 AcqrsD1_configVertical Purpose Configures the vertical control parameters for a specified channel of the digitizer. Parameters Input Name instrumentID channel fullScale offset coupling Type ViSession ViInt32 ViReal64 ViReal64 ViInt32 bandwidth ViInt32 Description Instrument identifier 1...
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_configVertical(ViSession instrumentID, ViInt32 channel,ViReal64 fullScale, ViReal64 offset, ViInt32 coupling, ViInt32 bandwidth); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Configure Vertical Settings.vi Visual Basic Representation ConfigVertical (ByVal ByVal ByVal ByVal instrumentID As Long, ByVal Channel As Long, _ fullScale As Double, ByVal offset As Double, _ coupling As Long, _ bandwidth As Long) As Long Visual Basic .
2.3.51 AcqrsD1_errorMessage Purpose Translates an error code into a human readable form. The new function Acqrs_errorMessage is to be preferred. Parameters Input Name instrumentID errorCode Type ViSession ViStatus Description Instrument identifier can be VI_NULL Error code (returned by a function) to be translated Type ViChar [ ] Description Pointer to user-allocated string (suggested size 512) into which the error-message text is returned Type ViStatus Description Refer to Table 2-1 for error codes.
2.3.52 AcqrsD1_errorMessageEx Purpose Translates an error code into a human readable form and returns associated information. The new function Acqrs_errorMessage is to be preferred.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_errorMessageEx(ViSession instrumentID, ViStatus errorCode, ViChar errorMessage[], ViInt32 errorMessageSize); LabVIEW Representation See Acqrs_errorMessage Visual Basic Representation errorMessageEx (ByVal instrumentID As Long, ByVal errorCode As Long, _ ByVal errorMessage As String, ByVal errorMessageSize As Long) As Long Visual Basic .
2.3.53 AcqrsD1_forceTrig Purpose Forces a manual trigger. It should not be used for Averagers or Analyzers. Parameters Input Name instrumentID Type ViSession Instrument identifier Description Type ViStatus Description Refer to Table 2-1 for error codes. Return Value Name status Discussion The function returns immediately after ordering the acquisition to stop.
2.3.54 AcqrsD1_forceTrigEx Purpose Forces a manual trigger. It should not be used for Averagers or Analyzers. Parameters Input Name instrumentID forceTrigType Type ViSession ViInt32 modifier flags ViInt32 ViInt32 Description Instrument identifier = 0 Sends a software trigger to end the full acquisition = 1 Sends a single software trigger and generates the TrigOut hardware signal Currently not used Currently not used Type ViStatus Description Refer to Table 2-1 for error codes.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_forceTrigEx(ViSession instrumentID , ViInt32 forceTrigType, ViInt32 modifier, ViInt32 flags); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Software Trigger.vi Visual Basic Representation ForceTrigEx (ByVal instrumentID As Long, _ ByVal forceTrigType as Long, _ ByVal modifier As Long, _ ByVal flags As Long) As Long Visual Basic .
2.3.55 AcqrsD1_freeBank Purpose Free current bank during SAR acquisitions. Parameters Input Name instrumentID reserved Type ViSession ViInt32 Instrument identifier Reserved Description Type ViStatus Description Refer to Table 2-1 for error codes. Return Value Name status Discussion Calling this function indicates to the driver that the current SAR bank has been read and can be reused for a new acquisition. This call should be made after having read all desired data for the bank.
2.3.56 AcqrsD1_getAvgConfig Purpose Returns an attribute from the analyzer/averager configuration channelNbr. Parameters Input Name instrumentID channelNbr Type ViSession ViInt32 parameterString ViString Description Instrument identifier Channel number for use with AP240/AP235 dualchannel mode. A value = 0 will be treated as =1 for compatibility. Character string defining the requested parameter. See AcqrsD1_configAvgConfig for the list of accepted strings.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_getAvgConfig(ViSession instrumentID, ViInt32 channelNbr, ViString parameterString, ViAddr value); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Query Extended Averager Settings.vi This Vi returns the value as either I32 or DBL. Connect the desired type. Visual Basic Representation GetAvgConfig (ByVal ByVal ByVal value instrumentID As Long, _ channelNbr As Long, _ parameterString As String, _ as Any) As Long Visual Basic .
2.3.57 AcqrsD1_getAvgConfigInt32 Purpose Returns a long attribute from the analyzer/averager configuration channelNbr. Parameters Input Name instrumentID channelNbr Type ViSession ViInt32 parameterString ViString Description Instrument identifier Channel number for use with AP240/AP235 dualchannel mode. A value = 0 will be treated as =1 for compatibility. Character string defining the requested parameter. See AcqrsD1_configAvgConfig for the list of accepted strings.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_getAvgConfigInt32(ViSession instrumentID, ViInt32 channelNbr, ViString parameterString, ViInt32 *value); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Query Extended Averager Settings.vi This Vi returns the value as either I32 or DBL. Connect the desired type.
2.3.58 AcqrsD1_getAvgConfigReal64 Purpose Returns a double attribute from the analyzer/averager configuration channelNbr. Parameters Input Name instrumentID channelNbr Type ViSession ViInt32 parameterString ViString Description Instrument identifier Channel number for use with AP240/AP235 dualchannel mode. A value = 0 will be treated as =1 for compatibility. Character string defining the requested parameter. See AcqrsD1_configAvgConfig for the list of accepted strings.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_getAvgConfigReal64(ViSession instrumentID, ViInt32 channelNbr, ViString parameterString, ViReal64 *value); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Query Extended Averager Settings.vi This Vi returns the value as either I32 or DBL. Connect the desired type.
2.3.59 AcqrsD1_getChannelCombination Purpose Returns the current channel combination parameters of the digitizer. Parameters Input Name instrumentID Type ViSession Description Instrument identifier Output Name nbrConvertersPer Channel Type ViInt32 usedChannels ViInt32 Description = 1 all channels use 1 converter each (default) = 2 half of the channels use 2 converters each = 4 1/4 of the channels use 4 converters each bit-field indicating which channels are used.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_getChannelCombination( ViSession instrumentID, ViInt32* nbrConvertersPerChannel, ViInt32* usedChannels); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Query Channel Combination.vi Visual Basic Representation GetChannelCombination (ByVal instrumentID As Long, _ nbrConvertersPerChannel As Long, _ usedChannels As Long) As Long Visual Basic .
2.3.60 AcqrsD1_getControlIO Purpose Returns the configuration of a ControlIO connector.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_getControlIO(ViSession instrumentID, ViInt32 connector, ViInt32* signal, ViInt32* qualifier1, ViReal64* qualifier2); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Query Control IO Connectors.vi Visual Basic Representation GetControlIO (ByVal instrumentID As Long, _ ByVal connector As Long, _ signal As Long, _ qualifier1 As Long, _ qualifier2 As Double) As Long Visual Basic .
2.3.61 AcqrsD1_getExtClock Purpose Returns the current external clock control parameters of the digitizer.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_getExtClock(ViSession instrumentID, ViInt32* clockType, ViReal64* inputThreshold, ViInt32* delayNbrSamples, ViReal64* inputFrequency, ViReal64* sampFrequency); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Query External Clock.
2.3.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_getFCounter(ViSession instrumentID, ViInt32* signalChannel, ViInt32* type, ViReal64* targetValue, ViReal64* apertureTime, ViReal64* reserved, ViInt32* flags); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Query FCounter.
2.3.63 AcqrsD1_getHorizontal Purpose Returns the current horizontal control parameters of the digitizer. Parameters Input Name instrumentID Type ViSession Instrument identifier Description Type ViReal64 ViReal64 Description Sampling interval in seconds Trigger delay time in seconds Type ViStatus Description Refer to Table 2-1 for error codes. Output Name sampInterval delayTime Return Value Name status Discussion See remarks under AcqrsD1_configHorizontal.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_getHorizontal(ViSession instrumentID, ViReal64* sampInterval, ViReal64* delayTime); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Query Horizontal Settings.vi Visual Basic Representation GetHorizontal (ByVal instrumentID As Long, _ sampInterval As Double, _ delayTime As Double) As Long Visual Basic .
2.3.64 AcqrsD1_getInstrumentData (DEPRECATED) Purpose Returns some basic data about a specified digitizer. See Acqrs_getInstrumentData. Parameters Input Name instrumentID Type ViSession Description Instrument identifier Output name Name Type ViChar [ ] serialNbr busNbr slotNbr ViInt32 ViInt32 ViInt32 Description Pointer to user-allocated string, into which the model name is returned (length < 32 characters). Serial number of the digitizer. Bus number of the digitizer location.
2.3.65 AcqrsD1_getInstrumentInfo (DEPRECATED) Purpose Returns general information about a specified digitizer. See Acqrs_getInstrumentInfo. Parameters Input Name instrumentID parameterString Type ViSession ViString Description Instrument identifier Character string defining the requested parameter. See below for the list of accepted strings. Type ViAddr Description Requested information value. ViAddr resolves to void* in C/C++.
Parameter String "OverloadStatus chan" Returned Type ViInt32 "OverloadStatus ALL" ViInt32 "PosInCrate" "SSRTimeStamp" "TbSegmentPad" ViInt32 ViReal64 ViInt32 "Temperature m" "TrigLevelRange chan" “VersionUserDriver” ViInt32 ViReal64 ViChar[ ] Description Returns 1 if chan is in overload, 0 otherwise. chan takes on the same values as 'channel' in AcqrsD1_configTrigSource. Returns 1 if any of the signal or external trigger inputs is in overload, 0 otherwise.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_getInstrumentInfo(ViSession instrumentID, ViString parameterString, ViAddr infoValue); LabVIEW Representation Please refer to Acqrs_getInstrumentInfo. Visual Basic Representation NOTE: In Visual Basic, a returned type of ViInt32 should be declared as Long, while a returned type of ViReal64 should be declared as Double.
2.3.66 AcqrsD1_getMemory Purpose Returns the current memory control parameters of the digitizer. Parameters Input Name instrumentID Type ViSession Description Instrument identifier Output Name nbrSamples nbrSegments Type ViInt32 ViInt32 Description Nominal number of samples to record (per segment!) Number of segments to acquire. 1 corresponds to the normal single-trace acquisition mode. Type ViStatus Description Refer to Table 2-1 for error codes.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_getMemory(ViSession instrumentID, ViInt32* nbrSamples, ViInt32* nbrSegments); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Query Memory Settings.vi Visual Basic Representation GetMemory (ByVal instrumentID As Long, _ nbrSamples As Long, _ nbrSegments As Long) As Long Visual Basic .
2.3.67 AcqrsD1_getMemoryEx Purpose Returns the current extended memory control parameters of the digitizer. Parameters Input Name instrumentID Type ViSession Description Instrument identifier Output Name nbrSamplesHi nbrSamplesLo nbrSegments Type ViUInt32 ViUInt32 ViInt32 nbrBanks ViInt32 flags ViInt32 Description Will be set to 0 (reserved for future use) Nominal number of samples to record (per segment!) Number of segments to acquire. 1 corresponds to the normal single-trace acquisition mode.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_getMemoryEx(ViSession instrumentID, ViUInt32* nbrSamplesHi, ViUInt32* nbrSamplesLo, ViInt32* nbrSegments, ViInt32* nbrBanks, ViInt32* flags); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Query Extended Memory Settings.vi Visual Basic Representation GetMemoryEx (ByVal instrumentID As Long, _ nbrSamplesHi As Long, _ nbrSamplesLo As Long, _ nbrSegments As Long, nbrBanks As Long, flags As Long) As Long Visual Basic .
2.3.68 AcqrsD1_getMode Purpose Returns the current operational mode of the digitizer Parameters Input Name instrumentID Type ViSession Description Instrument identifier Output Name mode modifier flags Type ViInt32 ViInt32 ViInt32 Description Operational mode Modifier, currently not used Flags Type ViStatus Description Refer to Table 2-1 for error codes. Return Value Name status Discussion See remarks under AcqrsD1_configMode.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_getMode(ViSession instrumentID, ViInt32* mode, ViInt32* modifier, ViInt32* flags); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Query Operation Mode.vi Visual Basic Representation GetMode (ByVal instrumentID As Long, _ mode as Long, _ modifier As Long, _ flags As Long) As Long Visual Basic .
2.3.69 AcqrsD1_getMultiInput Purpose Returns the multiple input configuration on a channel. Parameters Input Name instrumentID channel Type ViSession ViInt32 Description Instrument identifier 1...Nchan Output Name input Type ViInt32 Description = 0 input connection A = 1 input connection B Type ViStatus Description Refer to Table 2-1 for error codes. Return Value Name status Discussion This function is only of use for instruments with an input-multiplexer (i.e. more than 1 input per digitizer, e.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_getMultiInput(ViSession instrumentID, ViInt32 channel, ViInt32* input); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Query Multiplexer Input.vi Visual Basic Representation GetMultiInput (ByVal instrumentID As Long, _ ByVal channel As Long, _ inputs As Long) As Long Visual Basic .
2.3.70 AcqrsD1_getNbrChannels (DEPRECATED) Purpose Returns the number of channels on the specified module. See Acqrs_getNbrChannels. Parameters Input Name instrumentID Type ViSession Instrument identifier Description Type ViInt32 Description Number of channels in the specified module Type ViStatus Description Refer to Table 2-1 for error codes.
2.3.71 AcqrsD1_getNbrPhysicalInstruments (DEPRECATED) Purpose Returns the number of physical Acqiris modules found on the computer. See Acqrs_getNbrInstruments. Parameters Output Name nbrInstruments Type ViInt32 Description Number of Acqiris modules found on the computer Type ViStatus Description Refer to Table 2-1 for error codes.
2.3.72 AcqrsD1_getSetupArray Purpose Returns an array of configuration parameters. It is useful for Analyzers only. Parameters Input Name instrumentID channel setupType Type ViSession ViInt32 ViInt32 nbrSetupObj ViInt32 Description Instrument identifier 1...Nchan Type of setup. 0 = GateParameters Maximum allowed number of setup objects in the output.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_getSetupArray(ViSession instrumentID, ViInt32 channel, ViInt32 setupType, ViInt32 nbrSetupObj ViAddr setupData, ViInt32* nbrSetupObjReturned); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Query Setup Array.vi Visual Basic Representation GetSetupArray (ByVal instrumentID As Long, _ ByVal channel As Long, _ ByVal setupType As Long, _ ByVal nbrSetupObj As Long, _ setupData As Any, _ nbrSetupObjReturned As Long) As Long Visual Basic .
2.3.73 AcqrsD1_getTrigClass Purpose Returns the current trigger class control parameters of the digitizer.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_getTrigClass(ViSession instrumentID, ViInt32* trigClass, ViInt32* sourcePattern, ViInt32* validatePattern, ViInt32* holdType, ViReal64* holdoffTime, ViReal64* reserved); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Query Trigger Class.
2.3.74 AcqrsD1_getTrigSource Purpose Returns the current trigger source control parameters for a specified channel. Parameters Input Name instrumentID channel Type ViSession ViInt32 Description Instrument identifier = 1...(Number of IntTrigSources) for internal sources = -1..-(Number of ExtTrigSources) for external sources See discussion below.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_getTrigSource(ViSession instrumentID, ViInt32 channel, ViInt32* trigCoupling, ViInt32* trigSlope, ViReal64* trigLevel1, ViReal64* trigLevel2); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Query Extended Trigger Source.vi Visual Basic Representation GetTrigSource (ByVal instrumentID As Long, _ ByVal Channel As Long, _ trigCoupling As Long, _ trigSlope As Long, _ trigLevel1 As Double, _ trigLevel2 As Double) As Long Visual Basic .
2.3.75 AcqrsD1_getTrigTV Purpose Returns the current TV trigger parameters (12-bit-FAMILY only). Parameters Input Name instrumentID channel Type ViSession ViInt32 Description Instrument identifier = -1..-(Number of ExtTrigSources) for external sources See discussion below.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_getTrigTV (ViSession instrumentID, ViInt32 channel, ViInt32* standard, ViInt32* field, ViInt32* line); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Query Trigger TV.vi Visual Basic Representation GetTrigTV (ByVal instrumentID As Long, _ ByVal Channel As Long, _ standard As Long, _ field As Long, _ line AS Long) As Long Visual Basic .
2.3.76 AcqrsD1_getVersion (DEPRECATED) Purpose Returns version numbers associated with a specified digitizer or current device driver. See Acqrs_getVersion.
2.3.77 AcqrsD1_getVertical Purpose Returns the vertical control parameters for a specified channel in the digitizer. Parameters Input Name instrumentID channel Type ViSession ViInt32 Description Instrument identifier 1...
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_getVertical(ViSession instrumentID, ViInt32 channel, ViReal64* fullScale, ViReal64* offset, ViInt32* coupling, ViInt32* bandwidth); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Query Vertical Settings.vi Visual Basic Representation GetVertical (ByVal instrumentID As Long, _ ByVal Channel As Long, _ fullScale As Double, _ offset As Double, _ coupling As Long, _ bandwidth As Long) As Long Visual Basic .
2.3.78 AcqrsD1_init (DEPRECATED) Purpose Initializes an instrument. See Acqrs_init. Parameters Input Name resourceName Type ViRsrc IDQuery resetDevice ViBoolean ViBoolean Description ASCII string which identifies the digitizer to be initialized. See discussion below. Currently ignored If set to 'TRUE', resets the digitizer after initialization. Type ViSession Instrument identifier Type ViStatus Description Refer to Table 2-1 for error codes.
2.3.79 AcqrsD1_InitWithOptions (DEPRECATED) Purpose Initializes an instrument with options. See Acqrs_InitWithOptions. Parameters Input Name resourceName Type ViRsrc IDQuery resetDevice optionsString ViBoolean ViBoolean ViString Description ASCII string which identifies the digitizer to be initialized. See discussion below. Currently ignored If set to 'TRUE', resets the digitizer after initialization. ASCII string that specifies options. Syntax: "optionName=bool" where bool is TRUE (1) or FALSE (0).
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_InitWithOptions(ViRsrc resourceName, ViBoolean IDQuery, ViBoolean resetDevice, ViString optionsString, ViSession* instrumentID); LabVIEW Representation Please refer to Acqrs_InitWithOptions. Visual Basic Representation InitWithOptions (ByVal resourceName As String, _ ByVal IDQuery As Boolean, _ ByVal resetDevice As Boolean, _ ByVal optionsString As String, _ instrumentID As Long) As Long Visual Basic .
2.3.80 AcqrsD1_logicDeviceIO (DEPRECATED) Purpose Reads/writes a number of 32-bit data values from/to a user-defined register in on-board logic devices, such as user-programmable FPGAs. It is useful for AC/SC Analyzers only. See Acqrs_logicDeviceIO. Parameters Input Name instrumentID deviceName Type ViSession ViChar [ ] registerID nbrValues dataArray readWrite flags ViInt32 ViInt32 ViInt32 [ ] ViInt32 ViInt32 Description Instrument identifier Identifies which device to read from or write to.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_logicDeviceIO(ViSession instrumentID, ViChar deviceName[], ViInt32 registerID, ViInt32 nbrValues, ViInt32 dataArray[], readWrite, ViInt32 flags); ViInt32 LabVIEW Representation Please refer to Acqrs_logicDeviceIO.
2.3.81 AcqrsD1_multiInstrAutoDefine Purpose Automatically initializes all digitizers and combines as many as possible to MultiInstruments. Digitizers are only combined if they are physically connected via AS bus. Parameters Input Name optionsString Type ViString Description ASCII string which specifies options. Currently no options are supported. Type ViInt32 Description Number of user-accessible instruments. It also includes single instruments that don't participate on the AS bus.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_multiInstrAutoDefine(ViString optionsString, ViInt32* nbrInstruments); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) MultiInstrument Auto Define.vi Visual Basic Representation MultiInstrAutoDefine (ByVal optionsString As String, _ nbrInstruments As Long) As Long Visual Basic .
2.3.82 AcqrsD1_multiInstrDefine Purpose This function defines the combination of a number of digitizers connected by AS bus into a single MultiInstrument. It is not applicable to AS bus 2 modules.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_multiInstrDefine(ViSession instrumentList[], ViInt32 nbrInstruments, ViSession masterID, ViSession* instrumentID); LabView Representation Acqiris Dx.lvlib: (or Aq Dx) Configure MultiInstrument Manual Define.vi Visual Basic Representation MultiInstrDefine (ByRef instrumentList As Long, _ ByVal nbrInstruments As Long, _ ByVal masterID As Long, _ instrumentID As Long) As Long Visual Basic .
2.3.83 AcqrsD1_multiInstrUndefineAll Purpose Undefines all MultiInstruments. Parameters Input Name optionsString Type ViString Description ASCII string which specifies options. Currently no options are supported. Type ViStatus Description Refer to Table 2-1 for error codes. Return Value Name status Discussion You should refer to to the Programmer’s Guide section 3.2, Device Initialization, for a detailed explanation on the initialization procedure.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_multiInstrUndefineAll(ViString optionsString); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Configure MultiInstrument Undefine.vi Visual Basic Representation MultiInstrUndefineAll (ByVal optionsString As String) As Long Visual Basic .
2.3.84 AcqrsD1_procDone Purpose Checks if the on-board data processing has terminated. This routine is for Analyzers only. Parameters Input Name instrumentID Type ViSession Description Instrument identifier Output Name done Type ViBoolean Description done = VI_TRUE if the processing is terminated VI_FALSE otherwise Type ViStatus Description Refer to Table 2-1 for error codes.
2.3.85 AcqrsD1_processData Purpose Starts on-board data processing on acquired data in the current bank as soon as the current acquisition terminates. It can also be used to allow the following acquisition to be started as soon as possible. This routine is for Analyzers only.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_processData(ViSession instrumentID, ViInt32 processType, ViInt32 flags); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Process Data.vi Visual Basic Representation ProcessData (ByVal instrumentID As Long, _ ByVal processType As Long, _ ByVal flags As Long) As Long Visual Basic .
2.3.86 AcqrsD1_readData Purpose Returns all waveform information. The sample data is returned in an array whose type is specified in the AqReadParameters structure. Parameters Input Name instrumentID channel readPar Type ViSession ViInt32 AqReadParameters Description Instrument identifier 1...Nchan Requested parameters for the acquired waveform. Name dataArray Type ViAddr dataDesc AqDataDescriptor segDescArray ViAddr Description User-allocated waveform destination array.
nbrSamplesInSeg ViInt32 segmentOffset ViInt32 dataArraySize ViInt32 segDescArraySize ViInt32 flags ViInt32 Requested number of samples, may assume 1 to the actual number of samples. ONLY used for readMode = 1 in DIGITIZERS: Requested offset, in number of samples, between adjacent segments in the destination buffer dataArray. Must be ≥ nbrSamplesInSeg Number of bytes in the user-allocated dataArray. Used for verification / protection. Number of bytes in the user-allocated segDescArray.
Segment Descriptor for Raw Sequence Waveforms (readMode = 11) in AqSegmentDescriptorSeqRaw Name horPos timeStampLo timeStampHi indexFirstPoint actualSegmentSize reserved Type ViReal64 ViUInt32 ViUInt32 ViUInt32 ViUInt32 ViInt32 Description Horizontal position of first data point. Low and high part of the 64-bit trigger timestamp. See discussion below.
In this table ‘X’ means that the functionality is available depending on the option but independent of the model, '8' means that the functionality is available for 8-bit Digitizers and AP units in the digitizer mode, '10' means that it is available for the 10-bit Digitizers, '12' means that it is available for the 12-bit Digitizers.
o o with readMode = 0 and dataType = 3, the array size in bytes must be at least max(40,8*nbrSamplesInSeg) for 8-bit digitizers and max(88,8*nbrSamplesInSeg) for 10-bit and 12-bit digitizers. with readMode = 1 or readMode = 11 the waveform destination array dataArray must not only allocate enough space to hold the requested data, but also some additional space.
avgOvfl, avgStatus and avgMax will apply to Signal Averagers only. The features that they support have not yet been implemented. The value of segmentOffset must be ≥ nbrSamplesInSeg. The waveforms are thus transferred sequentially into a single linear buffer, with 'holes' of length (segmentOffset – nbrSamplesInSeg) between them. Such 'holes' could be used for depositing additional segment-specific information before storing the entire sequence as a single array to disk.
Acqiris Dx.lvlib: (or Aq Dx) Read Averager Data.vi This Vi is polymorphic, the sample data is returned in an array of type I32 or DBL It is meant for the readout of an averager with readMode = 2. Acqiris Dx.lvlib: (or Aq Dx) Read Gated Data.vi It is meant for the readout of an analyzer with readMode = 3. Acqiris Dx.lvlib: (or Aq Dx) Read Peaks Data.vi This Vi is polymorphic, the sample data is returned in an array of type I32 or DBL It is meant for the readout of an analyzer with readMode = 4.
Visual Basic Representation ReadData (ByVal instrumentID As Long, _ ByVal channel As Long, _ readPar As AqReadParameters, _ dataArray As Any, _ dataDesc As AqDataDescriptor, _ segDescArray As Any) As Long Note: For readPar.readMode = 1 you must use dataType=3; Visual Basic .
2.3.87 AcqrsD1_readFCounter Purpose Returns the result of a frequency counter measurement Parameters Input Name instrumentID Type ViSession Instrument identifier Description Type ViReal64 Description Result of measurement Type ViStatus Description Refer to Table 2-1 for error codes.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_readFCounter(ViSession instrumentID, ViReal64* result); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Read FCounter.vi Visual Basic Representation ReadFCounter (ByVal instrumentID As Long, result As Double) As Long Visual Basic .
2.3.88 AcqrsD1_reportNbrAcquiredSegments Purpose Returns the number of segments already acquired for a digitizer. For averagers (but not AP100 or AP200) it will give the number of triggers already accepted for the current acquisition. In the case of analyzers it will return the value 1 at the end of the acquisition and is therefore not of much use.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_reportNbrAcquiredSegments( ViSession instrumentID, ViInt32* nbrSegments); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Query Number of Acquired Segments.vi Visual Basic Representation ReportNbrAcquiredSegments (ByVal instrumentID As Long, _ nbrSegments As Long) As Long Visual Basic .
2.3.89 AcqrsD1_reset (DEPRECATED) Purpose Resets an instrument. See Acqrs_reset. Parameters Input Name instrumentID Type ViSession Instrument identifier Description Type ViStatus Description Refer to Table 2-1 for error codes. Return Value Name status Discussion There is no known situation where this action is to be recommended. LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_reset(ViSession instrumentID); LabVIEW Representation Please refer to Acqrs_reset.
2.3.90 AcqrsD1_resetDigitizerMemory Purpose Resets the digitizer memory to a known default state. Parameters Input Name instrumentID Type ViSession Instrument identifier Description Type ViStatus Description Refer to Table 2-1 for error codes. Return Value Name status Discussion Each byte of the digitizer memory is overwritten sequentially with the values 0xaa, 0x55, 0x00 and 0xff. This functionality is mostly intended for use with battery backed-up memories.
2.3.91 AcqrsD1_restoreInternalRegisters Purpose Restores some internal registers of an instrument. Only needed after power-up of a digitizer with the battery back-up option. Parameters Input Name instrumentID delayOffset Type ViSession ViReal64 delayScale ViReal64 Description Instrument identifier Global delay offset, should be retrieved with Acqrs_getInstrumentInfo (…, “DelayOffset”, ..) before power-off If not known, use the value –20.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_restoreInternalRegisters( ViSession instrumentID, ViReal64 delayOffset, ViReal64 delayScale); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Restore Internal Registers.vi Visual Basic Representation RestoreInternalRegisters (ByVal instrumentID As Long, ByVal delayOffset As Double, ByVal delayScale As Double) As Long Visual Basic .
2.3.92 AcqrsD1_setAttributeString (DEPRECATED) Purpose Sets an attribute with a string value (for use in SC Streaming Analyzers ONLY). See Acqrs_setAttributeString. Parameters Input Name instrumentID channel name Type ViSession ViInt32 ViConstString value ViConstString Description Instrument identifier 1...Nchan ASCII string that specifies options “odlTxBitRate” is currently the only one used For “odlTxBitRate” can have values like “2.5G”,”2.125G”, or “1.
2.3.93 AcqrsD1_setLEDColor (DEPRECATED) Purpose Sets the front panel LED to the desired color. See Acqrs_setLEDColor. Parameters Input Name instrumentID color Type ViSession ViInt32 Description Instrument identifier 0 = OFF (return to normal acquisition status indicator) 1 = Green 2 = Red 3 = Yellow Type ViStatus Description Refer to Table 2-1 for error codes.
2.3.94 AcqrsD1_setSimulationOptions (DEPRECATED) Purpose Sets one or several options which will be used by the function AcqrsD1_InitWithOptions, provided that the optionsString supplied to AcqrsD1_InitWithOptions contains the string "simulate=TRUE". See Acqrs_setSimulationOptions Parameters Input Name simOptionString Type ViString Description String listing the desired simulation options. See discussion below. Type ViStatus Description Refer to Table 2-1 for error codes.
2.3.95 AcqrsD1_stopAcquisition Purpose Stops the acquisition. Parameters Input Name instrumentID Type ViSession Instrument identifier Description Type ViStatus Description Refer to Table 2-1 for error codes. Return Value Name status Discussion This function will stop the acquisition and not return until this has been accomplished. The data is not guaranteed to be valid. To obtain valid data after "manually" stopping the acquisition (e.g.
2.3.96 AcqrsD1_stopProcessing Purpose Stops on-board data processing. This routine is for Analyzers only. Parameters Input Name instrumentID Type ViSession Instrument identifier Description Type ViStatus Description Refer to Table 2-1 for error codes. Return Value Name status Discussion This function will stop the on-board data processing immediately. The output data is not guaranteed to be valid.
2.3.97 AcqrsD1_waitForEndOfAcquisition Purpose Waits for the end of acquisition. Parameters Input Name instrumentID timeout Type ViSession ViInt32 Description Instrument identifier Timeout in milliseconds Type ViStatus Description Refer to Table 2-1 for error codes. Return Value Name status Discussion This function will return only after the acquisition has terminated or when the requested timeout has elapsed, whichever comes first.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_waitForEndOfAcquisition (ViSession instrumentID, ViInt32 timeout); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Wait For End Of Acquisition.vi Visual Basic Representation WaitForEndOfAcquisition (ByVal instrumentID As Long, _ ByVal timeout As Long) As Long Visual Basic .
2.3.98 AcqrsD1_waitForEndOfProcessing Purpose Waits for the end of on-board data processing. . This routine is for Analyzers only. Parameters Input Name instrumentID timeout Type ViSession ViInt32 Description Instrument identifier Timeout in milliseconds Type ViStatus Description Refer to Table 2-1 for error codes. Return Value Name status Discussion This function will return only after the on-board processing has terminated or when the requested timeout has elapsed, whichever comes first.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsD1_waitForEndOfProcessing(ViSession instrumentID, ViInt32 timeout); LabVIEW Representation Acqiris Dx.lvlib: (or Aq Dx) Wait For End Of Processing.vi Visual Basic Representation WaitForEndOfProcessing (ByVal instrumentID As Long, _ ByVal timeout As Long) As Long Visual Basic .
2.3.99 AcqrsT3_acqDone Purpose Checks if the acquisition has terminated. Parameters Input Name instrumentID Type ViSession Description Instrument identifier Output Name done Type ViBoolean Description done = VI_TRUE if the acquisition is terminated VI_FALSE otherwise Type ViStatus Description Refer to Table 2-1 for error codes.
2.3.100 AcqrsT3_acquire Purpose Starts an acquisition. Parameters Input Name instrumentID Type ViSession Instrument identifier Description Type ViStatus Description Refer to Table 2-1 for error codes. Return Value Name status Discussion LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsT3_acquire(ViSession instrumentID); LabVIEW Representation Acqiris Tx.lvlib: (or Aq Tx) Start Acquisition.
2.3.101 AcqrsT3_configAcqConditions Purpose Configures parameters effecting the entire acquisition. Parameters Input Name instrumentID timeout flags Type ViSession ViReal64 ViInt32 reserved ViInt32 Description Instrument identifier Timeout in seconds The LSB (bit 0) = 0 start timeout counter on Arm = 1 start timeout counter on first Common hit Currently unused, set to “0” Type ViStatus Description Refer to Table 2-1 for error codes. Return Value Name status Discussion The timeout value of 0.
2.3.102 AcqrsT3_configChannel Purpose Configures parameters for defining timing events on each channel.
2.3.103 AcqrsT3_configControlIO Purpose Configures the auxiliary I/O connectors. Parameters Input Name instrumentID connector Type ViSession ViInt32 signal qualifier1 ViInt32 ViInt32 qualifier2 ViReal64 Description Instrument identifier Connector Number 1 = Front Panel I/O Aux 1 2 = Front Panel I/O Aux 2 13 = Front Panel Veto Input See below If the LSB (bit0) is set to 1 forces 50 Ohm termination for the connector Currently unused, set to “0.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsT3_configControlIO (ViSession instrumentID, ViInt32 connector, ViInt32 signal, ViInt32 qualifier1, ViReal64 qualifier2); LabVIEW Representation Acqiris Tx.lvlib: (or Aq Tx) Configure Control I/O.
2.3.104 AcqrsT3_configMemorySwitch Purpose Configures the memory bank switch triggering events. TC890 only.
2.3.105 AcqrsT3_configMode Purpose Configures parameters for the operating mode of the instrument.
2.3.106 AcqrsT3_getAcqConditions Purpose Returns the current acquisition parameters of the Time-to-Digital Converter. Parameters Input Name instrumentID Type ViSession Description Instrument identifier Output Name timeout flags Type ViReal64 ViInt32 reserved ViInt32 Description Timeout in seconds The LSB (bit 0) = 0 start timeout counter on Arm = 1 start timeout counter on first Common hit Currently unused, set to “0” Type ViStatus Description Refer to Table 2-1 for error codes.
2.3.107 AcqrsT3_getChannel Purpose Returns the current channel parameters of the Time-to-Digital Converter.
2.3.108 AcqrsT3_getControlIO Purpose Returns the current configuration of the auxiliary I/O connectors.
2.3.109 AcqrsT3_getMemorySwitch Purpose Returns the current channel parameters of the memory bank switch operation.
2.3.110 AcqrsT3_getMode Purpose Returns the current operational mode of the Time-to-Digital Converter.
2.3.111 AcqrsT3_readData Purpose Returns all Time-to-Digital Converter information. The sample data is returned in a model dependent form and as specified in the AqT3ReadParameters structure. Parameters Input Name instrumentID channel readPar Type ViSession ViInt32 AqT3ReadParameters Description Instrument identifier Reserved for future use (must be set to 0) Requested parameters for the acquired data.
Discussion All structures used in this function can be found in the header files AcqirisT3Interface.h and AcqirisDataTypes.h. The type of the dataArray is determined from the AqT3ReadParameters struct entry dataType. dataType = 4 is used for raw data. For example, the 32-bit natural readout of the TC890 TOF multihit mode is of AqT3SampleType AqT3Struct50ps6ch and has the following format: 31 Overflow 28-30 Channel 0-27 Data where Channel = 1…6 denotes the physical channels.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsT3_readData(ViSession instrumentID, ViInt32 channel, AqT3ReadParameters* readPar, AqT3DataDescriptor* dataDesc); LabVIEW Representation Acqiris Tx.lvlib: (or Aq Tx) Read Data.
2.3.112 AcqrsT3_readDataInt32 Purpose Returns all Time-to-Digital Converter information. The sample data is returned in a model dependent form and as specified in the AqT3ReadParameters structure. Parameters Input Name instrumentID channel readPar Type ViSession ViInt32 AqT3ReadParameters Description Instrument identifier Reserved for future use (must be set to 0) Requested parameters for the acquired data.
Discussion All structures used in this function can be found in the header files AcqirisT3Interface.h and AcqirisDataTypes.h. The type of the dataArray is determined from the AqT3ReadParameters struct entry dataType. dataType = 4 is used for raw data. For example, the 32-bit natural readout of the TC890 TOF multihit mode is of AqT3SampleType AqT3Struct50ps6ch and has the following format: 31 Overflow 28-30 Channel 0-27 Data where Channel = 1…6 denotes the physical channels.
LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsT3_readDataInt32(ViSession instrumentID, ViInt32 channel, AqT3ReadParameters* readPar, ViInt32* dataArrayP, AqT3DataDescriptor* dataDesc); LabVIEW Representation Use the polymorphic Acqiris Tx.lvlib: (or Aq Tx) Read Data.
2.3.113 AcqrsT3_readDataReal64 Purpose Returns all Time-to-Digital Converter information. The sample data is returned in a model dependent form and as specified in the AqT3ReadParameters structure. Parameters Input Name instrumentID channel readPar Type ViSession ViInt32 AqT3ReadParameters Description Instrument identifier Reserved for future use (must be set to 0) Requested parameters for the acquired data.
All structures used in this function can be found in the header files AcqirisT3Interface.h and AcqirisDataTypes.h. The type of the dataArray is determined from the AqT3ReadParameters struct entry dataType. dataType = 3 is used for double floating-point format time results. These results are always in seconds. The dataSizeInBytes must fulfill the storage requirement for the raw data read from the device.
2.3.114 AcqrsT3_stopAcquisition Purpose Stops the acquisition. Parameters Input Name instrumentID Type ViSession Instrument identifier Description Type ViStatus Description Refer to Table 2-1 for error codes. Return Value Name status Discussion This function will stop the acquisition and not return until this has been accomplished. LabWindowsCVI/Visual C++ Representation ViStatus status = AcqrsT3_stopAcquisition(ViSession instrumentID); LabVIEW Representation Acqiris Tx.
2.3.115 AcqrsT3_waitForEndOfAcquisition Purpose Waits for the end of acquisition. Parameters Input Name instrumentID timeout Type ViSession ViInt32 Description Instrument identifier Timeout in milliseconds Type ViStatus Description Refer to Table 2-1 for error codes. Return Value Name status Discussion This function will return only after the acquisition has terminated or when the requested timeout has elapsed, whichever comes first.
