sweep_design.config.sweep_config

Module Contents

Classes

SweepConfig

The configuration file for sweep.

class sweep_design.config.sweep_config.SweepConfig[source]

The configuration file for sweep.

Several methods are defined for default calculations:

spectrogram_method_default:

The method by which the spectrogram will be calculated. Method derived from default function: sweep_design.defaults.sweep_methods.get_spectrogram

Parameters

sweep (relation.Relation) – instance of sweep signal.

Returns

tuple of np.ndarray. The first element is time.

The second is frequency. The third is matrix M x N of spectrogram.

Return type

Spectrogram

get_f_t:

The method by which frequency versus time will be calculated. Method derived from default function: sweep_design.defaults.sweep_methods.get_f_t

Parameters

sweep (Relation) – instance of sweep signal.

Returns

instance Relation

Return type

Relation

get_a_t:

The method by which the time envelope of the signal will be calculated. Method derived from default function: sweep_design.defaults.sweep_methods.get_a_t

Parameters

sweep (Relation) – instance of sweep signal.

Returns

instance Relation

Return type

Relation

freq2time:

The simple method to extract the time envelope of a sweep signal and the time-frequency function to generate a sweep signal from a priori data. Method derived from default function: sweep_design.defaults.sweep_methods.simple_freq2time

Parameters

spectrum (Spectrum) – instance signal of ‘Spectrum’

Returns

simple representation Frequency

modulation from a prior spectrum.

Return type

Tuple[Time, Frequency, Envelope]

The above methods can be overridden with your own here, or you can import the class SweepConfig somewhere and override it there. (They must be written according to the rules corresponding to the input and output parameters)

spectrogram_method
get_f_t
get_a_t
freq2time