#!/usr/bin/env python
# coding: utf-8

# # QCoDeS example with Textronix DPO 7200xx scopes 
# 

# In[2]:


from qcodes.dataset.measurements import Measurement
from qcodes.dataset.plotting import plot_by_id
from qcodes.dataset.experiment_container import new_experiment

from qcodes.instrument_drivers.tektronix.DPO7200xx import TektronixDPO7000xx, TektronixDPOMeasurement


# In[5]:


tek = TektronixDPO7000xx("tek3", "TCPIP0::169.254.158.44::inst0::INSTR")


# In[3]:


experiment = new_experiment(name='DPO_72000_example', sample_name="no sample")


# ## Aqcuiring traces 

# In[4]:


# First, determine the number of samples we wish to acquire
tek.channel[0].set_trace_length(1000)
# alternatively, we can set the time over which we 
# wish to acquire a trace (uncomment the following line): 
# tek.channel[0].set_trace_time(4E-3)


# In[5]:


meas = Measurement(exp=experiment)
meas.register_parameter(tek.channel[0].waveform.trace)
meas.register_parameter(tek.channel[1].waveform.trace)

with meas.run() as datasaver:
    for i in [0, 1]:
        datasaver.add_result(
            (tek.channel[i].waveform.trace_axis, tek.channel[i].waveform.trace_axis()),
            (tek.channel[i].waveform.trace, tek.channel[i].waveform.trace())
        )

    dataid = datasaver.run_id

plot_by_id(dataid)


# There seems to be something wrong with the `plot_by_id` method. Fixing this is beyond the scope of this PR. Below we show that the driver works properly 

# In[6]:


import matplotlib.pyplot as plt 
plt.plot(
    tek.channel[i].waveform.trace_axis(), 
    tek.channel[i].waveform.trace()
)


# ## Changing the waveform format 
# 
# If we wish, we can change the way in which data is retrieved from the instrument, which can enhance the precision of the data and the speed to retrieval. 
# 
# We do this through the 'waveform' module on the main driver (e.g. `tek.waveform`) as opposed to the 'waveform' module on a channel (e.g. `tek.channel[0].waveform`). We have this distinction because the waveform formatting parameters effect all waveform sources (e.g. channel 0 or channel 1) 

# In[7]:


tek.waveform.data_format()


# In[8]:


# The available formats 
tek.waveform.data_format.vals


# In[9]:


tek.waveform.is_big_endian()


# In[10]:


tek.waveform.bytes_per_sample()


# In[11]:


tek.waveform.bytes_per_sample.vals


# In[12]:


tek.waveform.is_binary()
# Setting is_binary to false will transfer data in ascii mode. 


# ## Trigger setup 
# 
# The `tek.trigger` module is the 'main' trigger

# In[13]:


tek.trigger.source()


# In[14]:


tek.trigger.type()


# In[15]:


tek.trigger.edge_slope()


# In[16]:


tek.trigger.edge_slope("fall")


# ### Delayed trigger 
# 
# You can trigger with the Main trigger system alone or combine the Main trigger with the Delayed trigger to trigger on sequential events. When using sequential triggering, the Main trigger event arms the trigger system, and the Delayed trigger event triggers the instrument when the Delayed trigger conditions are met.
# 
# Main and Delayed triggers can (and typically do) have separate sources. The Delayed trigger condition is based on a time delay or a specified number of events.
# 
# See page75, Using Main and Delayed triggers of the [manual](https://download.tek.com/manual/MSO70000C-DX-DPO70000C-DX-MSO-DPO7000C-MSO-DPO5000B-Oscilloscope-Quick-Start-User-Manual-071298006.pdf)
# 

# In[17]:


tek.delayed_trigger.source()


# In[18]:


tek.delayed_trigger.type()


# Etc... The main and delayed triggers have the same parameters. However, the accepted values of these parameters might differ. Please see the above manual for details. 

# ## Measurements
# 
# The scope also has a measurement module

# In[16]:


tek.measurement[0].source1("CH1")
tek.measurement[0].source2("CH2")
tek.measurement[1].source1("CH2")


# In[17]:


channel = tek.measurement[0].source1()
value = tek.measurement[0].frequency()
unit = tek.measurement[0].frequency.unit

print(f"Frequency of signal at channel {channel}: {value:.2E} {unit}")


# In[18]:


channel = tek.measurement[1].source1()
value = tek.measurement[1].frequency()
unit = tek.measurement[1].frequency.unit

print(f"Frequency of signal at channel {channel}: {value:.2E} {unit}")


# In[19]:


channel = tek.measurement[0].source1()
value = tek.measurement[0].amplitude()
unit = tek.measurement[0].amplitude.unit

print(f"Amplitude of signal at channel {channel}: {value:.2E} {unit}")


# In[20]:


channel = tek.measurement[1].source1()
value = tek.measurement[1].amplitude()
unit = tek.measurement[1].amplitude.unit

print(f"Amplitude of signal at channel {channel}: {value:.2E} {unit}")


# In[22]:


channel1 = tek.measurement[0].source1()
channel2 = tek.measurement[0].source2()
value = tek.measurement[0].phase()
unit = tek.measurement[0].phase.unit

print(f"Phase of signal at channel {channel1} wrt channel {channel2}: {value} {unit}")


# Here are all the availble measurements

# In[27]:


from pprint import pprint
print_string = ", ".join([i[0] for i in TektronixDPOMeasurement.measurements])
pprint(print_string)


# ### Measurement statistics
# 
# We can measure basic measurement statistics

# In[24]:


channel = tek.measurement[0].source1()
value = tek.measurement[0].amplitude.mean()
unit = tek.measurement[0].amplitude.unit

print(f"The mean amplitude of signal at channel {channel}: {value} {unit}")


# We can do the same with all the measurement which are supported by the instrument. The following statistics are available: `mean`, `max`, `min`, `stdev`
# 
# ### Statistics control
# 
# A seperate module controls statistics gathring: `tek.statistics`. For instance, The oscilloscope gathers statistics over a set of measurement values which are stored in a buffer. We can reset this buffer like so... 

# In[25]:


tek.statistics.reset()


# The following parameters are available for staistics control: 
# 
# 1. `mode`: This command controls the operation and display of measurement statistics and accepts the following arguments: `OFF` turns off all measurements. This is the default value. `ALL` turns on statistics and displays all statistics for each measurement. `VALUEMean` turns on statistics and displays the value and the mean (μ) of each measurement. `MINMax` turns on statistics and displays the min and max of each measurement. `MEANSTDdev` turns on statistics and displays the mean and standard deviation
# of each measurement.
# 2. `time_constant`: This command sets or queries the time constant for mean and standard deviation statistical accumulations

# ## Future work 
# 
# The DPO7200xx scopes have support for mathematical operations. An example of a math operation is a spectral analysis. Although the current QCoDeS driver does not (fully) support these operations, the way the driver code has been factored should make it simple to add support if future need arrises. 
# 
# An example: we can manually add a spectrum analysis by selecting "math" -> "advanced spectral" from the oscilloscope menu in the front display of the instrument. After manual creation, we can retrieve spectral data with the driver as follows: 

# In[24]:


from qcodes.instrument_drivers.tektronix.DPO7200xx import TekronixDPOWaveform


# In[25]:


math_channel = TekronixDPOWaveform(tek, "math", "MATH1")


# In[26]:


meas = Measurement(exp=experiment)
meas.register_parameter(math_channel.trace)

with meas.run() as datasaver:

    datasaver.add_result(
        (math_channel.trace_axis, math_channel.trace_axis()),
        (math_channel.trace, math_channel.trace())
    )

    dataid = datasaver.run_id

plot_by_id(dataid)


# In order to fully support math operations and spectral analysis, we need code to add a math function through the QCoDeS driver, rather than manually. Additionally, we need to be able to adjust the frequency ranges and possibly other relevant parameters.
# 
# As always, contributions are more then welcome! :-)

# In[ ]: