pyepr.hardware.ETH_awg_load¶

Attributes¶

default_labels

Functions¶

`uwb_load`(matfile[, options, verbosity, compress, ...])	uwb_load This function is based upon the uwb_eval matlab function
`uwb_eval_match`(matfile[, sequence, scans, mask, ...])
`find_max_pulse_length`(estr)
`digitally_upconvert`(t, complex, fc)
`calc_percieved_freq`(sampling_freq, fc)
`match_filter_dc`(pulse, t, win, offset_freq)
`scipy_filter_dc`(dta, t, filter_width, offset_freq, ...)
`extract_data`(matfile, estr)
`get_metadata`(estr, conf)
`detect_pulse_type`(pulse)
`get_pulse_metadata`(pulse, i)
`get_dig_level`(data, metadata, conf)
`get_nPcyc`(estr)
`get_coords`(parvars)
`ETHUWB_xarray_load`(matfile[, sum_scans])	This function reads data from an Andrin Doll ETH UWB EPR spectrometer

Module Contents¶

pyepr.hardware.ETH_awg_load.uwb_load(matfile, options=dict(), verbosity=0, compress=True, mask=None, sequence=None)[source]¶

uwb_load This function is based upon the uwb_eval matlab function developed by Andrin Doll. This is mostly a Python version of this software,

for loading data generated by Doll style spectrometers.

Parameters:

matfilenp.ndarray: _description_
optionsdict, optional: _description_, by default None
compressbool, optional: Compresses all the scans into a single scan.

Parameters:

matfile (numpy.ndarray)
options (dict)
compress (bool)

pyepr.hardware.ETH_awg_load.uwb_eval_match(matfile, sequence=None, scans=None, mask=None, filter_pulse=None, filter_type='match', filter_width=None, verbosity=0, corr_phase=False, **kwargs)[source]¶

Parameters:

matfilenp.ndarray: The data file to be loaded.
sequencead.Sequence, optional: The sequence used to generate the data.
scanslist, optional: The scans to be loaded.
masklist, optional: The mask to be used.
filter_pulseepr.Pulse, optional: The pulse to be used as a matched filter. If None, the maximum pulse width will be used. This is only used if filter_type is ‘match’
filter_typestr, optional: The type of filter to be used. Options are ‘match’, ‘cheby2’ and ‘butter. Default is ‘match’
filter_widthfloat, optional: The width of the filter to be used. This is only used if filter_type is ‘cheby2’ or ‘butter’
verbosityint, optional: The verbosity of the function. Default is 0.
corr_phase: bool, optional: If True each echo is idenpendently phased, if false then it is globally phased. If a vector is applied then this is used phase them. Default is False

pyepr.hardware.ETH_awg_load.find_max_pulse_length(estr)[source]¶

pyepr.hardware.ETH_awg_load.digitally_upconvert(t, complex, fc)[source]¶

pyepr.hardware.ETH_awg_load.calc_percieved_freq(sampling_freq, fc)[source]¶

pyepr.hardware.ETH_awg_load.match_filter_dc(pulse, t, win, offset_freq)[source]¶

pyepr.hardware.ETH_awg_load.scipy_filter_dc(dta, t, filter_width, offset_freq, sampling_freq, filter_type='cheby2')[source]¶

pyepr.hardware.ETH_awg_load.extract_data(matfile, estr)[source]¶

pyepr.hardware.ETH_awg_load.get_metadata(estr, conf)[source]¶

pyepr.hardware.ETH_awg_load.detect_pulse_type(pulse)[source]¶

pyepr.hardware.ETH_awg_load.get_pulse_metadata(pulse, i)[source]¶

pyepr.hardware.ETH_awg_load.get_dig_level(data, metadata, conf)[source]¶

pyepr.hardware.ETH_awg_load.get_nPcyc(estr)[source]¶

pyepr.hardware.ETH_awg_load.default_labels = ['X', 'Y', 'Z', 'T'][source]¶

pyepr.hardware.ETH_awg_load.get_coords(parvars)[source]¶

pyepr.hardware.ETH_awg_load.ETHUWB_xarray_load(matfile, sum_scans=True)[source]¶

This function reads data from an Andrin Doll ETH UWB EPR spectrometer and converts it into an xarray.Dataset format compatible with PyEPR.

Parameters:

matfiledict: The data file to be loaded.
sum_scansbool, optional: Whether to sum all scans or not. Default is True.
Returns
——-
outputxarray.Dataset: The data in the xarray format.