Node Documentation¶
This section describes all the nodes in the Scope Module node tree organized by branch.
averager¶
/averager/resamplingmode ¶
Properties: Read, Write
Type: Integer (enumerated)
Unit: None
Specifies the resampling mode. When averaging scope data recorded at a low sampling rate that is aligned by a high resolution trigger, scope data must be resampled to keep the corresponding samples between averaged recordings aligned correctly in time relative to the trigger time.
| Value | Description |
|---|---|
| 0 | "linear": Linear interpolation |
| 1 | "pchip": PCHIP interpolation |
/averager/restart ¶
Properties: Read, Write
Type: Integer (64 bit)
Unit: None
Set to 1 to reset the averager. The module sets averager/restart back to 0 automatically.
/averager/weight ¶
Properties: Read, Write
Type: Integer (64 bit)
Unit: None
Specify the averaging behaviour. weight=0: Averaging disabled. weight>1: Moving average, updating last history entry.
clearhistory¶
/clearhistory ¶
Properties: Read, Write
Type: Integer (64 bit)
Unit: None
Remove all records from the history list.
error¶
/error ¶
Properties: Read
Type: Integer (64 bit)
Unit: None
Indicates whether an error occurred whilst processing the current scope record; set to non-zero when a scope flag indicates an error. The value indicates the accumulated error for all the processed segments in the current record and is reset for every new incoming scope record. It corresponds to the status LED in the LabOne User Interface's Scope tab - API users are recommended to use the flags structure member in ZIScopeWaveEx instead of this output parameter.
externalscaling¶
/externalscaling ¶
Properties: Read, Write
Type: Double
Unit: None
Scaling to apply to the scope data transferred over API level 1 connection. Only relevant for HF2 Instruments.
fft¶
/fft/power ¶
Properties: Read, Write
Type: Integer (64 bit)
Unit: None
Enable calculation of the power value.
/fft/spectraldensity ¶
Properties: Read, Write
Type: Integer (64 bit)
Unit: None
Enable calculation of the spectral density value.
/fft/window ¶
Properties: Read, Write
Type: Integer (enumerated)
Unit: None
FFT Window
| Value | Description |
|---|---|
| 0 | "rectangular": Rectangular |
| 1 | "hann": Hann (default) |
| 2 | "hamming": Hamming |
| 3 | "blackman_harris": Blackman Harris |
| 16 | "exponential": Exponential (ring-down) |
| 17 | "cos": Cosine (ring-down) |
| 18 | "cos_squared": Cosine squared (ring-down) |
historylength¶
/historylength ¶
Properties: Read, Write
Type: Integer (64 bit)
Unit: None
Maximum number of entries stored in the measurement history.
lastreplace¶
/lastreplace ¶
Properties: Read, Write
Type: Integer (64 bit)
Unit: None
Reserved for LabOne User Interface use.
mode¶
/mode ¶
Properties: Read, Write
Type: Integer (enumerated)
Unit: None
The Scope Module's data processing mode.
| Value | Description |
|---|---|
| 0 | "passthrough": Passthrough: scope segments assembled and returned unprocessed, non-interleaved. |
| 1 | "exp_moving_average": Moving average: entire scope recording assembled, scaling applied, averager if enabled (see averager/weight), data returned in float non-interleaved format. |
| 2 | Reserved for future use (average n segments). |
| 3 | "fft": FFT, same as mode 1, except an FFT is applied to every segment of the scope recording before averaging. See the fft/* parameters for FFT parameters. |
records¶
/records ¶
Properties: Read
Type: Integer (64 bit)
Unit: None
The number of scope records that have been processed by the Scope Module since execute() was called or a critical scope setting has been modified (see manual for a list of scope settings that trigger a reset).
save¶
/save/csvlocale ¶
Properties: Read, Write
Type: String
Unit: None
The locale to use for the decimal point character and digit grouping character for numerical values in CSV files: "C": Dot for the decimal point and no digit grouping (default); "" (empty string): Use the symbols set in the language and region settings of the computer.
/save/csvseparator ¶
Properties: Read, Write
Type: String
Unit: None
The character to use as CSV separator when saving files in this format.
/save/directory ¶
Properties: Read, Write
Type: String
Unit: None
The base directory where files are saved.
/save/fileformat ¶
Properties: Read, Write
Type: Integer (enumerated)
Unit: None
The format of the file for saving data.
| Value | Description |
|---|---|
| 0 | "mat": MATLAB |
| 1 | "csv": CSV |
| 2 | "zview": ZView (Impedance data only) |
| 3 | "sxm": SXM (Image format) |
| 4 | "hdf5": HDF5 |
/save/filename ¶
Properties: Read, Write
Type: String
Unit: None
Defines the sub-directory where files are saved. The actual sub-directory has this name with a sequence count (per save) appended, e.g. daq_000.
/save/save ¶
Properties: Read, Write
Type: Integer (64 bit)
Unit: None
Initiate the saving of data to file. The saving is done in the background. When the save has finished, the module resets this parameter to 0.
/save/saveonread ¶
Properties: Read, Write
Type: Integer (64 bit)
Unit: None
Automatically save the data to file immediately before reading out the data from the module using the read() command. Set this parameter to 1 if you want to save data to file when running the module continuously and performing intermediate reads.