Agilent Technologies E1439, User Manual

Page: 99 / 246

89
Agilent E1439 Programmer's Reference
Functions listed alphabetically
age1439_data_scale_get
Gets the data scale factor.
VXI plug&play Syntax
#include "age1439".h
ViStatus age1439_data_scale_get(ViSession id , ViPReal64 scalePtr );
Description
age1439_data_scale_get calculates the correct scale factor for raw data using the current data
resolution and input range. The factor returned by this function is used to multiply raw data to get
data in volts.
When the module is providing only the real part of complex data, the data is doubled to provide
consistent spectrum measurements. This occurs with either shift decimation or when the real part
of a zoomed signal with a non-zero center frequency is taken.
Parameters
id is the VXI instrument session pointer returned by the age1439_init function.
scalePtr points to the calculated scale factor with which to scale raw data to volts.
Return Value
AGE1439_SUCCESS indicates that a function was successful.
Values other than AGE1439_SUCCESS indicate an error condition or other important status
condition. To determine the error message, pass the return value to “age1439_error_message” on
page 102 .
See Also
“age1439_init” on page 132 , “age1439_data_setup” on page 90 , “age1439_read_raw” on
page 162 , “age1439_input_range_auto” on page 137 , “age1439_filter_setup” on page 120