Wiki

Clone wiki

UFF / v0.3 / uff.wave

uff.wave < uff

UFF class to describe the geometry of a transmitted wave or beam

Parameters

Parameter Datatype Description
origin uff.wave_origin Geometric origin of the wave.
type uff.wave_type enumerated type (uint32) ( converging = 0, diverging = 1, plane = 2, cylindrical = 3, photoacoustic = 4, default = 0)
aperture uff.aperture Description of the aperture used to produce the wave
excitation uint32 [Optional] index to the unique excitation in the parent group

wave_geometry.png

Notes

The parameter wave_type is an enumerated type (int32) that indicates the type of transmitted wave: converging wave (0), diverging wave (1), plane wave (2), or cylindrical wave (3).

Files

  • Diverging wave. uff.wave cannot be written in a standalone file, as they need a uff.unique_excitations in the parent group. Instead a uff.channel_data structure containing a single wave is provided here.

Updated