Sample Offset Trigger

The SampleOffsetTrigger introduces an offset of a fixed number of samples to the start of the SimulatedDrop.

It can be configured by assigning the same SampleOffsetTrigger instance to the trigger_model property of multiple simulated devices:

# Create a new simulation featuring two sets of two linked, synchronized devices
simulation = Simulation()

# Create devices
device_A_Tx = simulation.new_device(carrier_frequency=3.7e9)
device_A_Rx = simulation.new_device(carrier_frequency=3.7e9)
device_B_Tx = simulation.new_device(carrier_frequency=3.9e9)
device_B_Rx = simulation.new_device(carrier_frequency=3.9e9)

# Specify trigger models
trigger_model_A = SampleOffsetTrigger(0)
device_A_Tx.trigger_model = trigger_model_A
device_A_Rx.trigger_model = trigger_model_A

trigger_model_B = SampleOffsetTrigger(2048)
device_B_Tx.trigger_model = trigger_model_B
device_B_Rx.trigger_model = trigger_model_B

class SampleOffsetTrigger(num_offset_samples)

Bases: TriggerModel

Model of a trigger that generates a constant offset of samples between drop start and frame start

Parameters:

num_offset_samples (int) – Number of discrete samples between drop start and frame start.

classmethod Deserialize(process)

Deserialize an object’s state.

Objects cannot be deserialized directly, instead a Factory must be instructed to carry out the deserialization process.

Parameters:

process (DeserializationProcess) – The current stage of the deserialization process. This object is generated by the Factory and provides an interface to deserialization methods supporting multiple backends.

Return type:

SampleOffsetTrigger

Returns:

The deserialized object.

realize(rng=None)

Realize a triggering of all controlled devices.

Parameters:

rng (Generator | None) – Random number generator used to realize this trigger model. If not specified, the object’s internal generator will be queried.

Return type:

TriggerRealization

Returns: Realization of the trigger model.

serialize(process)

Serialize this object’s state.

Objects cannot be serialized directly, instead a Factory must be instructed to carry out the serialization process.

Parameters:

process (SerializationProcess) – The current stage of the serialization process. This object is generated by the Factory and provides an interface to serialization methods supporting multiple backends.

Return type:

None

property num_offset_samples: int

Number of discrete samples between drop start and frame start.

Returns: Number of samples