| k-Wave Toolbox |
k-Wave Toolbox Version 1.1.1
Release Date: 9th October 2015
Bug Fixes:
pstdElastic2D and pstdElastic3D when defining material coefficients on staggered grid (generated incorrect results)Release Date: 3rd October 2014
New Features and Changes:
pstdElastic2D and pstdElastic3D functionssensor.masksensor.record now supports the additional input options 'p_min', 'p_max_all', 'p_min_all', 'u_min', 'u_max_all', 'u_min_all', and 'u_non_staggered'attenCompvesselFilterkspaceFirstOrder3DC now supports optional inputs to specify the name and location of the binary and data filesmakeSphere and makeSphericalSection can be set to return logical matrices to reduce memory usageresize now supports 1D inputscheckFactors now also reports prime numbersBug Fixes:
sensor.record set to 'p_min' (generated error)sensor.directivity_angle with the optional input 'DataCast' set to 'gpuArray-single' (generated error)kspaceFirstOrder3DC when performing time reversal image reconstruction using sensor.time_reversal_boundary_data with 'PMLInside' set to false (PML was not removed)kspaceFirstOrder3DC when calling script on a different drive using Windows (generated error)kspaceSecondOrder when setting absorption values with medium.alpha_power to values less than 1 (returned NaN)kspaceSecondOrder when using sensor.record = {'p_final'} (generated error, grid expansion not removed)makeSphere for grid sizes with uneven dimensions (generated error)makeSphere to centre sphere on the kgrid origin (previously offset by 1)writeMatrix for source variables larger than 1 MB (incorrect chunk size generated error)New Functions:
attenCompcheckStabilityfitPowerLawParamsgetBLIgetSpacedPointsh5comparekspaceFirstOrder3DGmaxNDminNDoverlayPlotpstdElastic2DpstdElastic3Drevolve2DtimeShiftvesselFilterwriteAttributeswriteFlagswriteGridNew Examples:
Release Date: 13th November 2012
New Features and Changes:
sensor.record = {'p', 'u', 'p_final', ...}sensor.record = {'I', 'I_avg', ...}'ReturnVelocity' and sensor.record_mode and the output field_data have been deprecatedsensor.record_start_index'DataCast' can now be set to 'gpuArray-single' or 'gpuArray-double' to automatically run simulations on a graphics processing unit (GPU) using the Parallel Computing Toolbox (R2012a or later)'DataCast''DataRecast' to true'DataCast' settings and the interpolation speed during runtime has been significantly improved'CartInterp' set to 'linear' is now the default setting for 1D, 2D, and 3D simulationskgrid.k within kWaveGrid has been modified to improve memory efficiencyspectrum has been renamed to spect to avoid a naming conflict with the MATLAB signal processing toolbox, and now accepts matrix inputsmakeTime now uses the maximum sound speed to compute dt, and the minimum sound speed to compute t_endunmaskSensorData function inputs have changedBug Fixes:
'PlotLayout' set to true when medium.sound_speed or medium.density are scalar (generated plot error)'DataCast' set to 'GPUsingle'p_mode set to 'dirichlet'kspaceFirstOrder2D with 'MeshPlot' set to truemakeGrid when defining the wavenumber variables kgrid.k, kgrid.kx (etc) for grid sizes with an odd number of grid pointsmakeSphere for grid sizes with an odd number of grid pointsgetWin for type set to 'Gaussian' or 'Kaiser' with a user input for 'Param' (param value was not used)scan_line method of kWaveTransducer for scan lines formed using a negative steering angle (generated error)grid2cart for 1D inputs (list of Cartesian points returned in the wrong direction)kspaceSecondOrderNew Functions:
beamPlotfocusgetFDMatrixgradientSpectgradientFDkspaceFirstOrder3DCmakeLinemakeSphericalSectionreorderSensorDatascaleFigscanConversionwriteMatrixNew Examples:
Release Date: 28th February 2012
New Features and Changes:
source.p_mode and source.u_mode to 'dirichlet'kspaceFirstOrder1D, kspaceFirstOrder2D, kspaceFirstOrder3D has been modified to reduce code duplication'PMLAlpha' changed to 2kspaceFirstOrder1D has been improved'PlotLayout' option have been modified to allow easier interpretationstackedPlot functionality has been extended and the default axis limits fixedverBug Fixes:
kWaveTransducer class (no scaling was applied)kWaveTransducer class (data type was set incorrectly)kspaceFirstOrder1D using velocity sources (source incorrectly named)'PlotLayout', true with 'DataCast', 'gsingle' (generated blank jacket figure)'StreamToDisk' option (error generated if kgrid.Nt exactly divisible by saving frequency)New Functions:
New Examples:
Release Date: 21st December 2011
New Features and Changes:
makeGrid are now (Nx, dx) in 1D, (Nx, dx, Ny, dy) in 2D, and (Nx, dx, Ny, dy, Nz, dz) in 3D
medium.BonAmedium.alpha_coeff as a matrixkspaceFirstOrder1D, kspaceFirstOrder2D, kspaceFirstOrder3D, and makeGrid have been re-written to significantly reduce memory usagesource and sensor inputs can be defined as an object of kWaveTransducer type (returned by makeTransducer) to allow simple simulations using ultrasound transducerssource.ux, source.uy, and source.uz can be specified individuallysource.p, source.ux, etc., can now contain any number of time points (they do not need to be the same length as kgrid.t_array)
medium.sound_speed_refsensor.record_mode to 'statistics'
sensor_data can now optionally be streamed to disk by setting the optional input parameter 'StreamToDisk' to truetoneBurst function inputs have changeddb2neper and neper2db now use exact conversion factorsensor.frequency_response is given is now performed using gaussianFilterBug Fixes:
kspaceFirstOrder3Dkgrid.t_array has an odd number of time pointskspaceFirstOrder2D when saving movies with 'MovieType' set to 'image' (the first frame did not display the sensor mask), and the movie frames variable is now preallocatedkWaveGrid class when 1/Nx (etc) is a recurring numberNew Functions:
checkFactorsenvelopeDetectionfindClosestgaussianFilterlogCompressionmakeTransducermendoussestackedPlotNew Examples:
Release Date: 15th February 2011
New Features and Changes:
source.u_mask, source.ux etc'ReturnVelocity' is set to truesensor.frequency_response'CartInterp' set to 'linear' now uses TriScattererdInterp and is supported in 3D'PMLInside' set to false is now supported in 3D'PlotPML' to false'PlotScale' can now also be set to 'auto' and the display can be log compressed by setting 'LogScale' to true'MeshPlot' to true'MovieType'kgrid.x_off (etc) fields are no longer supportedkspaceSecondOrder based on a second-order lossy wave equation for homogeneous mediamakeGrid now uses class definitionsspectrum now supports all window shapes defined in getWinsmooth now uses a Blackman window as default and supports all window shapes defined in getWinresize function inputs have changed and now supports 3D inputskspacePlaneRecon remappingNew Functions:
addNoiseapplyFilterbenchmarkexpandMatrixfwhmgaussiangetAlphaFiltergetDateStringgetWininterpftnkspaceSecondOrdersaveTiffStackvoxelPlotNew Examples:
Release Date: 23rd January 2010
New Features:
New Functions:
attenuationWaterdb2neperfilterTimeSeriesgrid2cartneper2dbnumDimpowerLawKramersKronigscaleSIscaleTimespectrumspeedSoundWatertoneBurstRelease Date: 22nd July 2009
First Beta Release.
© 2009-2014 Bradley Treeby and Ben Cox.