Skip to content

Added readme to describe the examples#3

Open
FrancoisGaits wants to merge 1 commit intoSTORM-IRIT:mainfrom
FrancoisGaits:main
Open

Added readme to describe the examples#3
FrancoisGaits wants to merge 1 commit intoSTORM-IRIT:mainfrom
FrancoisGaits:main

Conversation

@FrancoisGaits
Copy link
Copy Markdown
Contributor

No description provided.

@@ -0,0 +1,53 @@
This folder contains examples on how to use the program to generate scatterers.

Three use-case are presented :
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Three use-case are presented :
Three use-cases are presented:

Comment on lines +5 to +7
- Visualisation of the scatterers in the probe coordinate system using DICOM
- Visualisation of the scatterers in the global coordinate system using a cube and a tilted probe
- Generation of scatterers to be used in off-line simulation using a sphere
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Visualisation of the scatterers in the probe coordinate system using DICOM
- Visualisation of the scatterers in the global coordinate system using a cube and a tilted probe
- Generation of scatterers to be used in off-line simulation using a sphere
- Visualisation of the scatterers in the global coordinate system using a cube and a tilted probe
- Generation of scatterers to be used in off-line simulation using a sphere
- Visualisation of the scatterers in the probe coordinate system using DICOM

Comment on lines +21 to +53
**DICOM visualisation**

*File:*
settings_preview_projectedDICOM.json

***/!\\*** - This configuration file needs to be filled with actual DICOM slice files.

Additionally, only DICOM in the form of one slice by file are accepted, they will be read as stacked bottom up in the given order.

*Out:* a *preview_projectedDICOM.dat* to be used with the scatterer_visualisation.py script.

This file contains scatterers generated and extracted to simulate the DICOM region described, projected in the probe system coordinate.

---

**Tilted Cube in probe coordinate**

*File:*
settings_preview_tiltedCube.json

*Out:*
a *tiltedCubeScats_preview.dat* to be used with the scatterer_visualisation.py script.

This file contains scatterers generated for a tiled probe crossing a cube. the visualisation is done in global coordinate system, with the grid displayed.

---

**Simulation with a Sphere**

*File:* settings_simu_sphere.json

*Out:*
a sphereScats.dat to be used with FieldII/Simus to simulate an ultrasound image using the generated scatterers. This file represents an imaging plane crossing a sphere in its center. No newline at end of file
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**DICOM visualisation**
*File:*
settings_preview_projectedDICOM.json
***/!\\*** - This configuration file needs to be filled with actual DICOM slice files.
Additionally, only DICOM in the form of one slice by file are accepted, they will be read as stacked bottom up in the given order.
*Out:* a *preview_projectedDICOM.dat* to be used with the scatterer_visualisation.py script.
This file contains scatterers generated and extracted to simulate the DICOM region described, projected in the probe system coordinate.
---
**Tilted Cube in probe coordinate**
*File:*
settings_preview_tiltedCube.json
*Out:*
a *tiltedCubeScats_preview.dat* to be used with the scatterer_visualisation.py script.
This file contains scatterers generated for a tiled probe crossing a cube. the visualisation is done in global coordinate system, with the grid displayed.
---
**Simulation with a Sphere**
*File:* settings_simu_sphere.json
*Out:*
a sphereScats.dat to be used with FieldII/Simus to simulate an ultrasound image using the generated scatterers. This file represents an imaging plane crossing a sphere in its center.
**Tilted Cube in probe coordinate**
*File:*
settings_preview_tiltedCube.json
*Out:*
a *tiltedCubeScats_preview.dat* to be used with the scatterer_visualisation.py script.
This file contains scatterers generated for a tiled probe crossing a cube. the visualisation is done in global coordinate system, with the grid displayed.
---
**Simulation with a Sphere**
*File:* settings_simu_sphere.json
*Out:*
a sphereScats.dat to be used with FieldII/Simus to simulate an ultrasound image using the generated scatterers. This file represents an imaging plane crossing a sphere in its center.
---
**DICOM visualisation**
*File:*
settings_preview_projectedDICOM.json
***/!\\*** - We do not provide DICOM files for this example: the configuration file needs to be edited to link to local DICOM files. The configuration file except a list of DICOMs, where each slice is stored in a different file. Files are read as stacked bottom up in the given order.
*Out:* a *preview_projectedDICOM.dat* to be used with the scatterer_visualisation.py script.
This file contains scatterers generated and extracted to simulate the DICOM region described, projected in the probe system coordinate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants