fosanalysis
A framework to evaluate distributed fiber optic sensor data
Loading...
Searching...
No Matches
fosanalysis.datahandling.filereader.FileReader Class Reference

Abstract class. More...

Inheritance diagram for fosanalysis.datahandling.filereader.FileReader:

Public Member Functions

 __init__ (self, *args, **kwargs)
 Constructs a FileReader object.
 
tuple read_dat_file (self, dat_file, *args, **kwargs)
 Reads only single file and returns all measurement data separated by channels.
 
tuple read_meta_infos (self, *args, **kwargs)
 Abstract method to get meta and base data of the data file.
 
tuple read_next_measurement (self, *args, **kwargs)
 Returns single measurement of the strain data.
 
- Public Member Functions inherited from fosanalysis.utils.base.Base
 __init__ (self, *args, **kwargs)
 Construct the object and warn about unused/unknown arguments.
 

Detailed Description

Abstract class.

It specifies the basic interface for reading a data file.

Definition at line 88 of file filereader.py.

Constructor & Destructor Documentation

◆ __init__()

fosanalysis.datahandling.filereader.FileReader.__init__ ( self,
* args,
** kwargs )

Constructs a FileReader object.

Needs to be reimplemented by sub-classes.

Definition at line 94 of file filereader.py.

Here is the call graph for this function:
Here is the caller graph for this function:

Member Function Documentation

◆ read_dat_file()

tuple fosanalysis.datahandling.filereader.FileReader.read_dat_file ( self,
dat_file,
* args,
** kwargs )

Reads only single file and returns all measurement data separated by channels.

Reimplemented in fosanalysis.datahandling.filereader.DatReader, and fosanalysis.datahandling.filereader.TsvReader.

Definition at line 118 of file filereader.py.

◆ read_meta_infos()

tuple fosanalysis.datahandling.filereader.FileReader.read_meta_infos ( self,
* args,
** kwargs )

Abstract method to get meta and base data of the data file.

It contains gages/segments, x-axis and tare of all available sensors.

Reimplemented in fosanalysis.datahandling.filereader.DatReader, and fosanalysis.datahandling.filereader.TsvReader.

Definition at line 102 of file filereader.py.

◆ read_next_measurement()

tuple fosanalysis.datahandling.filereader.FileReader.read_next_measurement ( self,
* args,
** kwargs )

Returns single measurement of the strain data.

Reimplemented in fosanalysis.datahandling.filereader.DatReader, and fosanalysis.datahandling.filereader.TsvReader.

Definition at line 111 of file filereader.py.


The documentation for this class was generated from the following file: