smoothn
Editor's Note: This file was selected as MATLAB Central Pick of the Week
SMOOTHN provides a fast, unsupervised and robust discretized spline smoother for data of arbitrary dimension.
SMOOTHN(Y) automatically smoothes the uniformly-sampled array Y. Y can be any N-D multicomponent noisy array (e.g. time series, images, 3D data, 3D vector fields, tensors...).
To smooth a vector field or multi-component data, Y must be a cell array. For example, if you need to smooth a 3-D vectorial flow (Vx,Vy,Vz), use Y = {Vx,Vy,Vz}. The output Z is also a cell array which contains the smoothed components.
SMOOTHN can deal with missing (NaN) values (see screenshot and examples).
SMOOTHN(...,'robust') carries out a robust smoothing that minimizes the influence of outlying data (see screenshot and examples).
SMOOTHN is made unsupervised by the minimization of the generalized cross-validation score.
Enter "help smoothn" in the Matlab command window for complete instructions and 1-D to 3-D examples.
A series of 8 documented examples is available here:
http://www.biomecardio.com/matlab/smoothn_doc.html
-----
When using this algorithm, please refer to these 2 papers:
1) Garcia D. Robust smoothing of gridded data in one and higher dimensions with missing values.
Comput Statist Data Anal, 2010;54:1167-1178
http://www.biomecardio.com/publis/csda10.pdf
2) Garcia D. A fast all-in-one method for automated post-processing of PIV data.
Exp Fluids, 2011;50:1247-1259.
http://www.biomecardio.com/publis/expfluids11.pdf
-----
Comments and Ratings (52)
Updates
| 2.2.1 | verLessThan('matlab','9.2'); instead of verLessThan('matlab','9.1'); |
|
| 2.2 | - fixed bug in isstruct(varargin{end-1})
|
|
| 2.1.4.0 | updated links |
|
| 2.1.3.0 | updated links |
|
| 2.1.2.0 | updated links |
|
| 2.1.1.0 | . |
|
| 2.1.0.0 | minor updates: 1) use narginchk, 2) two warning messages slightly modified |
|
| 2.0.0.0 | minor update: 1) use narginchk, 2) some warning messages slightly modified |
|
| 1.37.0.0 | I noticed a minor error in one comment |
|
| 1.36.0.0 | . |
|
| 1.35.0.0 | . |
|
| 1.34.0.0 | Some modifications in the help text |
|
| 1.33.0.0 | To simplify the syntax, the termination parameters are now in a structure (OPTIONS). |
|
| 1.32.0.0 | Numerical adjustment in the leverage (for robust smoothing) in the case of unequal spacing increments. |
|
| 1.31.0.0 | SMOOTHN, by default, assumes that the spacing increments are constant and equal in all the directions (i.e. dx = dy = dz = ...). Spacing increments that differ from one direction to the other can now be used (enter "help smoothn" for details). |
|
| 1.30.0.0 | There was a non negligible bug in the new SMOOTHN function:
|
|
| 1.28.0.0 | Update of the help text |
|
| 1.27.0.0 | A minor bug in the "Initial Guess" criterion has been removed |
|
| 1.26.0.0 | A bug was present when dealing with complex numbers |
|
| 1.25.0.0 | A small bug was present in the subfunction InitialGuess (Thank you Jonathan!) |
|
| 1.24.0.0 | One bug has been fixed. |
|
| 1.23.0.0 | SMOOTHN now works with multicomponent data (e.g. 3D vector fields) by using cell arrays. See the help text for details. |
|
| 1.22.0.0 | DCTN and IDCTN are now included in SMOOTHN |
|
| 1.21.0.0 | some typos |
|
| 1.20.0.0 | 3 optional weighting functions |
|
| 1.19.0.0 | 3 optional weighting functions |
|
| 1.12.0.0 | minor modifications: mlint messages removed |
|
| 1.11.0.0 | Some options have been removed/added |
|
| 1.10.0.0 | fix a minor bug with the warning messages |
|
| 1.9.0.0 | Minor modification in the relaxation factor |
|
| 1.8.0.0 | A minor bug in error(nargchk(...)) |
|
| 1.7.0.0 | Gamma was undefined when "isauto" variable was false. |
|
| 1.6.0.0 | The link to the manuscript has been modified. |
|
| 1.5.0.0 | A bug has been reported with a smoothness parameter input. Thank you B.S. |
|
| 1.3.0.0 | Very much faster now with weighted/missing data:
|
|
| 1.2.0.0 | The "upsample" option has been removed |
|
| 1.1.0.0 | An example has been added |
MATLAB Release Compatibility
Platform Compatibility
Windows macOS LinuxTags
Acknowledgements
Inspired: PCG_unwrap_2D(ph_nii, ph_file, mask_nii, max_iter, epsi_con, N), PIVlab - particle image velocimetry (PIV) tool, Quick & easy smoothing, Robust smoothing for 1-D to N-D data (easy version of SMOOTHN), PIVsuite
Discover Live Editor
Create scripts with code, output, and formatted text in a single executable document.
Nishant Kumar (view profile)
For resolving the error: 'Error using .* : Matrix dimensions must agree.' when smoothening a surface, replace
y = y.*w{dim};
in smoothn>dctn and smoothn>idctn with
y = y.*w{dim}(:,ones(1,n));
gdgc (view profile)
job rosier (view profile)
I get an error message when I try to run you code with Example #7: smooth a 2-D vector field:
Error using .*
Matrix dimensions must agree.
Error in smoothn>dctn (line 728)
y = y.*w{dim};
Is this due to your latest update?
I'm using matlab version 2016a.
C G (view profile)
I want to give this a good rating, but I an told I need to download DCTN and IDCTN. The link given to be doesn't lead anywhere. If something is required to use the function, why wouldn't it be included in the download?
BB (view profile)
Phillip (view profile)
shaojiang wu (view profile)
Abhinav Gaur (view profile)
Bochen ZHANG (view profile)
zjxugd (view profile)
Hinduf (view profile)
Very nice. Many thanks
Shalin Parikh (view profile)
Hi Damien, Is there any minimum and maximum value for the smoothing parameter S used?
Parker Sorenson (view profile)
Dang Le Van (view profile)
Just used a part of the code. Very clear instruction. Well done! Thanks for sharing.
Dipankar Kumar (view profile)
Thanks to Damien Garcia for your robust and fast function for smooting.
Sathish Sanjeevi (view profile)
This function is gold! Would be largely helpful for the scientific community across different disciplines.
Michal Kvasnicka (view profile)
Perfect ... !!! Robust and fast function for smoothing.
yuseff12 (view profile)
works great and very smoothly :)
Ned Gulley (view profile)
I featured this file in a blog post about how to write good help for your function. Thanks and well done! http://blogs.mathworks.com/community/2016/07/29/getting-by-with-a-little-help/
Brian McFall (view profile)
Works great and it's easy to adjust the robustness of the smoothing function.
Kevin Miller (view profile)
Stephan Koehler (view profile)
I'm trying to run this on large data sets, which crashes my computer. Is there any way to chunk it, i.e. break up say a 1000x1000x1000 array into pieces and merge the smoothened pieces?
jigsaw (view profile)
David MERCIER (view profile)
ogadol (view profile)
Hi Damien
Im applying smoothn in order to smooth bathmetric data sets and it works perfectly. I'm using a smooth factor of 10^9 on a 1601X1601 grid. The spacing of the points in realty is 12.5 m. can you please tell me what is the spatial meaning of the smooth factor in my case ?
Thanks
Ogadol
Rogier Westerhoff (view profile)
Works fine for me!
John Booker (view profile)
Matteo Niccoli (view profile)
Jospeh Chang (view profile)
arnold (view profile)
hey Damien,
is there a way to suppress filling of missing values (nans to be specific)? it'd be really useful if this were an option.
Thanks
Arnold
TT (view profile)
francisco fuentes (view profile)
Really nice tool, thank you.
Ben (view profile)
Hi Damien,
What if I have non-uniformly sampled array? Could it be possible to us this function? Currently, I found the smoothed curve did not maintain the start and end points in 3D. The smoothed curve looks being shrunk.
Martin Lechner (view profile)
Super tool for smoothing!
Ben (view profile)
Thanks for sharing!! This is really a nice pice of code.
Michael (view profile)
What is with the "DCTN and iDCTN are required"? I was able to access them outside the MatLab browser, but not from within it.
Matlab2010 (view profile)
Jakub Wosyka (view profile)
Hello Damien,
very useful and nice function.
I tried to add the non-uniform grid (x values) according to your article but then it only interpolates the data. When I raise the value of smooting parameter, new the function will fall to zero (zero mean). (...probably my fault...). Do you plan to extend this nice function for non-uniform grids? Thank you
Erdal Bizkevelci (view profile)
Erik (view profile)
Really nice method!
I does seem to me though that there is a bug when using this in combination with your pppiv-function.
In the function RobustWeights, there is a line:
MAD = median(abs(r(I)-median(r(I))));
However, the values of r are complex when using it together with pppiv. That causes the median function to sort the values by the real component and then take the middle value. I think you probably want to add
r = abs(r);
before taking the median to sort the residuals by magnitude instead. Is that correct?
Richard (view profile)
Well done! well documented. very easy to use.
Richard
Balengi (view profile)
I like this function very much...I do have a question though. I am smoothing a 50x50x3 n-d array but after smoothing my 3-d object is much flatter than the original. it almost seems distorted...has this ever happened to you before?
Juha-Matti Alakoskela (view profile)
Warwick (view profile)
Very good!. Minor effort to obtain dctn and idctn but this is an easy way to smooth out "zigzag" contours (much better than going with INTERP2( Array, ntimes)).
thank you.
Damien Garcia (view profile)
to Matthew: you should have read the File description:
MATLAB release: MATLAB 7.5 (R2007b)
BSXFUN is nonexistent in versions prior to 7.4!
Regards. DG
Matthew Souders (view profile)
Code does not work out of the box for MATLAB 7.1 - at least I was unable to get it to function. Attempted a test case and got this error:
??? Undefined function or method 'bsxfun' for input argument of type 'function_handle'.
Error in ==> smoothn at line 266
Lambda = bsxfun(@plus,Lambda...
If some special set-up is required to make this code run successfully, this needs to be carefully documented.
Mark Shore (view profile)
Mark Shore (view profile)
Definitely very interesting looking. Well referenced with a range of 1, 2 and 3D examples, which work quite well. I'll rate this once I've had a chance to look at it in more detail.
However the author should correct the required products listing since the image processing toolbox is NOT a requirement per se. All of the provided test examples work perfectly without it. A call to bwdist to replace NaNs in supplied data defaults gracefully to another option if the image processing toolbox is not installed. And rgb2gray and imnoise are required only to _create_ the example of the noisy Saturn image given above, not to denoise it.
It would also be convenient for the author to include his subroutines dctn.m and idctn.m in the FEX file if possible, rather than requiring a separate download from an external web site.
Rob Campbell (view profile)
This is nice!
Jan (view profile)
H1 line, really descriptive help, examples, date and author mentioned, comments in the code, referenced method, and finally it works well.
Xianmin (view profile)
Good job!
Carlos Adrian Vargas Aguilera (view profile)
Welcome back!