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

Meaningful names for benchmark scenarios #156

Open
charlesbmi opened this issue Sep 25, 2023 · 2 comments
Open

Meaningful names for benchmark scenarios #156

charlesbmi opened this issue Sep 25, 2023 · 2 comments
Assignees

Comments

@charlesbmi
Copy link
Contributor

Issue

Scenarios provide a convenient structure to describe the environment, transducers, and sensors. A collection of preconfigured scenarios are provided with NDK, and can be easily loaded.

The existing scenarios are:

SCENARIO_0 (2D) - a simple quickstart toy scenario that enables users to dive in and experiment with their first simulation immediately.
SCENARIO_1_3D (3D) - a scenario containing a flat 3-layer bone covered by skin, with water above the skin and brain below the bone. This is based on benchmark 4 of Jean-Francois Aubry, et al..
SCENARIO_2_3D (3D) - a scenario containing a full skull and brain mesh immersed in water. This is based on benchmark 8 of Jean-Francois Aubry, et al..
SCENARIO_1_2D (2D) - a 2D version of scenario 1.
SCENARIO_2_2D (2D) - a 2D version of scenario 2.

The scenario numbering does not correspond to anything meaningful. Instead, it would be helpful for users if we named them with descriptive names, like "3-layer skull model" and "RealisticSkull"

@charlesbmi charlesbmi self-assigned this Sep 26, 2023
@charlesbmi
Copy link
Contributor Author

charlesbmi commented Sep 26, 2023

Proposed naming:

  • SCENARIO_0 -> ScenarioSimple
  • SCENARIO_1 -> ScenarioFlatSkull
  • SCENARIO_2 -> ScenarioRealisticSkull
  • SCENARIO_3 -> ScenarioUltrasoundPhantom

@charlesbmi
Copy link
Contributor Author

Open to suggestions whether these scenario names should still include their indexing, e.g. Scenario_0_Simple - this would keep their order in a file explorer / Github browser when viewing.

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 a pull request may close this issue.

1 participant