Jackson Labs PHASE STATION 53100A, User Manual

Page: 156 / 225

PhaseStation 53100A User’s Manual V1.04 25-Apr-2022 156
Important
: Keep in mind that JavaScript execution does not disable or inhibit the rest of
the TimeLab user interface. While test masks are easy to create and use in TimeLab,
script-based mask evaluation is complicated by the need to establish the correct
measurement view, allow enough time for the display to update, and wait for valid
results to become available for the X-axis range covered by the mask, all while allowing
for the user’s ability to switch measurement views, move plots up and down in the
legend table, or alter other settings manually at any time.
Typically the best way to coordinate the necessary script actions while allowing for
manual user intervention is to use an
EventTimer()
handler to check the mask results and
the current measurement view selection at the same time, then make any changes
(such as selecting the next measurement view for evaluation) at the very end of the
timer handler. Script authors are
strongly
encouraged to use the
EventTimer()
handler in
53100A_performance_test.js as a model for their own mask-test procedures.
MaskResultValid([Number mask_num])
Returns true if valid data is available from
MaskResultMargin()
, or false if the mask test was
not ready for evaluation for any reason. For example, ADEV mask results will not be
available if the measurement has not yet run long enough to return valid data at the tau
corresponding to the left endpoint of the mask limit line, or if the user has turned
visibility off for the plot associated with the script. Always check
MaskResultValid()
prior to
calling
MaskResultMargin()
.
The optional
mask_num
parameter ranges from 0 to 2, defaulting to 0 if not specified.
See
MaskResultMargin()
for other notes on scripted mask tests.
MaskSelect([String mask_name [, Number mask_num])
This function selects a mask for use with
MaskResultMargin()
and
MaskResultValid()
, returning
the previously-selected mask if any.
The
mask_num
parameter ranges from 0 to 2, defaulting to 0 if not specified.
Specifying an empty string (“”) for
mask_name
will deselect the mask in the specified slot,
or deselect all masks if
mask_num
is not specified.
If
mask_name
is omitted, the function returns the currently-selected mask name for slot
0. The function will return an empty string if no mask was selected.
Mask names should be specified
exactly
as they appear in the masks.txt file accessed via
Masks→Edit mask definitions (which also determines the names under which they are
added to the Masks menu). See
MaskResultMargin()
for other notes on scripted mask
tests.