Wiki

Clone wiki

UFF / v0.2 / uff.aperture

uff.aperture < uff

UFF class to define analytically the aperture use in an ultrasound wave

Parameters

Parameter Datatype Description
origin uff.position Location of the aperture center in space
window string String defining the apodization window type and parameter (e.g., 'Hamming', 'Gauss(8)', 'Tukey(0.5)')
f_number double or single Desired F-number of the aperture [Az, El]
fixed_size double or single If non-zero, this overwrites the size of the aperture in m [Az, El]
minimun_size double or single (Optional) If non-zero, this sets a limit for the minimum dynamic aperture in m [Az, El]
maximum_size double or single (Optional) If non-zero, this sets a limit for the maximum dynamic aperture in m [Az, El]

Notes

The class aperture defines the transmit apodization profile. In this case origin defines the center of the aperture. The size of the aperture can be described with fixed_size, or with f_number in which case the aperture size is d/f_number where d is the distance between uff.wave.origin and uff.wave.aperture.origin. The parameter window is a string describing the apodization window.

aperture.png

Example Files

Updated