openlifu.bf.sequence.Sequence

class openlifu.bf.sequence.Sequence(pulse_interval: Annotated[float, OpenLIFUFieldData(name='Pulse interval (s)', description='Interval between pulses in the sequence (s)')] = 1.0, pulse_count: Annotated[int, OpenLIFUFieldData(name='Pulse count', description='Number of pulses in the sequence')] = 1, pulse_train_interval: Annotated[float, OpenLIFUFieldData(name='Pulse train interval (s)', description='Interval between pulse trains in the sequence (s)')] = 1.0, pulse_train_count: Annotated[int, OpenLIFUFieldData(name='Pulse train count', description='Number of pulse trains in the sequence')] = 1)

Bases: DictMixin

Class for representing a sequence of pulses

get_pulse_train_duration() → float

Get the duration of a single pulse train in seconds

Returns:

Duration of a single pulse train in seconds

get_sequence_duration() → float

Get the total duration of the sequence in seconds

Returns:

Total duration of the sequence in seconds

pulse_count: Annotated[int, OpenLIFUFieldData(name='Pulse count', description='Number of pulses in the sequence')] = 1

Number of pulses in the sequence

pulse_interval: Annotated[float, OpenLIFUFieldData(name='Pulse interval (s)', description='Interval between pulses in the sequence (s)')] = 1.0

Interval between pulses in the sequence (s)

pulse_train_count: Annotated[int, OpenLIFUFieldData(name='Pulse train count', description='Number of pulse trains in the sequence')] = 1

Number of pulse trains in the sequence

pulse_train_interval: Annotated[float, OpenLIFUFieldData(name='Pulse train interval (s)', description='Interval between pulse trains in the sequence (s)')] = 1.0

Interval between pulse trains in the sequence (s)

to_table() → DataFrame

Get a table of the sequence parameters

Returns:

Pandas DataFrame of the sequence parameters