zea.probes

Module containing parameters and classes for different ultrasound probes.

All probes are based on the base Probe class.

Supported probes

• Probe – Base class for all probes

• Verasonics_l11_4v – Verasonics L11-4V linear ultrasound transducer

• Verasonics_l11_5v – Verasonics L11-5V linear ultrasound transducer

• Esaote_sll1543 – Esaote SLL1543 linear ultrasound transducer

Example usage

We can initialize a generic probe with the following code:

import zea

probe = zea.Probe.from_name("generic")
print(probe.get_parameters())

Functions

create_probe_geometry(n_el, pitch)

Create probe geometry based on number of elements and pitch.

Classes

Esaote_sll1543()	Esaote SLL1543 linear ultrasound transducer.
Probe([probe_geometry, center_frequency, ...])	Probe base class.
Verasonics_l11_4v()	Verasonics L11-4V linear ultrasound transducer.
Verasonics_l11_5v()	Verasonics L11-5V linear ultrasound transducer.

class zea.probes.Esaote_sll1543

Bases: Probe

Esaote SLL1543 linear ultrasound transducer.

https://lysis.cc/products/esaote-sl1543

get_parameters()

Returns a dictionary with default parameters.

class zea.probes.Probe(probe_geometry=None, center_frequency=None, sampling_frequency=None, xlims=None, zlims=None, bandwidth_MHz=None, probe_type='linear')

Bases: Object

Probe base class. All probes should inherit from this class.

classmethod from_name(probe_name, fallback=False, **kwargs)

Create a probe from its name.

Parameters:

probe_name (str) – Name of the probe.

Returns:

Probe object.

Return type:

Probe

classmethod from_parameters(probe_name, parameters)

Instantiate a probe by name, overriding with parameters from dict.

Return type:

Probe

get_parameters()

Returns a dictionary with default parameters.

to_tensor(keep_as_is=None)

Convert the attributes in the object to tensors.

class zea.probes.Verasonics_l11_4v

Bases: Probe

Verasonics L11-4V linear ultrasound transducer.

class zea.probes.Verasonics_l11_5v

Bases: Probe

Verasonics L11-5V linear ultrasound transducer.

zea.probes.create_probe_geometry(n_el, pitch)

Create probe geometry based on number of elements and pitch.

Parameters:

• n_el (int) – Number of elements in the probe.

• pitch (float) – Pitch of the elements in the probe.

Returns:

Probe geometry with shape (n_el, 3).

Return type:

np.ndarray