Wiki

Clone wiki

UFF / v0.3 / uff.transmit_wave

uff.transmit_wave < uff

UFF class to describe a transmitted wave as used in an event

Parameters

Parameter Datatype Description
wave uint32 Index of the uff.wave within the list of unique_waves in the uff.channel_data structure
time_zero_reference_point uff.position Point in space that the waveform passes through at time zero.
time_offset double or single (Optional) Time delay between the start of the event and the moment this wave reaches the time_zero_reference_point in the corresponding transmit setup [s]. [Default = 0s]
weight double or single (Optional) Weight applied to the wave within the event [unitless between -1 and +1]. This may be used to describe pulse inversion sequences. [Default = 1]

trasnmit_wave.png

Files

It is not possible to save uff.transmit_wave structure in a standalone file, as the list of unique_waves is required. A complete uff.channel_data is provided instead. The user can find the uff.trasnmit_wave in the group /channel_data/sequence/event/transmit_setup/transmit_waves

Updated