Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ARRUS-96: Python examples documentation update. #239

Merged
merged 3 commits into from
Nov 2, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 44 additions & 4 deletions docs/content/examples.python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,56 @@ Plane Wave Imaging
#. Go to |api_language|/examples directory.
#. Run ``python plane_wave_imaging.py``

This script implements 'plane wave imaging' scheme,
where the image is formed by combining a couple low-resolution images into one high-resolution image.
Each low-resolution image is formed using data acquired after transmission of a plane wave at a different angle.
After starting the script, you should be able to see an output similar to the below one:

.. figure:: img/pwi-cysts.png
.. figure:: img/bmode_pwi_phantom_cysts.png

Plane wave imaging python script output. Phantom: ATS549, cysts.
Plane wave imaging python script output. Phantom: ATS549, cysts. Probe: L14-5/38 from Ultrasonix.


.. Diverging Beams
Classical Beamforming
=====================

.. Classical Beamforming

#. Go to |api_language|/examples directory.
#. Run ``python classical_beamforming.py``


This script implements classical transmit-receive scheme, where the image is formed using line by line scanning.
After starting the script, you should be able to see an output image similar to the below one:

.. figure:: img/bmode_bfr_phantom_cysts.png

Classical beamforming script output image. Phantom: ATS549, cysts. Probe: L14-5/38 from Ultrasonix.


Diverging Beams
===============


#. Go to |api_language|/examples directory.
#. Run ``python diverging_beams.py``



This script implements diverging beams transmit-receive scheme,
where the image is formed using data acquired after couple transmissions of diverging beams
with different virtual focuses.
After starting the script, you should be able to see an output image similar to the below one:

.. figure:: img/bmode_div_phantom_cysts.png

Diverging beams scheme script output image. Phantom: ATS549, cysts. Probe: L14-5/38 from Ultrasonix.


Others
======

The /examples directory contain addtional scripts ``custom_callback.py`` and ``custom_tx_rx_sequence.py``
which show how to construct custom sequences and callbacks.

.. Custom TX/RX Sequence

Expand Down
Binary file added docs/content/img/bmode_bfr_phantom_cysts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/content/img/bmode_div_phantom_cysts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/content/img/bmode_pwi_phantom_cysts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/content/img/pwi-cysts.png
Binary file not shown.