Examples

In the following parts of this chapter, we will show you how to run example scripts available in the ARRUS software. The source code of the ready-to-run examples can be found in python/examples directory.

For more information on the parameters of individual functions please refer to section API Reference.

For the user guide and all the assumptions (e.g. about the coordinate system) please visit sections Glossary and assumptions and User Guide.

Before running any of the below examples:

  • Make sure you are running the Python script using the appropriate Python distribution; please install python/examples/requirements.txt file first (if you haven’t already that done).

  • Make sure you are using correct configuration file. See Running the Scheme for more information how the path to configuration file is determined when creating session object.

  • Make sure that the correct parameters are set, in particular the transmitting voltage.

Plane Wave Imaging

  1. Go to python/examples directory.

  2. Run python plane_wave_imaging.py

After starting the script, you should be able to see an output similar to the below one:

../_images/pwi-cysts.png

Fig. 3 Plane wave imaging python script output. Phantom: ATS549, cysts.