RNStream¶

physiolabxr.utils.RNStream¶

class physiolabxr.utils.RNStream¶

RNStream is a class that provides a simple interface for serialization and deserialization of multimodal data streams. You can read more about its usage in the Recording page.

__init__(file_path)¶

Create a RNStream object, associate it with a file path.

Parameters:¶

file_path : str¶

the file path to which the stream will be written to or read from. When stream_out is called. If the file exists, calling stream_out will append data to the end of the file. If the file does not exist, it will be created.

stream_out(buffer)¶

serialize the content of the buffer to the file path pointed by self.fn

Parameters:¶

buffer : dict¶

a dictionary, key is a string for stream name, value is a iterable of two ndarray the first of the two ndarray is the data samples, the second of the two ndarray are the timestamps of the data samples. The time axis for the data array must be the last. The timestamp array must have exactly one dimension (the time dimension). The data and timestamps rray must have the same length in their time dimensions. The timestamps array must also in a increasing order, otherwise a warning will be raised

Returns:¶

the total number of bytes that has been streamed out.

Return type:¶

int

stream_in(ignore_stream=None, only_stream=None, jitter_removal=True, reshape_stream_dict=None)¶

Streams in data.

Parameters:¶

ignore_stream : list¶

List of streams that should be ignored.

only_stream : list¶

List of streams that will only be streamed in.

jitter_removal : bool¶

If true, the jitter will be removed from the data.

reshape_stream_dict : list¶

reshape img, time series, time frames data

Returns:¶

a dictionary, key is a string for stream name, value is a iterable of two ndarray: the first of the two ndarray is the data samples, the second of the two ndarray are the timestamps of the data samples.

Return type:¶

dict

stream_in_stepwise(file, buffer, read_bytes_count, ignore_stream=None, only_stream=None, jitter_removal=True, reshape_stream_dict=None)¶

Streams in data from a file stepwise, allowing for incremental reading and processing.

Parameters:¶

file : str¶

The file name to read from.

buffer : dict¶

a dictionary, key is a string for stream name, value is a iterable of two ndarray: the first of the two ndarray is the data samples, the second of the two ndarray are the timestamps of the data samples.

read_bytes_count : float¶

The number of bytes to read from the file.

ignore_stream : list¶

List of streams that should be ignored.

only_stream : list¶

List of streams that will only be streamed in.

jitter_removal : bool¶

If true, the jitter will be removed from the data.

reshape_stream_dict : list¶

reshape img, time series, time frames data

Returns:¶

Five elements tuple that consists:

• file : str: The updated file;

• buffer : dict: a dictionary, key is a string for stream name, value is a iterable of two ndarray: the first of the two ndarray is the data samples, the second of the two ndarray are the timestamps of the data samples;

• read_bytes_count : float: Total number of bytes in the file;

• total_bytes : int : the total number of bytes in the file;

• finished: bool : True if the file has been read completely, False otherwise

Return type:¶

tuple

Example using RNStream¶