weisang.com > Documents Articles > ReadLeCroyWaveformFile (FPScript)

FlexPro Documentation

ReadLeCroyWaveformFile (FPScript)

21.09.2021

Reads a LeCroy Waveform file as a signal.

ReadLeCroyWaveformFile(File, [ CalendarTime = FALSE ] [ , ChannelNumber ])

The syntax of the ReadLeCroyWaveformFile function consists of the following parts:

Part	Description
File	String with the path of the LeCroy Waveform file to be read. Permitted data structures are scalar value. Supported data types are string (file name). If the argument is a list, then the function is executed for each element of the list and the result is also a list.
CalendarTime	Boolean value specifying that the time data are to be read as calendar times. Otherwise, the X component provides the time in seconds. Permitted data structures are scalar value. Supported data types are Boolean value. If the argument is a list, then the first element in the list is taken. If this is also a list, then the process is repeated. If this argument is omitted, it will be set to the default value FALSE.
ChannelNumber	Specifies the number of the channel to be read from the file. The channel number is needed only for LiteRunner WaveForm files. Permitted data structures are scalar value. All integral data types are permitted. The value must be greater or equal to 1 and less or equal to 2. If the argument is a list, then the function is executed for each element of the list and the result is also a list.

Part

Description

File

String with the path of the LeCroy Waveform file to be read.

Permitted data structures are scalar value. Supported data types are string (file name).

If the argument is a list, then the function is executed for each element of the list and the result is also a list.

CalendarTime

Boolean value specifying that the time data are to be read as calendar times. Otherwise, the X component provides the time in seconds.

Permitted data structures are scalar value. Supported data types are Boolean value.

If the argument is a list, then the first element in the list is taken. If this is also a list, then the process is repeated.

If this argument is omitted, it will be set to the default value FALSE.

ChannelNumber

Specifies the number of the channel to be read from the file. The channel number is needed only for LiteRunner WaveForm files.

Permitted data structures are scalar value. All integral data types are permitted.

The value must be greater or equal to 1 and less or equal to 2.

If the argument is a list, then the function is executed for each element of the list and the result is also a list.

FlexPro View, Basic, Professional, Developer Suite

ReadLeCroyWaveformFile("c:\\examples\\file.wfm", TRUE, 1)

Imports the first channel from a LiteRunner WaveForm file. The X component provides the time in calendar time format.