Jackson Labs PHASE STATION 53100A, User Manual

Page: 147 / 225

PhaseStation 53100A User’s Manual V1.04 25-Apr-2022 147
AcqNumChannels()
Returns the number of acquisition channels in the measurement associated with the
script instance.
In scripts that perform only standard single-channel acquisitions, this function always
returns 1.
AcqParam(String key)
AcqStrParam(String key)
AcqNumParam(String key)
Each script instance maintains a dictionary of acquisition parameters that can be used to
override any or all of the default acquisition dialog parameters when
AcqStartAcquisition()
is called.
AcqStrParam()
and
AcqNumParam()
return string or numeric values, respectively,
for the specified acquisition parameter.
If an existing plot is associated with the script instance, these functions will return the
specific value associated with the plot. Otherwise, if the script has not yet started a
measurement,
AcqStrParam()
and
AcqNumParam()
will return the value from the dictionary
of initial parameters that will be passed to
AcqStartAcquisition()
. In either case, an attempt
to look up an unrecognized parameter value will return an empty string.
The
AcqParam()
function is equivalent to
AcqStrParam()
, and is deprecated as a function
name. New scripts should use
AcqStrParam()
or
AcqNumParam()
instead, depending on
whether the parameter should be evaluated as a numeric value or as an arbitrary string.
See
AcqSetParam()
and
AcqClearParams()
for more information.
AcqReadAMNoiseTrace(Number offset_Hz)
AcqReadPMNoiseTrace(Number offset_Hz)
These functions return the current AM noise or phase noise level in dBc/Hz at the
specified offset from the carrier. A value greater than 0 indicates that data is
unavailable, either because the AM noise or phase noise trace has not yet been
displayed or because noise data from the FFT segment containing the specified offset
frequency is not yet available.
Values returned by these functions are based on the most recent AM noise or phase
noise trace rendered. Scripts should use
MeasurementSelectView()
or
MeasurementDeferSelectView()
to select the appropriate measurement view prior to
attempting to read noise trace values. Typically this is done from within an
EventTimer()
event handler, in order to ensure that valid data is available during a subsequent timer
event.