Mercurial > octave-antonio
view scripts/signal/ifftshift.m @ 20165:f1d0f506ee78 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed optimization, polynomial, signal script directories.
* scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m,
scripts/optimization/fminunc.m, scripts/optimization/fsolve.m,
scripts/optimization/fzero.m, scripts/optimization/glpk.m,
scripts/optimization/lsqnonneg.m, scripts/optimization/pqpnonneg.m,
scripts/optimization/qp.m, scripts/optimization/sqp.m,
scripts/polynomial/compan.m, scripts/polynomial/mkpp.m,
scripts/polynomial/mpoles.m, scripts/polynomial/pchip.m,
scripts/polynomial/poly.m, scripts/polynomial/polyaffine.m,
scripts/polynomial/polyder.m, scripts/polynomial/polyeig.m,
scripts/polynomial/polyfit.m, scripts/polynomial/polygcd.m,
scripts/polynomial/polyint.m, scripts/polynomial/polyout.m,
scripts/polynomial/polyval.m, scripts/polynomial/ppder.m,
scripts/polynomial/ppint.m, scripts/polynomial/ppjumps.m,
scripts/polynomial/ppval.m, scripts/polynomial/residue.m,
scripts/polynomial/roots.m, scripts/polynomial/spline.m,
scripts/polynomial/splinefit.m, scripts/polynomial/unmkpp.m,
scripts/signal/arch_fit.m, scripts/signal/arch_rnd.m,
scripts/signal/arma_rnd.m, scripts/signal/autoreg_matrix.m,
scripts/signal/bartlett.m, scripts/signal/blackman.m, scripts/signal/detrend.m,
scripts/signal/diffpara.m, scripts/signal/durbinlevinson.m,
scripts/signal/fftconv.m, scripts/signal/fftfilt.m, scripts/signal/fftshift.m,
scripts/signal/filter2.m, scripts/signal/freqz.m, scripts/signal/hamming.m,
scripts/signal/hanning.m, scripts/signal/hurst.m, scripts/signal/ifftshift.m,
scripts/signal/periodogram.m, scripts/signal/sinc.m, scripts/signal/sinetone.m,
scripts/signal/sinewave.m, scripts/signal/spectral_adf.m,
scripts/signal/spectral_xdf.m, scripts/signal/spencer.m, scripts/signal/stft.m,
scripts/signal/synthesis.m, scripts/signal/unwrap.m,
scripts/signal/yulewalker.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 04 May 2015 21:50:57 -0700 |
parents | 4197fc428c7d |
children |
line wrap: on
line source
## Copyright (C) 1997-2015 Vincent Cautaerts ## ## 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 ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} ifftshift (@var{x}) ## @deftypefnx {Function File} {} ifftshift (@var{x}, @var{dim}) ## Undo the action of the @code{fftshift} function. ## ## For even length @var{x}, @code{fftshift} is its own inverse, but odd lengths ## differ slightly. ## @seealso{fftshift} ## @end deftypefn ## Author: Vincent Cautaerts <vincent@comf5.comm.eng.osaka-u.ac.jp> ## Created: July 1997 ## Adapted-By: jwe ## Modified-By: Paul Kienzle, converted from fftshift ## Modified-By: David Bateman, add NDArray capability and option dim arg function retval = ifftshift (x, dim) retval = 0; if (nargin != 1 && nargin != 2) print_usage (); endif if (nargin == 2) if (! isscalar (dim)) error ("ifftshift: dimension must be an integer scalar"); endif nd = ndims (x); sz = size (x); sz2 = floor (sz(dim) / 2); idx = repmat ({':'}, nd, 1); idx{dim} = [sz2+1:sz(dim), 1:sz2]; retval = x(idx{:}); else if (isvector (x)) xl = length (x); xx = floor (xl/2); retval = x([xx+1:xl, 1:xx]); elseif (ismatrix (x)) nd = ndims (x); sz = size (x); sz2 = floor (sz ./ 2); idx = cell (); for i = 1:nd idx{i} = [sz2(i)+1:sz(i), 1:sz2(i)]; endfor retval = x(idx{:}); else error ("ifftshift: expecting vector or matrix argument"); endif endif endfunction %!test %! x = [0:7]; %! y = ifftshift (x); %! assert (y, [4 5 6 7 0 1 2 3]); %! assert (ifftshift (y), x); %!test %! x = [0:6]; %! y = ifftshift (x); %! assert (y, [3 4 5 6 0 1 2]); %! assert (ifftshift (y), [6 0 1 2 3 4 5]); %!test %! x = [0:7]'; %! y = ifftshift (x); %! assert (y, [4;5;6;7;0;1;2;3]); %! assert (ifftshift (y), x); %!test %! x = [0:6]'; %! y = ifftshift (x); %! assert (y, [3;4;5;6;0;1;2]); %! assert (ifftshift (y), [6;0;1;2;3;4;5]); %!test %! x = [0:3]; %! x = [x;2*x;3*x+1;4*x+1]; %! y = ifftshift (x); %! assert (y, [[7 10 1 4];[9 13 1 5];[2 3 0 1];[4 6 0 2]]); %! assert (ifftshift (y), x); %!test %! x = [0:3]; %! x = [x;2*x;3*x+1;4*x+1]; %! y = ifftshift (x,1); %! assert (y, [[1 4 7 10];[1 5 9 13];[0 1 2 3];[0 2 4 6]]); %! assert (ifftshift (y,1), x); %!test %! x = [0:3]; %! x = [x;2*x;3*x+1;4*x+1]; %! y = ifftshift (x,2); %! assert (y, [[2 3 0 1];[4 6 0 2];[7 10 1 4];[9 13 1 5]]); %! assert (ifftshift (y,2), x);