Mercurial > octave-antonio

comparison scripts/signal/fftshift.m @ 20165:f1d0f506ee78 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
20164:df437a52bcaf 20165:f1d0f506ee78
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} fftshift (@var{x}) 20 ## @deftypefn {Function File} {} fftshift (@var{x})
21 ## @deftypefnx {Function File} {} fftshift (@var{x}, @var{dim}) 21 ## @deftypefnx {Function File} {} fftshift (@var{x}, @var{dim})
22 ## Perform a shift of the vector @var{x}, for use with the @code{fft} 22 ## Perform a shift of the vector @var{x}, for use with the @code{fft} and
23 ## and @code{ifft} functions, in order the move the frequency 0 to the 23 ## @code{ifft} functions, in order the move the frequency 0 to the center of
24 ## center of the vector or matrix. 24 ## the vector or matrix.
25 ## 25 ##
26 ## If @var{x} is a vector of @math{N} elements corresponding to @math{N} 26 ## If @var{x} is a vector of @math{N} elements corresponding to @math{N} time
27 ## time samples spaced by @nospell{@math{dt}}, then 27 ## samples spaced by @nospell{@math{dt}}, then
28 ## @code{fftshift (fft (@var{x}))} corresponds to frequencies 28 ## @code{fftshift (fft (@var{x}))} corresponds to frequencies
29 ## 29 ##
30 ## @example 30 ## @example
31 ## f = [ -(ceil((N-1)/2):-1:1)*df 0 (1:floor((N-1)/2))*df ] 31 ## f = [ -(ceil((N-1)/2):-1:1)*df 0 (1:floor((N-1)/2))*df ]
32 ## @end example 32 ## @end example
33 ## 33 ##
34 ## @noindent 34 ## @noindent
35 ## where @nospell{@math{df} = 1 / @math{dt}}. 35 ## where @nospell{@math{df} = 1 / @math{dt}}.
36 ## 36 ##
37 ## If @var{x} is a matrix, the same holds for rows and columns. If 37 ## If @var{x} is a matrix, the same holds for rows and columns. If @var{x}
38 ## @var{x} is an array, then the same holds along each dimension. 38 ## is an array, then the same holds along each dimension.
39 ## 39 ##
40 ## The optional @var{dim} argument can be used to limit the dimension 40 ## The optional @var{dim} argument can be used to limit the dimension along
41 ## along which the permutation occurs. 41 ## which the permutation occurs.
42 ## @seealso{ifftshift}
42 ## @end deftypefn 43 ## @end deftypefn
43 44
44 ## Author: Vincent Cautaerts <vincent@comf5.comm.eng.osaka-u.ac.jp> 45 ## Author: Vincent Cautaerts <vincent@comf5.comm.eng.osaka-u.ac.jp>
45 ## Created: July 1997 46 ## Created: July 1997
46 ## Adapted-By: jwe 47 ## Adapted-By: jwe