search

Donders-Institute / Radboud-FUS-measurement-kit

MIT License
5 stars 0 forks source link

readme

Radboud FUS measurement kit

ru_logo fus_logo igt_logo
sonorover-one

📗 Table of Contents

📖 Radboud FUS measurement kit

(Project id: 0003429 )

Radboud FUS measurement kit is a comprehensive kit allowing precise hydrophone measurements of your TUS transducers for verification, characterization and monitoring overall system performance.

This project is facilitated by the Radboud Focused Ultrasound Initiative. For more information, please visit the website.

Key Features

(back to top)

👥 Authors

👤 Stein Fekkes, FUS Initiative, Radboud University

👤 Margely Cornelissen, FUS Initiative, Radboud University

👤 Erik Dumont, Image Guided Therapy (IGT)

(back to top)

✒️ How to cite

If you use this kit in your research or project, please cite it as follows:

Margely Cornelissen, Stein Fekkes (Radboud University, Nijmegen, The Netherlands) & Erik Dumont (Image Guided Therapy, Pessac, France) (2024), Radboud FUS measurement kit (version 0.8), https://github.com/Donders-Institute/Radboud-FUS-measurement-kit

💻 Getting Started

Setup

Hardware

The hardware files are stored as native solidworks files and as step format. The main assembly file: W0003510-00-01-SonoRover One.SLDASM will contain all references to part files and subassemblies.

Software

Clone this repository to your desired folder:

Usage

Software

The software is provided as-is. As it is currently version 0.8, it is mainly intended for inspiration and preliminary use. We are actively working on cleaning, restructuring, and rewriting the code for a 1.0 release in the future.

The primary script is characterizationPipeline.py. Running this script launches a GUI to set the following parameters:

  1. Path and filename of protocol excel file: Select the required protocol Excel file. Refer to the example template here. This file contains sequences with various foci, power outputs, timing parameters, and/or coordinate grids. It is specific to a driving system-transducer combination.
    Note: If you change the headers in the Excel file, you must also update the corresponding headers in the code.

    • Sequence: The sequence number, ranging from 1 to the total number of sequences in the Excel file.
    • Modulation: Choose from Square, Linear, or Tukey ramp shapes from the dropdown.
    • Ramp duration [us]
    • Ramp duration step size [us]: Temporal resolution of ramping, applicable only for the IGT system.
    • Pulse duration [us]
    • Pulse Repetition Frequency [Hz]
    • Pulse Repetition Interval [ms]
    • Pulse Train Duration [ms]
    • Isppa [W/cm²], Global power [mW], or Amplitude [%]: Select the applicable power parameter for the chosen driving system from the dropdown. Amplitude is used for the IGT system; Isppa or global power is used for the Sonic Concepts system. It is recommended to use global power for the Sonic Concepts system.
      Note: If Isppa is chosen, a conversion table in an Excel file (e.g., here) is required with global power in mW and intensity in W/cm2. If you change the headers in the Excel file, you must also update the corresponding headers in the code.
    • Corresponding value: The value for the selected power parameter.
    • Path and filename of Isppa to Global power conversion Excel: Provide the path to the Isppa-global power conversion table. This parameter is skipped if Isppa is not selected.
    • Focus [mm]
    • Coordinates based on Excel file or parameters on the right?: Choose to define a grid using a coordinate Excel file or by defining grid sizes in this file from the dropdown. Coordinate file examples are here.
      Note: Coordinate files allow more flexibility in grid point arrangement. All grids are based on a chosen zero point (for example: focus or exit plane). Headers in the Excel file must match those used in the code.
    • Path and filename of coordinate Excel: Provide the path to the coordinate Excel file. This parameter is skipped if 'Coordinates based on Excel file' is not selected.

    Note: if 'Parameters on the right' is not chosen as input parameter, below parameters are skipped.

    • max. ± x [mm] w.r.t. relative zero: The maximum movement in the ±x direction in mm relative to the chosen zero point.
    • max. ± y [mm] w.r.t. relative zero: The maximum movement in the ±y direction in mm relative to the chosen zero point.
    • max. ± z [mm] w.r.t. relative zero: The maximum movement in the ±z direction in mm relative to the chosen zero point.
    • direction_slices: Choose the direction of the slices from the dropdown. Refer to the example image in the protocol template.
    • direction_rows: Choose the direction of the rows from the dropdown. Refer to the example image in the protocol template.
    • direction_columns: Choose the direction of the columns from the dropdown. Refer to the example image in the protocol template.
    • step_size_x [mm]: The grid size in the x-direction.
    • step_size_y [mm]: The grid size in the y-direction.
    • step_size_z [mm]: The grid size in the z-direction.

  2. US Driving System

  3. Transducer

  4. Operating frequency [kHz]

  5. COM port of US driving system: Required for Sonic Concepts driving system.

  6. COM port of positioning system

  7. Hydrophone acquisition time [us]

  8. Picoscope sampling frequency multiplication factor: Minimum multiplication factor is 2.

  9. Absolute G code x-coordinate of relative zero: The x-coordinate of the chosen zero point.

  10. Absolute G code y-coordinate of relative zero: The y-coordinate of the chosen zero point.

  11. Absolute G code z-coordinate of relative zero: The z-coordinate of the chosen zero point.

  12. Perform all protocols in sequence without waiting for user input?: If yes, the characterization will proceed through all sequences in the protocol Excel file without stopping for input between sequences.

After all parameters are set, click 'ok' to start the characterization. Log files and an output folder will be created in the same directory as the protocol Excel file.

image

(back to top)

🔭 Future Features

Software

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

If you have any questions, please feel free to reach out to us via email at fus@ru.nl. We'd love to hear from you.

(back to top)

📝 License

This project is MIT licensed.

(back to top)