IMSY-DKFZ / simpa

The Simulation and Image Processing for Photonics and Acoustics (SIMPA) toolkit.
https://simpa.readthedocs.io/en/main/
Other
84 stars 18 forks source link

Default settings should be managed by the SimulationModule #29

Open jgroehl opened 3 years ago

jgroehl commented 3 years ago

Define abstract method in SimulatioModule class

jgroehl commented 3 years ago

lets use this for the main documentation which parameters the adapter needs

TomTomRixRix commented 4 months ago
TomTomRixRix commented 4 months ago

In PR #358 I've now implemented a way to set default component settings for the adapters and default global settings. I think before proceeding further with the documentation, examples and tests it would make sense to have a meeting where we go through this list and check if all default values are sensible and if no default parameter was forgotten.

Furthermore three questions came up:

  1. Should processing components also have default settings?
  2. Would it make sense to treat all settings as a read-only configuration? Then we would have to find a new solution for the wavelength and simpa_output_path in the simulate method which are currently stored in the global settings during simulation. Passing them as an additional argument to the run method of the pipeline elements would be one option.
  3. Would it make sense to have a list of required (component) settings for each adapter which can be checked in the beginning of each adapter and a warning or error can be logged if something is missing. Then the user would have a better overview which of these required settings are already set by default and which they have to set manually. This should of course also be included into the documentation of each adapter.