scope_example.py

"""Example file to demonstrate the scope functionality."""
import pysignalscope as pss

# Use this line to change the fonts into LaTeX font.
# pss.global_plot_settings_font_latex()

# ------------------------------------------
# Example 1: Read curves from tektronix scope csv file,
#            shift 2 curves
#            plot the signals and perform FFT
# ------------------------------------------

# Read curves from scope csv file
[voltage_prim, voltage_sec, current_prim, current_sec] = pss.Scope.from_tektronix('scope_example_data_tek.csv')

# Add labels and units to channels
voltage_prim = pss.Scope.modify(voltage_prim, label='voltage primary', unit='V')
voltage_sec = pss.Scope.modify(voltage_sec, label='voltage secondary', unit='V')
current_prim = pss.Scope.modify(current_prim, label='current primary', unit='A')
current_sec = pss.Scope.modify(current_sec, label='current secondary', unit='A')

# Gain and DC-offset for the secondary current
current_sec = pss.Scope.modify(current_sec, data_factor=1.3, data_offset=10)

# Plot channels
fig1 = pss.Scope.plot_channels([voltage_prim, voltage_sec], [current_prim, current_sec], timebase='us')
pss.save_figure(fig1, 'scope_fig.pdf')

# Shift first two channels and plot the shift of these channels
shiftlist = pss.Scope.plot_shiftchannels([voltage_prim, voltage_sec])

# print the list
ch_i = 0
for ch_shift in shiftlist:
    print(f"shifts of channel {ch_i}=x->{ch_shift[0]},y->{ch_shift[1]}")
    ch_i = ch_i+1

# short channels to a single period, perform FFT for current waveforms
current_prim = pss.Scope.short_to_period(current_prim, f0=200000)
current_prim = pss.Scope.modify(current_prim, time_shift=5e-6)
pss.Scope.fft(current_prim)

# ------------------------------------------
# Example 2: Read curves from LeCroy csv-Files and GeckoCIRCUITS. Compare these signals.
# ------------------------------------------

meas_v_ob, meas_il_ib, meas_il_ob = pss.Scope.from_lecroy('scope_example_data_lecroy_1.csv', 'scope_example_data_lecroy_2.csv',
                                                          'scope_example_data_lecroy_3.csv')

meas_v_ob = pss.Scope.modify(meas_v_ob, label='vl_ob_meas', unit='V')
meas_il_ib = pss.Scope.modify(meas_il_ib, label='il_ib_meas', unit='A', color='b')
meas_il_ob = pss.Scope.modify(meas_il_ob, label='il_ob_meas', unit='A', color='m', data_offset=1.5)

# read dataset from gecko simulation
gecko_data = pss.Scope.from_geckocircuits('scope_example_data_gecko', f0=200000)

gecko_il_ib = gecko_data[0]
gecko_il_ib = pss.Scope.modify(gecko_il_ib, label='il_ib_gecko', unit='A', color='r', linestyle="--")
gecko_il_ob = gecko_data[-1]
gecko_il_ob = pss.Scope.modify(gecko_il_ob, data_factor=-1, label='il_ob_gecko', unit='A', color='g')

# compare both waveforms
pss.Scope.compare_channels(meas_il_ib, gecko_il_ib, meas_il_ob, gecko_il_ob, shift=[-67.53e-6, 0, -67.53e-6, 0], timebase='us')

# Shift data
meas_il_ob = pss.Scope.modify(meas_il_ob, time_shift=-67.53e-6)
# Calculate sum
sum_il_ob = pss.Scope.add(meas_il_ob, meas_il_ob)

# Calculate difference
diff_il_ob = pss.Scope.subtract(sum_il_ob, meas_il_ob)

# Copy values to new variable
abs_diff_il_ob = pss.Scope.copy(diff_il_ob)
# Calculate absolute values
pss.Scope.calc_abs(abs_diff_il_ob)
# Copy values to new variable
sqr_diff_il_ob = pss.Scope.copy(diff_il_ob)
# Calculate square
pss.Scope.square(sqr_diff_il_ob)
# Calculate values:
# Root means square
rms_diff_il_ob = pss.Scope.calc_rms(diff_il_ob)
# Average value
mean_diff_il_ob = pss.Scope.calc_mean(diff_il_ob)
# Average of absolute values
absmean_diff_il_ob = pss.Scope.calc_absmean(diff_il_ob)
# Print calculated values
print(f"Root mean square = {rms_diff_il_ob}\n"
      f"Average value = {mean_diff_il_ob}\n"
      f"Absolute average value={absmean_diff_il_ob}\n")
# Plot results
pss.Scope.plot_channels([diff_il_ob])
# Plot results
pss.Scope.plot_channels([diff_il_ob, abs_diff_il_ob, sqr_diff_il_ob])