Python Measurement Variables

Input Variables

When Infiniium starts a user-measurement script, the following variables are passed to the script as key:value pairs in a dictionary. Any variables that you defined with the <Variable> XML element are also passed to the script. For example, your script will start with the function definition shown below. The input variables are passes in the variables dictionary. In the second line, the function uses the SrcData dictionary key to assign the value which is the input waveform to the SrcData variable.

def algorithm(variables):
    SrcData = variables['SrcData']
    …
    …

In your script, you can print the output variables to the Show Output window as demonstrated in Lesson 2 (see Lesson 2. Creating a "Show Vars" User Measurement Script) and explained in Python Measurement Troubleshooting.

'SrcData': array([[0,0,0,…,0,0],
[0,0,0,…,0,0],
[0,0,0,…,0,0],
…
[0,0,0,…,0,0],
[0,0,0,…,0,0]], dtype=uint32)

'Markers': [
{'Status': 'Correct','Source': 'Channel 1','Name': 'X1,'Position': 1.01033e-10},
{'Status': 'Correct','Source': 'Channel 1','Name': 'X2,'Position': 1.28445e-10},
{'Status': 'Correct','Source': 'Channel 1','Name': 'X3,'Position': 1.50625e-10},
{'Status': 'Correct','Source': 'Channel 1','Name': 'X4,'Position': 1.78664e-10}]

'MeasurementData':[
{'Name': 'Amplitude', 'Status': 'Correct', 'Source1': 'Channel 1', 'Result': 0.496241, 'Units':'Volt'},
{'Name': 'Peak-Peak', 'Status': 'Correct', 'Source2': 'Channel 2', 'Result': 0.514348, 'Units':'Volt'},
 ....]

Output Variables

This topic lists the variables whose values are returned to Infiniium when your script completes. The Result variable must be set in your script. The remaining variables may be returned, if needed. For Python scripts, these variables are returned in a dictionary.