Mercurial > octave
view scripts/signal/unwrap.m @ 28886:d8318c12d903
test: remove unnecessary BIST tests in m-files checking for excessive number of inputs.
Remove BIST tests now that interpreter enforces calling function with no more than
the number of arguments defined in the function prototype.
* makeUniqueStrings.m, makeValidName.m, base64decode.m, base64encode.m,
record.m, sound.m, soundsc.m, acosd.m, acot.m, acotd.m, acoth.m, acsc.m,
acscd.m, acsch.m, asec.m, asecd.m, asech.m, asind.m, atan2d.m, atand.m, cosd.m,
cot.m, cotd.m, coth.m, csc.m, cscd.m, csch.m, sec.m, secd.m, sech.m, sind.m,
tand.m, accumdim.m, bincoeff.m, bitget.m, bitset.m, cell2mat.m, circshift.m,
cplxpair.m, cumtrapz.m, deg2rad.m, flip.m, fliplr.m, flipud.m, int2str.m,
interpft.m, logspace.m, num2str.m, postpad.m, prepad.m, rad2deg.m, rot90.m,
rotdim.m, shift.m, subsindex.m, trapz.m, rotx.m, roty.m, rotz.m, getappdata.m,
getpixelposition.m, guidata.m, isappdata.m, waitforbuttonpress.m,
__gripe_missing_component__.m, bessel.m, hsv2rgb.m, ind2gray.m, rgb2gray.m,
rgb2hsv.m, rgbplot.m, fileread.m, javachk.m, usejava.m, findstr.m,
genvarname.m, isdir.m, vectorize.m, cond.m, cross.m, duplication_matrix.m,
expm.m, isbanded.m, isdefinite.m, isdiag.m, ishermitian.m, issymmetric.m,
istril.m, istriu.m, trace.m, vech.m, vecnorm.m, cast.m, citation.m,
compare_versions.m, grabcode.m, inputname.m, isfile.m, isfolder.m, ismac.m,
ispc.m, isunix.m, list_primes.m, methods.m, news.m, open.m, run.m, swapbytes.m,
tar.m, verLessThan.m, zip.m, odeget.m, optimget.m, stemleaf.m, allchild.m,
ancestor.m, close.m, groot.m, hgsave.m, isaxes.m, isfigure.m, isgraphics.m,
ishandle.m, isprop.m, linkaxes.m, rotate.m, saveas.m, conv.m, poly.m,
polyint.m, polyreduce.m, ppval.m, roots.m, addpref.m, getpref.m, ispref.m,
rmpref.m, setpref.m, profile.m, profshow.m, powerset.m, autoreg_matrix.m,
bartlett.m, blackman.m, detrend.m, fftconv.m, fftfilt.m, fftshift.m, hamming.m,
hanning.m, ifftshift.m, sinewave.m, spectral_adf.m, spectral_xdf.m, unwrap.m,
nonzeros.m, spconvert.m, sprand.m, sprandn.m, beta.m, betainc.m, betaln.m,
cosint.m, expint.m, factorial.m, legendre.m, nchoosek.m, nthroot.m, perms.m,
pow2.m, primes.m, reallog.m, realpow.m, realsqrt.m, sinint.m, hankel.m, hilb.m,
invhilb.m, magic.m, pascal.m, toeplitz.m, vander.m, wilkinson.m, center.m,
corr.m, cov.m, discrete_cdf.m, discrete_inv.m, discrete_pdf.m, empirical_cdf.m,
empirical_inv.m, empirical_pdf.m, iqr.m, kendall.m, kurtosis.m, mad.m,
meansq.m, median.m, moment.m, prctile.m, quantile.m, range.m, run_count.m,
skewness.m, spearman.m, statistics.m, std.m, var.m, base2dec.m, bin2dec.m,
blanks.m, dec2base.m, dec2bin.m, dec2hex.m, endsWith.m, erase.m, hex2dec.m,
index.m, isletter.m, isstring.m, isstrprop.m, mat2str.m, ostrsplit.m, rindex.m,
startsWith.m, strtrunc.m, substr.m, fail.m, addtodate.m, asctime.m, ctime.m,
date.m, datestr.m, eomday.m, etime.m, is_leap_year.m, now.m:
remove unnecessary BIST tests in m-files checking for excessive number of inputs.
author | Rik <rik@octave.org> |
---|---|
date | Fri, 09 Oct 2020 13:28:53 -0700 |
parents | 28de41192f3c |
children | 7854d5752dd2 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2000-2020 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## This file is part of Octave. ## ## Octave is free software: you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation, either version 3 of the License, or ## (at your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {@var{b} =} unwrap (@var{x}) ## @deftypefnx {} {@var{b} =} unwrap (@var{x}, @var{tol}) ## @deftypefnx {} {@var{b} =} unwrap (@var{x}, @var{tol}, @var{dim}) ## ## Unwrap radian phases by adding or subtracting multiples of 2*pi as ## appropriate to remove jumps greater than @var{tol}. ## ## @var{tol} defaults to pi. ## ## Unwrap will work along the dimension @var{dim}. If @var{dim} ## is unspecified it defaults to the first non-singleton dimension. ## @end deftypefn function retval = unwrap (x, tol, dim) if (nargin < 1) print_usage (); endif if (! isnumeric (x)) error ("unwrap: X must be a numeric matrix or vector"); endif if (nargin < 2 || isempty (tol)) tol = pi; endif ## Don't let anyone use a negative value for TOL. tol = abs (tol); nd = ndims (x); sz = size (x); if (nargin == 3) if (!(isscalar (dim) && dim == fix (dim)) || !(1 <= dim && dim <= nd)) error ("unwrap: DIM must be an integer and a valid dimension"); endif else ## Find the first non-singleton dimension. (dim = find (sz > 1, 1)) || (dim = 1); endif rng = 2*pi; m = sz(dim); ## Handle case where we are trying to unwrap a scalar, or only have ## one sample in the specified dimension. if (m == 1) retval = x; return; endif ## Take first order difference to see so that wraps will show up ## as large values, and the sign will show direction. idx = repmat ({':'}, nd, 1); idx{dim} = [1,1:m-1]; d = x(idx{:}) - x; ## Find only the peaks, and multiply them by the appropriate amount ## of ranges so that there are kronecker deltas at each wrap point ## multiplied by the appropriate amount of range values. p = round (abs (d)./rng) .* rng .* (((d > tol) > 0) - ((d < -tol) > 0)); ## Now need to "integrate" this so that the deltas become steps. r = cumsum (p, dim); ## Now add the "steps" to the original data and put output in the ## same shape as originally. retval = x + r; endfunction %!shared i, t, r, w, tol %! i = 0; %! t = []; %! r = [0:100]; ## original vector %! w = r - 2*pi*floor ((r+pi)/(2*pi)); ## wrapped into [-pi,pi] %! tol = 1e3*eps; %!assert (r, unwrap (w), tol) %!assert (r', unwrap (w'), tol) %!assert ([r',r'], unwrap ([w',w']), tol) %!assert ([r; r ], unwrap ([w; w ], [], 2), tol) %!assert (r + 10, unwrap (10 + w), tol) %!assert (w', unwrap (w', [], 2)) %!assert (w, unwrap (w, [], 1)) %!assert ([w; w], unwrap ([w; w])) ## Test that small values of tol have the same effect as tol = pi %!assert (r, unwrap (w, 0.1), tol) %!assert (r, unwrap (w, eps), tol) ## Test that phase changes larger than 2*pi unwrap properly %!assert ([0; 1], unwrap ([0; 1])) %!assert ([0; 4 - 2*pi], unwrap ([0; 4])) %!assert ([0; 7 - 2*pi], unwrap ([0; 7])) %!assert ([0; 10 - 4*pi], unwrap ([0; 10])) %!assert ([0; 13 - 4*pi], unwrap ([0; 13])) %!assert ([0; 16 - 6*pi], unwrap ([0; 16])) %!assert ([0; 19 - 6*pi], unwrap ([0; 19])) %!assert (max (abs (diff (unwrap (100*pi * rand (1000, 1))))) < pi) %!test %! A = [pi*(-4), pi*(-2+1/6), pi/4, pi*(2+1/3), pi*(4+1/2), pi*(8+2/3), pi*(16+1), pi*(32+3/2), pi*64]; %! assert (unwrap (A), unwrap (A, pi)); %! assert (unwrap (A, pi), unwrap (A, pi, 2)); %! assert (unwrap (A', pi), unwrap (A', pi, 1)); %!test %! A = [pi*(-4); pi*(2+1/3); pi*(16+1)]; %! B = [pi*(-2+1/6); pi*(4+1/2); pi*(32+3/2)]; %! C = [pi/4; pi*(8+2/3); pi*64]; %! D = [pi*(-2+1/6); pi*(2+1/3); pi*(8+2/3)]; %! E(:, :, 1) = [A, B, C, D]; %! E(:, :, 2) = [A+B, B+C, C+D, D+A]; %! F(:, :, 1) = [unwrap(A), unwrap(B), unwrap(C), unwrap(D)]; %! F(:, :, 2) = [unwrap(A+B), unwrap(B+C), unwrap(C+D), unwrap(D+A)]; %! assert (unwrap (E), F); %!test %! A = [0, 2*pi, 4*pi, 8*pi, 16*pi, 65536*pi]; %! B = [pi*(-2+1/6), pi/4, pi*(2+1/3), pi*(4+1/2), pi*(8+2/3), pi*(16+1), pi*(32+3/2), pi*64]; %! assert (unwrap (A), zeros (1, length (A))); %! assert (diff (unwrap (B), 1) < 2*pi, true (1, length (B)-1)); ## Test input validation %!error <Invalid call> unwrap () %!error unwrap ("foo")