Settings

Package: kwave.toolbox

Class used to define settings for k-Wave simulations.

Description

Defines default settings used in the k-Wave simulation classes. To modify settings, first create a Settings object, then modify the properties. The object can then be passed as an input to the simulation classes.

Examples

settings = kwave.toolbox.Settings;
settings.plotSimulation = 'off';

Properties

• colorMap - (numeric) Color map used for 2D plots (see colormap). Default is the k-Wave color map.
• plotFrequency - (integer) The number of iterations which must pass before the simulation plot is updated. Default = 10.
• plotScale - (numeric) [min, max] values used to control the scaling for imagesc (visualisation). Default = [-1, 1].
• plotSimulation - ('on', 'off') Option to progressively display the running simulation. Default = 'on'.
• simulationDataType - ('single', 'double') Data-type used for simulation calculations. Default = 'single'.