sweep_design.sweep

Module Contents

Classes

Sweep

Class Sweep.

Functions

_get_spectrogram(→ sweep_design.spectrogram.Spectrogram)

class sweep_design.sweep.Sweep(time: Union[sweep_design.core.RelationProtocol, sweep_design.axis.ArrayAxis, sweep_design.help_types.ArrayLike], amplitude: sweep_design.help_types.ArrayLike = None, frequency_time: sweep_design.relation.Relation = None, amplitude_time: sweep_design.relation.Relation = None, a_prior_signal: sweep_design.signal.Signal = None)[source]

Bases: sweep_design.signal.Signal

Class Sweep.

A class for analyzing changes in a signal over time, inherited from the Signal class.

For analysis, you can use not only the sweep signal, but also other signals for which the spectrogram needs to be considered.

When creating an instance of the class, the spectrogram is calculated. The method used to calculate the spectrogram is defined in the SweepConfig class. You can override it with your own.

If the frequency vs. time and amplitude vs. time functions have not been passed, they are also calculated, the get_frequency_time, get_amplitude_time methods defined in the SweepConfig class are used.

Perform the same operations as for the inherited class.

Initialize sweep instance.

Parameters

  • time (Union[RelationProtocol, ArrayAxis, ArrayLike]) – The Relation class, or a class derived from the Relation class, or ArrayAxis, or an array_like object containing numbers(real or complex).

  • amplitude (ArrayLike, optional) – None or array_like object containing real or complex numbers. Defaults to None.

  • frequency_time (Relation, optional) – This parameter describes the change in frequency versus time of the transmitted signal. Defaults to None.

  • amplitude_time (Relation, optional) – This parameter describes the change in amplitude envelop of signal from the time of the transmitted signal. Defaults to None.

  • a_prior_signal (Signal, optional) – The signal used to create the sweep signal. Defaults to None.

sweep_design.sweep._get_spectrogram(spectrogram: sweep_design.defaults.sweep_methods.Spectrogram) → sweep_design.spectrogram.Spectrogram[source]