k-Wave Toolbox

# Release Notes

## Current Version

k-Wave Toolbox Version B.0.3 (third beta release)

## Change Log - B.0.3

Release Date: 15th February 2011

New Features and Changes:

- support for time varying velocity inputs via `source.u_mask`, `source.ux`etc````
- sensor data now also returns velocity if `'ReturnVelocity'` is set to `true`
- sensor frequency response can be defined using `sensor.frequency_response`
- time reversal image reconstructions can include compensation for acoustic attenuation
- `'CartInterp'` set to `'linear'` now uses `TriScattererdInterp` and is supported in 3D
- `'PMLInside'` set to `false` is now supported in 3D
- estimated simulation times are given
- the PML can be hidden by setting `'PlotPML'` to `false`
- `'PlotScale'` can now also be set to `'auto'` and the display can be log compressed by setting `'LogScale'` to `true`
- 2D simulations can now also be displayed as a mesh plot by setting `'MeshPlot'` to `true`
- movie frame capture in 2D can be controlled using `'MovieType'`
- default smoothing now only applies to the initial pressure distribution
- `kgrid.x_off` (etc) fields are no longer supported
- bug fix in setting initial velocity for time staggered grids
- new k-space simulation function `kspaceSecondOrder` based on a second-order lossy wave equation for homogeneous media
- `makeGrid` now uses class definitions
- `spectrum` now supports all window shapes defined in `getWin`
- `smooth` now uses a Blackman window as default and supports all window shapes defined in `getWin`
- `resize` function inputs have changed and now supports 3D inputs
- bug fix in `kspacePlaneRecon` remapping

New Functions:

- `addNoise`
- `applyFilter`
- `benchmark`
- `expandMatrix`
- `fwhm`
- `gaussian`
- `getAlphaFilter`
- `getDateString`
- `getWin`
- `interpftn`
- `kspaceSecondOrder`
- `saveTiffStack`
- `voxelPlot`

New Examples:

- Recording The Particle Velocity
- Defining A Gaussian Sensor Frequency Response
- Comparison Of Modelling Functions
- Setting An Initial Pressure Gradient
- Photoacoustic Waveforms in 1D, 2D and 3D
- Dipole Point Source In A Homogeneous Propagation Medium
- The Doppler Effect
- Diffraction Through A Slit
- Focussed Detector in 3D
- Modelling Sensor Directivity in 2D
- Modelling Sensor Directivity in 3D
- Focussed 2D Array with Directional Elements
- Image Reconstruction With Directional Sensors
- Image Reconstruction With Bandlimited Sensors
- Image Reconstruction With Compensation For Acoustic Absorption
- Source Smoothing
- Modelling Power Law Absorption

## Change Log - B.0.2

Release Date: 23rd January 2010

New Features:

- inputs redefined as structures
- power law absorption
- 2D sensor directivity
- time varying pressure inputs

New Functions:

- `attenuationWater`
- `db2neper`
- `filterTimeSeries`
- `grid2cart`
- `neper2db`
- `numDim`
- `powerLawKramersKronig`
- `scaleSI`
- `scaleTime`
- `spectrum`
- `speedSoundWater`
- `toneBurst`

## Change Log - B.0.1

Release Date: 22nd July 2009

First Beta Release.

## Planned Additions To The Toolbox

Extensions currently under active development or beta testing:

- Functions to define ultrasound transducers, simulate beam patterns and b-mode images
- Simulation functions for non-linear wave propagation
- Simulation functions for elastic wave propagation

Additional planned extensions:

- Support for cylindrically symmetric 3D geometries
- A phantoms repository
- Additional reconstruction algorithms for photoacoustic tomography

© 2009, 2010, 2011 Bradley Treeby and Ben Cox.