sweep_design.prepared_sweeps.code_m_sequence

Module Contents

Functions

get_m_sequence_code(→ numpy.ndarray)

Create m-sequence array

get_relation_m_sequence(→ sweep_design.relation.Relation)

Create m-sequence relation.
sweep_design.prepared_sweeps.code_m_sequence.get_m_sequence_code(length_code: int, is_full=False) → numpy.ndarray[source]

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.code_m_sequence.get_relation_m_sequence(time: Union[sweep_design.axis.ArrayAxis, numpy.ndarray], start_sequence: numpy.ndarray = None, is_full=False) → sweep_design.relation.Relation[source]

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