src.experiment

Classes

Subcycle

Handling timings for transmission, receiver channels. More properties will

Experiment

Handling timings for transmitter and receiver channels

Module Contents

class src.experiment.Subcycle(begin=0, end=False)

Handling timings for transmission, receiver channels. More properties will follow?

Parameters:

  • begin (float)

  • end (Union[float, bool])

transmits
receive
rx_protection
rx_freqs
prop
baudlengths = []
phaseshifts
_begin = 0
_end = False
name = ''
property end
property begin
add_time(name, time)

Adds TimeInterval to relevant attribute of Subcycle.

Parameters:

  • name (str) – declares what the interval is for: Possibilities are: - “transmission”/”t” - transmission - “ch<some number>” - reception in channel with specified number

  • time (TimeInterval) – interval with on and off time of attribute

plot(plot=None, rangelims=False)

Plot reached ranges and transmitter/receiver states for single subcycle.

Parameters:

  • plot (Expplot | None, optional) – If given Expplot, everything is plotted into given Expplot object. If None, a new plot is created, defaults to None

  • rangelims (bool) – Show nearest and furthest ranges as axis ticks. default False.

  • rangelims

Return type:

None

class src.experiment.Experiment(name='')

Handling timings for transmitter and receiver channels

Parameters:

name (str)

subcycles = []
name = ''
add_subcycle(subcycle)
Parameters:

subcycle (Subcycle)

classmethod from_tlan(filename)

Load experiment file and convert to Experiment.

Parameters:

filename (str) – Path of tlan file to load.

Raises:

  • RuntimeError – If radar controller is not resetted correctly at end of file.

  • RuntimeWarning – if transmitter is constantly off.

Returns:

Object containing properties of the experiment.

Return type:

Experiment

classmethod from_eiscat_kst(filename, radar='UHF')

Load experiment file and convert to Experiment.

This is a wrapper function for loading from tlan or from elan file. Which ine is called is determined by the file ending. File name without ending is interpreted as .elan

For arguments, see from _tlan and from_elan

Parameters:

filename (str)

classmethod from_elan(filename, radar='UHF')

Load experiment file and convert to Experiment.

This is done by parsing the commands that would be run if the user typed “runexperiment <filename> <timestec> <some args>” in an real EROS console.

Parameters:

  • filename (str) – Path of elan file to load. The filename may have the ending .elan or the ending may be be left out. If the file is not found, python will look into “/kst/exp/filename” and “kst/exp/filename”

  • radar (str) – Site to plot the experiment for. Possibles are “UHF”, “VHF”, “ESR”, “KIR”, “SOD”

Raises:

  • RuntimeError – If radar controller is not resetted correctly at end of tlan file.

  • RuntimeWarning – if transmitter is constantly off.

Returns:

Object containing properties of the experiment.

Return type:

Experiment

plot(subcycles=[])

Plot multiple subcycles.

Calls Subcycle.plot(plot) for every subcycle to plot

Parameters:

subcycles (list, optional) – List of which subcycles to plot. Subcycles are counted from one. Empty list means plot all subcycles, defaults to plotting all.

Raises:

ValueError – If invalid subcycle numbers are given.

Return type:

None

plot_phaseshifts()

Plots all phaseshifts in the experiment grouped by subcycle.

Return type:

None