skippylab package

Subpackages

• skippylab.instruments package
  • Submodules
  • skippylab.instruments.function_generators module
  • skippylab.instruments.gpibcontrollers module
  • skippylab.instruments.oscilloscopes module
  • skippylab.instruments.powersupplies module
  • Module contents
• skippylab.scpi package
  • Submodules
  • skippylab.scpi.commands module
  • Module contents

Submodules

skippylab.daq module

Use the scope as a DAQ

class skippylab.daq.DAQ

Bases: object

A virtual DAQ using an oscilloscope

acquire(*pullargs, **pullkwargs)

Go through the instrument list and trigger their pull methods to build an event

Keyword Arguments:  **pullkwargs (dict) – will be passed on the individual pull methods Returns:pyosci.Event

acquire_n_events(n_events, trigger_hook=<function DAQ.<lambda>>, trigger_hook_args=(None, ), pull_args=(), pull_kwargs={})

Continuous acquisition. Acquires n events. Yields events. Use trigger hook to define a function to decide when data is returned.

Parameters:

• n_events (int) – Number of events to acquire
• trigger_hook (callable) – Trigger condition
• trigger_hook_args (tuple) – Arguments for the trigger condition

Yields:

Event

register_instrument(instrument, label='instrument')

Register an instrument and assign a channel to it. Instruments must have a pull() method which allows to pull data from them at a certain event.

Parameters:

• instrument (ducktype) – needs to be configured already and must have a pull() method
• channel_name (int) – identify the instrument under this registered channel

Returns:

None

class skippylab.daq.Event(use_datetime=False)

Bases: object

DAQ will return events when triggered.

timestamp_it()

Give it a timestamp! Time in seconds

Returns:None

skippylab.loggers module

Prepare logging functionality for the module

skippylab.loggers.get_logger(loglevel, logfile=None)

A root logger with a formatted output logging to stdout and a file

Parameters:

• loglevel (int) – 10,20,30,… the higher the less logging
• logfile (str) – write logging to this file as well as stdout

Returns:

logging.logger

skippylab.plotting module

Convenient plot functions

skippylab.plotting.plot_histogram(bincenters, bincontent, fig=None, savename='test.png', remove_empty_bins=True)

Plot a histogram returned by TektronixDPO4104B.get_histogram Use pylab.plot

Parameters:

• bincenters (np.ndarray); bincenters (x) –
• bincontent (np.ndarray) – bincontent (y)

Keyword Arguments:  

• fig (pylab.figure) – A figure instance
• savename (str) – where to save the figure (full path)
• remove_empty_bins (bool) – Cut away preceeding and trailing zero bins

skippylab.plotting.plot_waveform(wf_header, wf_data, fig=None, savename=None, use_mv_and_ns=True, color=None)

Make a plot of a single acquisition

Parameters:

• wf_header (dict) – custom waveform header
• wf_data (np.ndarray) – waveform data

Keyword Arguments:  

• fig (pylab.figure) – A figure instance
• savename (str) – where to save the figure (full path)
• use_mv_and_ns (bool) – use mV and ns instead of V and s

Returns:

pylab.fig

skippylab.tools module

Convenient operations

skippylab.tools.average_wf(waveforms)

Get the average waveform

Parameters:waveforms (iterable of np.ndarrays) – Returns:np.ndarray

skippylab.tools.integrate_wf(waveform, xs, xstep, method=<Mock name='mock.integrate.simps' id='140515038155160'>, impedance=50)

Integrate a waveform, i.e. a voltage curve. If the desired result shall be indeed a charge, please make sure to give xs in seconds and impedance in Ohm accordingly. xstep needs to be in seconds as well.

Parameters:

• waveform (np.ndarray) – voltage values
• xs (np.ndarray) – timing values
• xstep (float) – timing bin size

Keyword Arguments:  

• method (func) – integration method
• impedance (float) – needed to calculate actual charge

Returns:

float

skippylab.tools.load_waveform(filename, converter=<function <lambda>>)

load a waveform from a file

Parameters:filenaame (str) – An existing filename Keyword Arguments:  converter (func) – If the data is saved in digitizer levels, use the converter function to convert to Volts Returns:tuple (dict, np.ndarray)

skippylab.tools.save_waveform(header, waveform, filename)

save a waveform together with its header

Parameters:

• header (dict) – Some metainformation about the waveform
• waveform (np.ndarray) – the actual voltage data
• filename (str) – a filename where the data should be saved

Returns:

None

Module contents

Package to read out TektronixDPO4104B oscilloscope