fftshift — Shift zero-frequency components to spectrum centers in MATLAB and RunMat.
fftshift(X) circularly shifts FFT output so the zero-frequency component moves to the center of each shifted dimension. The default all-dimension behavior and optional dimension selection follow MATLAB semantics.
Syntax
Y = fftshift(X)
Y = fftshift(X, DIM)Inputs
X- Type
Any- Required
- Yes
- Description
- Numeric, complex, logical, or gpuArray input.
DIM- Type
Any- Required
- No
- Description
- Positive scalar dimension; vectors and logical masks are RunMat extensions.
Returns
Y- Type
Any- Description
- Shifted array with the same size and type family as X.
Errors
RunMat:fftshift:ArgCount- When
- More than two input arguments are supplied.
- Message
fftshift: invalid argument count
RunMat:fftshift:InvalidDimensions- When
- DIM argument is malformed or out of range.
- Message
fftshift: invalid dimension argument
RunMat:fftshift:InvalidInput- When
- X is not a supported numeric/logical input type.
- Message
fftshift: expected numeric or logical input
Provider and fusion contract
The provider hook advertises f32 and f64 floating precision with no broadcasting; integer and logical behavior follows the separate documented conversion or exact-reordering rules.
This operation is a fusion boundary, not an elementwise or reduction kernel. No fused FFT kernel is advertised, and provider launch details remain internal.
Behavior
When called without a dimension list, fftshift shifts along every dimension by floor(size(X, dim) / 2).
fftshift(X, DIM) shifts one documented scalar dimension. Numeric vectors and logical masks are separately gated RunMat extensions.
Dimensions of length 0 or 1 are left unchanged.
Inputs can be real or complex and may already reside on the GPU (gpuArray).
GPU execution
Uses the owning provider's circshift hook only after a read-only positive preflight. A false preflight permits host fallback before provider effects; admitted failures are terminal and never replayed.
GPU residency
A valid native result remains on the owning device. Preflight-unavailable work gathers once and restores through the same owner only when it can physically preserve the class. You can call gpuArray explicitly when you want a residency boundary.
GPU behavior
RunMat uses the input owner's circshift hook when preflight admits the request; otherwise it shifts through the exact host path. Scalars and empty arrays remain on their existing device without a hook call.
Examples
Centering the spectrum of a 1-D FFT result with even length
x = [0 1 2 3 4 5 6 7];
fx = fft(x);
y = fftshift(fx)Expected output:
y = [-4 -4-1.6569i -4-4i -4-9.6569i 28 -4+9.6569i -4+4i -4+1.6569i]Handling odd-length vectors
x = 1:5;
y = fftshift(x)Expected output:
y = [4 5 1 2 3]Centering both axes of a 2-D FFT
A = [1 2 3; 4 5 6];
C = fftshift(A)Expected output:
C =
6 4 5
3 1 2Shifting only one dimension of a matrix
A = [1 2 3; 4 5 6];
rowCentered = fftshift(A, 1) % shift rows onlyExpected output:
rowCentered =
4 5 6
1 2 3Applying fftshift to a gpuArray spectrum
G = gpuArray(0:7);
centered = fftshift(G);
H = gather(centered)Expected output:
H = [4 5 6 7 0 1 2 3]Using fftshift with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how fftshift changes the result.
Run a small fftshift example, explain the result, then change one input and compare the output.
FAQ
When should I call fftshift?⌄
Call fftshift whenever you need to center FFT outputs before visualising spectra, computing radial averages, or applying filters that expect zero frequency in the middle of the array.
Does fftshift modify the phase or magnitude of the FFT?⌄
No. fftshift only reorders the samples. Magnitudes, phases, and the overall information content remain unchanged.
How do I undo fftshift?⌄
Use ifftshift, which performs the inverse rearrangement. The sequence ifftshift(fftshift(X)) returns X for all supported inputs.
Can I apply fftshift to only one dimension?⌄
Pass a positive scalar dimension such as fftshift(X,2). RunMat extension mode additionally accepts numeric dimension vectors and logical masks.
Does fftshift work with gpuArray inputs?⌄
Yes. RunMat keeps data on the GPU whenever the provider exposes the circshift hook, matching MATLAB's gpuArray behaviour.
How does fftshift handle empty inputs?⌄
Empty arrays are returned unchanged with identical shape metadata.
Can I use fftshift on logical arrays?⌄
Yes. Logical arrays are shifted without changing their logical element type.
Related Math functions
Elementwise
abs · angle · besselj · bsxfun · complex · conj · double · eps · erf · erfcinv · exp · expm1 · flintmax · gamma · gammaln · heaviside · hypot · imag · int16 · int32 · int64 · int8 · intmax · intmin · ldivide · log · log10 · log1p · log2 · minus · nextpow2 · plus · pow2 · power · rdivide · real · realmax · realmin · realsqrt · rescale · sign · single · sqrt · times · typecast · uint16 · uint32 · uint64 · uint8
Optim
acceptancesa · annealingboltz · annealingfast · coneprog · crossoverarithmetic · crossoverheuristic · crossoverintermediate · crossoverlaplace · crossoverscattered · crossoversinglepoint · crossovertwopoint · eqnproblem · EquationProblem.solve · EquationProblem.subsasgn · EquationProblem.subsref · evaluate · fgoalattain · fitscalingprop · fitscalingrank · fitscalingshiftlinear · fitscalingtop · fminbnd · fmincon · fminimax · fminsearch · fminunc · fseminf · fsolve · fzero · ga · gacreationlinearfeasible · gacreationnonlinearfeasible · gacreationsobol · gacreationuniform · gacreationuniformint · gaplotbestf · gaplotbestindiv · gaplotdistance · gaplotexpectation · gaplotgenealogy · gaplotmaxconstr · gaplotrange · gaplotscorediversity · gaplotscores · gaplotselection · gaplotstopping · integerConstraint · integral · intlinprog · linprog · lsqcurvefit · lsqlin · LsqlinWarmStart.subsasgn · LsqlinWarmStart.subsref · lsqnonlin · lsqnonneg · mutationadaptfeasible · mutationgaussian · mutationpositivebasis · mutationpower · mutationuniform · optimexpr · optimget · OptimizationConstraint.evaluate · OptimizationConstraint.subsasgn · OptimizationConstraint.subsref · OptimizationExitflag.double · OptimizationExitflag.eq · OptimizationExitflag.ne · OptimizationExitflag.string · OptimizationExpression.acos · OptimizationExpression.acosh · OptimizationExpression.acot · OptimizationExpression.acoth · OptimizationExpression.acsc · OptimizationExpression.acsch · OptimizationExpression.asec · OptimizationExpression.asech · OptimizationExpression.asin · OptimizationExpression.asinh · OptimizationExpression.atan · OptimizationExpression.atanh · OptimizationExpression.cat · OptimizationExpression.cos · OptimizationExpression.cosh · OptimizationExpression.cot · OptimizationExpression.coth · OptimizationExpression.csc · OptimizationExpression.csch · OptimizationExpression.ctranspose · OptimizationExpression.cumprod · OptimizationExpression.cumsum · OptimizationExpression.diag · OptimizationExpression.diff · OptimizationExpression.dot · OptimizationExpression.eq · OptimizationExpression.evaluate · OptimizationExpression.exp · OptimizationExpression.ge · OptimizationExpression.horzcat · OptimizationExpression.ldivide · OptimizationExpression.le · OptimizationExpression.log · OptimizationExpression.mean · OptimizationExpression.minus · OptimizationExpression.mldivide · OptimizationExpression.mpower · OptimizationExpression.mrdivide · OptimizationExpression.mtimes · OptimizationExpression.norm · OptimizationExpression.plus · OptimizationExpression.power · OptimizationExpression.prod · OptimizationExpression.rdivide · OptimizationExpression.reshape · OptimizationExpression.sec · OptimizationExpression.sech · OptimizationExpression.sin · OptimizationExpression.sinh · OptimizationExpression.sqrt · OptimizationExpression.subsasgn · OptimizationExpression.subsref · OptimizationExpression.sum · OptimizationExpression.tan · OptimizationExpression.tanh · OptimizationExpression.times · OptimizationExpression.trace · OptimizationExpression.transpose · OptimizationExpression.uminus · OptimizationExpression.uplus · OptimizationExpression.vertcat · OptimizationExpression.zeros · OptimizationExpression.zerosLike · OptimizationProblem.solve · OptimizationProblem.subsasgn · OptimizationProblem.subsref · OptimizationVariable.subsasgn · OptimizationVariable.subsref · optimoptions · optimplotconstrviolation · optimplotfirstorderopt · optimplotfunccount · optimplotfval · optimplotfvalconstr · optimplotmilp · optimplotstepsize · optimplotx · optimproblem · optimset · optimvar · optimwarmstart · particleswarm · patternsearch · psplotbestf · psplotbestx · psplotfuncount · psplotmaxconstr · psplotmeshsize · pswcreationuniform · pswplotbestf · quad · quadprog · QuadprogWarmStart.subsasgn · QuadprogWarmStart.subsref · saplotbestf · saplotbestx · saplotf · saplotstopping · saplottemperature · saplotx · savemilpsolutions · secondordercone · selectionremainder · selectionroulette · selectionstochunif · selectiontournament · selectionuniform · simulannealbnd · solve · surrogateopt · surrogateoptplot · temperatureboltz · temperatureexp · temperaturefast
Trigonometry
acos · acosd · acosh · acotd · acscd · asecd · asin · asind · asinh · atan · atan2 · atan2d · atand · atanh · cos · cosd · cosh · cospi · deg2rad · pol2cart · rad2deg · sin · sind · sinh · sinpi · tan · tand · tanh
Reduction
all · any · bounds · cummax · cummin · cumprod · cumsum · cumtrapz · diff · gradient · max · maxk · mean · median · min · mink · movmax · movmean · movmedian · movmin · movprod · movstd · movsum · movvar · nnz · prod · rms · std · sum · trapz · var
Structure
bandwidth · isdiag · ishermitian · issymmetric · istril · istriu · symrcm
Signal
blackman · butter · buttord · cheb2ord · conv · conv2 · deconv · downsample · envelope · filter · filtfilt · fir1 · freqz · gauspuls · hamming · hann · hilbert · periodogram · pulstran · pwelch · rectpuls · resample · sawtooth · sinc · spectrogram · square · tripuls · unwrap · upsample · zplane
Factor
chol · decomposition · decomposition.ctranspose · decomposition.mldivide · decomposition.mrdivide · decomposition.mtimes · decomposition.rdivide · decomposition.subsref · decomposition.times · decomposition.uminus · decomposition.uplus · eig · eigs · gmres · ichol · ilu · lu · ordeig · ordqz · ordschur · pcg · qr · qz · rsf2csf · schur · svd
Ops
cross · ctranspose · dot · mldivide · mpower · mrdivide · mtimes · pagemtimes · pagetranspose · trace · transpose
Interpolation
griddedInterpolant · griddedInterpolant.subsref · interp1 · interp1q · interp2 · pchip · ppval · spline
Integer Division
Source you can read
Every RunMat function's source is public. Read exactly how fftshift is executed, line by line, in Rust.
- View the source for fftshift in Rust on GitHub
- Learn how the RunMat runtime works
- Found a bug? Open an issue with a minimal reproduction.
About RunMat
RunMat is a runtime that executes MATLAB-syntax code fast on any GPU. The runtime is free for individuals, including freelancers; students and faculty at an academic institution, for teaching or research there; contributors to an open-source project, for work on that project; organizations with 250 or fewer people and US$10M or less in annual revenue; and anyone, for non-production use. See runmat.com/license.
- RunMat automatically optimizes your math for GPU execution on Apple, Nvidia, and AMD hardware. No code changes needed. Simulations that took hours now take minutes.
- Start running code in seconds. RunMat runs in the browser, on the desktop, or from the CLI. No license server, no IT ticket.