File Operations Module¶

Functions for importing, exporting, and saving data in various formats.

Load and Save¶

load_data(parent=None, filename=None)

Loads dataset from filename, or displays a dialog if no argument provided.

save_data(dataset, parent=None, filename=None, overwrite_without_prompt=False)

Saves dataset class to file 'filename.npy', or provides dialog if no filename provided.

Parameters:

dataset (DataSet) –

An object of the class DataSet
parent (optional, default: None ) –

Parent widget for file dialog
filename (str, default: None ) –

Output filename, dialog shown if not provided
overwrite_without_prompt (bool, default: False ) –

If True, overwrite without asking

save_fig(plot, parent=None, figsize=None, filename=None, overwrite_without_prompt=False)

Saves figure to file 'filename.png' and 'filename.pdf', or provides dialog if no filename provided.

Parameters:

plot (PlotData or Figure) –

A PlotData object or matplotlib Figure object
parent (optional, default: None ) –

Parent widget for file dialog
figsize (tuple, default: None ) –

Tuple for figure size
filename (str, default: None ) –

Output filename, dialog shown if not provided
overwrite_without_prompt (bool, default: False ) –

If True, overwrite without asking

export_to_matlab(dataset, parent=None, filename=None, overwrite_without_prompt=False)

Exports dataset class to file 'filename.mat', or provides dialog if no filename provided.

Saved file can be loaded directly in Matlab as set of arrays.

Parameters:

dataset (DataSet) –

An object of the class DataSet
parent (optional, default: None ) –

Parent widget for file dialog
filename (str, default: None ) –

Output filename, dialog shown if not provided
overwrite_without_prompt (bool, default: False ) –

If True, overwrite without asking

export_to_matlab_jwlogger(dataset, parent=None, filename=None, overwrite_without_prompt=False)

Exports dataset class to file 'filename.mat', or provides dialog if no filename provided.

Saved file is compatible with Jim Woodhouse logger file format.

Parameters:

dataset (DataSet) –

An object of the class DataSet
parent (optional, default: None ) –

Parent widget for file dialog
filename (str, default: None ) –

Output filename, dialog shown if not provided
overwrite_without_prompt (bool, default: False ) –

If True, overwrite without asking

export_to_csv(data_list, parent=None, filename=None, overwrite_without_prompt=False)

Exports data to file 'filename.csv', or provides dialog if no filename provided.

Saved file is *.csv

Parameters:

data_list (TimeDataList, FreqDataList, or TfDataList) –

Data list to export
parent (optional, default: None ) –

Parent widget for file dialog
filename (str, default: None ) –

Output filename, dialog shown if not provided
overwrite_without_prompt (bool, default: False ) –

If True, overwrite without asking

import_from_matlab_jwlogger(filename=None)

Imports dataset class from file 'filename.mat', or provides dialog if no filename provided.

Saved file is compatible with Jim Woodhouse logger file format.

Parameters:

filename (str, default: None ) –

Input filename, dialog shown if not provided