fosanalysis.protocols Namespace Reference

Contains functionality for interfacing files and network ports. More...

Classes
class	ODiSI6100TSVFile
	Data inferface for the .tsv measurement files exported by the ODiSI 6100 series interrogators by Luna Inc [6]. More...
class	Protocol
	Abstract class, which specifies the basic interfaces a protocol must implement. More...
class	SensorRecord
	A single record of the distributed fiber optic strain sensing data. More...

Functions
None	extract_time_intervals (str input_file, str output_file, list list_of_time_intervals)
	Extracts the parts of the measurement data into smaller .tsv files.

Variables
	category

Detailed Description

Contains functionality for interfacing files and network ports.

Author

Bertram Richter

Date

2023–2025

Function Documentation

extract_time_intervals()

None fosanalysis.protocols.extract_time_intervals	(	str	input_file,
		str	output_file,
		list	list_of_time_intervals )

Extracts the parts of the measurement data into smaller .tsv files.

The parts are given by time intervals. The file header is copied as is. A measurement line is copied to the output_file if its timestamp \(t\) falls within at least one of the given time intervals: \(t_{\mathrm{s}} \leq t \leq t_{\mathrm{e}}\). Overlapping intervals are supported.

Note

The output_file is overwritten without asking for confirmation!

Deprecated

This function is deprecated and was moved to fosanalysis.datahandling.tsvustils.extract_time_intervals(). Please use the updated function call

Parameters

input_file	String with the path of the input file (.tsv)
output_file	String with the path of the output file (.tsv)
list_of_time_intervals	List of time intervals. Each interval is given as tuple of its the limits (start time \(t_{\mathrm{s}}\), end time \(t_{\mathrm{e}}\)). Both limits can be either datetime.datetime or None. Setting one or both of the limits to None results in an (half) unlimited open interval. It is not necessary that the exact interval boundaries appear in the data.

Definition at line 599 of file protocols.py.

Variable Documentation

category

fosanalysis.protocols.category

Definition at line 21 of file protocols.py.