zea.Probe

class zea.Probe(name=None, type=None, probe_center_frequency=None, probe_bandwidth_percent=None, probe_geometry=None, element_width=None, element_height=None, lens_sound_speed=None, lens_thickness=None)

Bases: ProbeSpec

classmethod from_name(probe_name, **kwargs)

Create a probe from its name.

Parameters:

probe_name (str) – Name of the probe.

Returns:

Probe object.

Return type:

Probe

get_parameters()

Return a dict of the probe parameters.

static get_pitch(probe_geometry)

Compute the pitch (centre-to-centre element spacing) in metres from the probe geometry.

Returns None when the pitch is not defined for the geometry (fewer than 2 elements, or not a 1-D / linear array). Raises ValueError when the array looks like a ULA but the element positions are not uniformly spaced, to surface likely data errors rather than silently returning None.

Return type:

float | None

property kerf: float | None

Gap between elements in metres, derived from element_width and pitch.

property pitch: float | None

Centre-to-centre element spacing in metres, derived from probe_geometry.

Raises ValueError when:

• probe_geometry is not set,

• the probe has fewer than 2 elements, or

• the elements are not arranged along a single axis (not a 1-D / linear array).

• the spacing is non-uniform (elements are present but clearly not a ULA),

  to surface likely data errors rather than silently returning None.

to_tensor(keep_as_is=None)

Convert the attributes in the object to tensors.