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

[#156] Meaningful names for benchmark scenarios #190

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

NewtonSander
Copy link
Collaborator

Reopening #159

#156
To avoid generating merge conflicts on a few open PRs, I won't merge this until some of the larger PRs touching Scenario are merged.

Introduction

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 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"

Changes

Rename scenarios:

  • Scenario0 -> ScenarioSimple
  • Scenario1 -> ScenarioFlatSkull
  • Scenario2 -> ScenarioRealisticSkull
  • Scenario2Benchmark7 -> ScenarioRealisticSkullCropped
  • Scenario3 -> ScenarioUltrasoundPhantom

Behavior

How the new behavior is different from the current behavior, how you tested and how the reviewer can test it.

All unit/integration tests and docs should run as usual. I also searched the project to check for any variable names I missed.

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

Successfully merging this pull request may close these issues.

2 participants