Wiki

Clone wiki

UFF / v0.1 / uff.wave_geometry

uff.wave_geometry < uff

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

Parameters

Parameter Datatype Description
origin uff.transform Geometric origin of the wave.
wave_type uff.wave_type enumerated type ( [0] -> converging, [1] -> diverging, [2]-> plane, [3]-> cylindrical, [4] -> photoacoustic)
aperture uff.aperture Description of the aperture used to produce the wave
excitation uff.excitation [Optional] excitation waveform

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). The interpretation of origin depends on wave_type. For converging waves origin.translation holds the location of the wave focal point, for diverging waves origin.translation holds the location of the virtual source; in both cases the origin.rotation is ignored. For plane waves origin.rotation holds the orientation of the wave and origin.translation is ignored.

For converging and diverging waves transform.position contains the location of the focus and virtual source, respectively. For plane waves, transform.rotation contains the angles of the plane wave.

Files

Updated