ReadDataFile (FPScript)
Reads an element, such as a channel, from a data file.
Syntax
ReadDataFile(File, FormatIdentifier, Element, [ CalendarTime = FALSE ], [ Signal = FALSE ], [ XElement ], [ RangeFrom ], [ RangeTo ], [ Duration ], [ DataRange = READDATAFILE_DR_COMPLETE ], [ CustomProperties ] [ , PostProcessing ])
The syntax of the ReadDataFile function consists of the following parts:
Part |
Description |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
File |
String with the path of the 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. |
||||||||||||
FormatIdentifier |
String with text that identifies a supported format (see remarks). Permitted data structures are scalar value. Supported data types are string. 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. |
||||||||||||
Element |
Index of the element to be read out of the file if an integer is specified. Usually, elements representing analog data are numbered with positive values starting with one, and digital data are numbered as negative values. Name of the element to be read out of the file if a string is specified. With hierarchical file formats the complete element path needs to be entered if the name is not unique in the file. Zero is reserved for time data. Permitted data structures are scalar value. Supported data types are 16-bit integer, 32-bit integer, 64-bit integer und string. 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 since the start of the measurement or relative to the trigger time. This argument may not be supported for the selected format (see remarks) and may possibly be ignored. 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. |
||||||||||||
Signal |
Boolean value specifying that elements are to be imported as signals. This argument may not be supported for the selected format (see remarks) and may possibly be ignored. 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. |
||||||||||||
XElement |
Index of the element to be used for the X data if an integer is specified. This index is used only for formats that require manual assignment of the X data element. Name of the element to be read out of the file if a string is specified. Permitted data structures are scalar value. Supported data types are 16-bit integer, 32-bit integer, 64-bit integer und string. 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. |
||||||||||||
RangeFrom |
Absolute or relative time of the first value to read if the element Element is not to be read from the beginning. If CalendarTime is set to True a calendar time value is expected here; otherwise a floating point value is expected. If the argument is not provided, the element specified by Element is read starting from the first value onward. This argument may not be supported for the selected format (see remarks) and may possibly be ignored. Permitted data structures are scalar value. All real data types are permitted. 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. |
||||||||||||
RangeTo |
Absolute or relative time of the last value to read if the Element element is not to be read to the end. If CalendarTime is set to True a calendar time value is expected here; otherwise a floating point value is expected. If the argument is not provided, the element specified by Element is read until the last value. This argument is not supported for all formats (see remarks section) and is ignored if not applicable. Permitted data structures are scalar value. All real data types are permitted. 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. |
||||||||||||
Duration |
Duration of the data range. This value must be specified if the element DataRange has the value READDATAFILE_DR_FROMDURATION, READDATAFILE_DR_DURATIONLAST or READDATAFILE_DR_FIRSTDURATION. This argument may not be supported for the selected format (see remarks) and may possibly be ignored. Permitted data structures are scalar value. All real data types are permitted. 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. |
||||||||||||
DataRange |
Value that specifies the type of data range to create. The argument DataRange can have the following values:
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 READDATAFILE_DR_COMPLETE. |
||||||||||||
CustomProperties |
A list with properties dependent on the file format and which significantly affect the data import. Permitted data structures are list. All data types are permitted. The unit of the argument is ignored. |
||||||||||||
PostProcessing |
A string with an FPScript formula which is used to postprocess data. data in this case serves as a placeholder for the element to be included. Example: Maximum(data) Permitted data structures are scalar value. Supported data types are string. 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. |
Remarks
Format |
Description |
File Extensions |
Calendar Time (optional) |
Signal (optional) |
---|---|---|---|---|
A&D RA1000/RA2000 |
File format of the RA1100/RA2x00 recorder series from A&D. |
*.dat;*.drt;*.fsd;*.fpp;*.idx |
True /False |
True |
Agilent InfiniiVision 2000/3000 X-Series |
InfiniiVision 2000/3000 X-Series Oscilloscopes from Agilent Technologies. |
*.bin |
False |
True |
Airbus AIDASS RDF |
AIDASS Recorded Data File format from Airbus. |
*.rdf |
True /False |
True |
ASAM COMMON MDF4 |
Binary file format for measurement data storage published by Association for Standardization of Automation and Measuring Systems (ASAM). |
*.mf4 |
True /False |
True /False |
AstroNova Daxus Data Capture |
Format of the Daxus data acquisition systems by AstroNova. |
*.dcr;*.scr |
True /False |
True |
AVL iFile |
Binary file format from AVL, used for combustion analysis. |
*.* |
False |
True |
Bosch MDF |
Measurement Data Format, used by software such as INCA from ETAS. |
*.mdf;*.dat |
True /False |
True /False |
Data Translation HPF |
High Pperformance File format from Data Translation. |
*.hpf |
True /False |
True /False |
Delphin ProfiSignal |
ProfiSignal HDS file format from Delphin. |
*.hds |
True /False |
True |
DEWESoft D7D/DXD |
DEWESoft 7 and X format from DEWESoft. |
*.d7d;*.dxd |
True /False |
True |
DEWETRON DMD |
DEWETRON Measurement Data format from Dewetron. |
*.dmd |
True /False |
True |
European Data Format EDF |
The European Data Format is used to exchange and store biosignals and other data from biological time series. |
*.edf |
True /False |
True |
Gantner Q.brixx |
Import interface for Q.brixx measuring systems by Gantner. A text file with the .qbrixx extension must be added which contains the measuring system IP address. |
*.qbrixx |
True /False |
True |
Gantner UDBF |
Universal Data Bin File file format from Gantner Instruments. |
*.dat |
True /False |
True /False |
GPS Exchange Format GPX |
GPS Exchange Format GPX from Topografix for GPS data exchange. |
*.gpx |
True /False |
True |
Graphtec WR |
Graphtec recorder files of the GL/WR series. |
*.dat;*.lmd;*.gdb |
True /False |
True |
HBM catman |
File format used by HBM's catman data acquisition software. |
*.bin;*.tst |
True /False |
True /False |
HBM MGCplus MEA |
MGCplus measurement data acquisition system from HBM. |
*.me* |
False |
True |
HBM nSoft Time Series |
nSoft Time Series Format from HBM. |
*.dac |
False |
True /False |
HBM PNRF |
PNRF file format from HBM; Nicolet/Odyssey/Vision NRF file format. |
*.pnrf;*.nrf |
True /False |
True |
HBM SoMat SIE |
SoMat SIE file format from HBM. |
*.sie |
True /False |
True |
HDF Group HDF5 |
Hierarchical Data Format from HDF Group. |
*.h5 |
False |
False |
Head Acoustics HDF |
HEAD acoustics Datafile Format from HEAD Acoustics. |
*.hdf |
True /False |
True |
HIOKI HiCORDER |
HiCORDER recorder series 8835, 8835-01, 8826, 8841, 8842, 8807-01, 8808-01, 8855, 8860, 8861. |
*.mem;*rec;*.fft;*.rms |
True /False |
True |
HP SDF |
Standard Data Format from Hewlett Packard. |
*.sdf;*.* |
False |
True |
IMC FAMOS |
FAMOS file format from IMC. |
*.dat;*.* |
True /False |
True /False |
Kistler Open File |
Open file format from Kistler. |
*.open |
False |
True |
LeCroy WaveJet |
Waveform file format for WaveJet series oscilloscopes. |
*.wfm |
True /False |
True |
MSR Electronics MSR3 |
File format for the MSR data loggers from MSR Electronics. |
*.msrprj;*.msr3 |
True /False |
True |
National Instruments DASYLab |
DASYLab file format from National Instruments. |
*.ddf |
True /False |
True |
National Instruments TDM |
National Instruments TDM file format; National Instruments Streaming TDMS file format. TDMS import does not support the time format. |
*.tdm;*.tdms |
True /False |
True /False |
NMEA 0183 |
National Marine Electronics Association Standard 0183. |
*.nmea;*.* |
True /False |
True |
OROS OXF |
NVGate OXF file format from OROS. |
*.oxf |
False |
True |
Parker Hannifin SMC |
File format from Parker Hannifin. Original measurement files (*.scco) and measurement files modified using communication software (*.sccm) can be read in. |
*.scco;*.sccm;*.scmo |
True /False |
True |
RION WAV |
File format from RION Co.,Ltd., e.g. used by the DA-21 recorder. |
*.wav |
True /False |
True |
SEFRAM Recorder |
Data format of the SEFRAM recorders. |
*.rec |
True /False |
True |
SYSCOM Instruments XMR/BMR |
Data format from SYSCOM Instruments, e.g. used by MR3000 and MR2002 recorder series. |
*.xmr;*.bmr |
True /False |
True |
TiePie TPS |
Multichannel TPS file format from TiePie. |
*.tps |
False |
True |
Unidata NetCDF |
Network Common Data Format, released by Unidata. |
*.nc |
True /False |
False |
UFF |
Universal File Format type 58. |
*.uff;*.unv;*.bunv;*.ufa;*.ufb |
True /False |
True |
Vector CAN |
Binary Logging File format (.blf) and ASCII logging file format (.asc) from Vector. |
*.blf*;*.asc |
True /False |
True |
Yokogawa DXAdvanced |
DXAdvanced format from Yokogawa. |
*.dad;*.dae |
True /False |
True |
Yokogawa MX100 |
MX100 format from Yokogawa. |
*.mxd |
True /False |
True /False |
Yokogawa SmartDAC |
SmartDAC format from Yokogawa. |
*.gev;*.gds |
True /False |
True |
Yokogawa WDF/WVF |
WDF and WVF formats from Yokogawa. |
*.wdf;*.wvf |
True /False |
True |
Available in
FlexPro View, Basic, Professional, Developer Suite
Examples
ReadDataFile("c:\\examples\\file.dat", "IMC FAMOS", 1, FALSE, FALSE) |
Imports the first channel from a FAMOS file. |