-
Notifications
You must be signed in to change notification settings - Fork 2
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
Added readme to describe the examples #3
Open
FrancoisGaits
wants to merge
1
commit into
STORM-IRIT:main
Choose a base branch
from
FrancoisGaits:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nmellado
reviewed
Jun 20, 2023
@@ -0,0 +1,53 @@ | |||
This folder contains examples on how to use the program to generate scatterers. | |||
|
|||
Three use-case are presented : |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.