sweep_design.prepared_sweeps

Submodules

• sweep_design.prepared_sweeps.code_m_sequence
• sweep_design.prepared_sweeps.code_zinger
• sweep_design.prepared_sweeps.dwell_sweep
• sweep_design.prepared_sweeps.linear_sweep
• sweep_design.prepared_sweeps.pseudorandom_shuffle
• sweep_design.prepared_sweeps.sweep_from_code

Package Contents

Functions

get_dwell_sweep(→ sweep_design.sweep.Sweep)	Create a dwell sweep using an a priori data.
get_linear_sweep(→ sweep_design.sweep.Sweep)	Create linear sweep.
get_shuffle(→ sweep_design.sweep.Sweep)	Create shuffle sweep signal.
get_code_sweep_segments(→ sweep_design.sweep.Sweep)	Get sweep use code to compose a base_sweep.
get_convolution_sweep_and_code(→ sweep_design.sweep.Sweep)	Get sweep use convolution between sweep and desired code.
get_m_sequence_code(→ numpy.ndarray)	Create m-sequence array
get_relation_m_sequence(→ sweep_design.relation.Relation)	Create m-sequence relation.
get_code_zinger(...)	Build sequence of code zinger.
get_code_zinger_relation(→ sweep_design.relation.Relation)	Create relation of code zinger.

sweep_design.prepared_sweeps.get_dwell_sweep(time: Union[sweep_design.axis.ArrayAxis, numpy.ndarray], f_start=1.0, f_central=5.0, f_end=100.0, time_tapper=1.0, aprior_data: sweep_design.relation.Relation = None) → sweep_design.sweep.Sweep

Create a dwell sweep using an a priori data.

time_tapper in seconds is used to apply tukey function at the end of dwell sweep signal.

sweep_design.prepared_sweeps.get_linear_sweep(time: Union[sweep_design.axis.ArrayAxis, numpy.ndarray], f_start=1.0, f_end=100.0, time_tapper=None) → sweep_design.sweep.Sweep

Create linear sweep.

time_tapper in seconds is used to apply tukey function to a sweep signal.

sweep_design.prepared_sweeps.get_shuffle(time: Union[sweep_design.axis.ArrayAxis, numpy.ndarray], f_start=1.0, f_end=101.0, length_time_segments=0.5, round_number_frequency: int = None, time_tapper=1.0) → sweep_design.sweep.Sweep

Create shuffle sweep signal.

t_tapper in seconds is used to apply tukey function at the end of dwell sweep signal.

sweep_design.prepared_sweeps.get_code_sweep_segments(code: Union[sweep_design.relation.Relation, numpy.ndarray, List[sweep_design.help_types.Literal[-1, 0, 1]]], base_sweep: sweep_design.relation.Relation) → sweep_design.sweep.Sweep

Get sweep use code to compose a base_sweep.

Code can be m-sequence, code zinger and etc. :param code: some code. :type code: Union[Relation, List[Literal[-1, 0, 1]] :param sweep: some base sweep. :type sweep: Relation

sweep_design.prepared_sweeps.get_convolution_sweep_and_code(code: Union[sweep_design.relation.Relation, List[sweep_design.help_types.Literal[-1, 0, 1]]], base_sweep: sweep_design.relation.Relation) → sweep_design.sweep.Sweep

Get sweep use convolution between sweep and desired code.

Code can be m-sequence, code zinger and etc.

Parameters

• code (Union[Relation, List[Literal[-1, 0, 1]]) – some code. Relation or List of -1, 0, 1

• base_sweep (Relation) – some base sweep.

Returns

result signal use as sweep signal.

Return type

Sweep

sweep_design.prepared_sweeps.get_m_sequence_code(length_code: int, is_full=False) → numpy.ndarray

Create m-sequence array

Parameters

• length_code (int) – length of m-sequence array.

• is_full (bool, optional) – parameter to return full sequence if True. sequence can be longer then requested length code. If False return sequence which size equal length_code. Defaults to False.

Returns

array of m-sequence.

Return type

np.ndarray

sweep_design.prepared_sweeps.get_relation_m_sequence(time: Union[sweep_design.axis.ArrayAxis, numpy.ndarray], start_sequence: numpy.ndarray = None, is_full=False) → sweep_design.relation.Relation

Create m-sequence relation.

Parameters

• time (Union[ArrayAxis, np.ndarray]) – time of sequence.

• start_sequence (np.ndarray, optional) – start array sequence of -1 and 1 to create m-sequence. Defaults to None.

• is_full (bool, optional) – if True return full m-sequence with new time with equal size to m-sequence array. Defaults to False.

Returns

relation of m-sequence.

Return type

Relation

sweep_design.prepared_sweeps.get_code_zinger(first_sequence_code_zinger: List[sweep_design.help_types.Literal[-1, 1]] = [-1, -1, -1, 1], periods=1) → List[sweep_design.help_types.Literal[-1, 1]]

Build sequence of code zinger.

Parameters

• first_sequence_code_zinger (Literal[, optional) – First period of code zinger. Defaults to [-1, -1, -1, 1].

• periods (int, optional) – Periods of code zinger. Repeat first_sequence_code_zinger n(periods) times. Defaults to 1.

• Returns – np.ndarray: array of code zinger.

sweep_design.prepared_sweeps.get_code_zinger_relation(start_sequence: sweep_design.relation.Relation, periods=1) → sweep_design.relation.Relation

Create relation of code zinger.

Parameters

• start_sequence (Relation) – start of code zinger. Example: Relation([-1, -1, -1, 1], [0, 1, 2, 3])

• periods (int, optional) – Periods of code zinger. Repeat first_sequence_code_zinger n(periods) times. Defaults to 1.

• Returns – Relation: relation of code zinger.