Documentation

This is machine translation

Translated by Microsoft
Mouse over text to see original. Click the button below to return to the English verison of the page.

DSP System Toolbox Functions

Alphabetical List By Category

Signal Generation, Manipulation, and Analysis

Signal Operations

dsp.DigitalDownConverter Translate digital signal from Intermediate Frequency (IF) band to baseband and decimate it
dsp.DigitalUpConverter Interpolate digital signal and translate it from baseband to Intermediate Frequency (IF) band
dsp.FarrowRateConverter Polynomial sample rate converter with arbitrary conversion factor
dsp.Interpolator Linear or FIR interpolation
dsp.SampleRateConverter Multistage sample rate converter
dsp.Convolver Convolution of two inputs
dsp.DCBlocker Remove DC component
dsp.Window Window object
dsp.PeakFinder Determine extrema (maxima or minima) in input signal
dsp.PhaseExtractor Extract the unwrapped phase of a complex input
dsp.PhaseUnwrapper Unwrap signal phase
dsp.ZeroCrossingDetector Zero crossing detector
dsp.Delay Delay input by specified number of samples or frames
dsp.VariableFractionalDelay Delay input by time-varying fractional number of sample periods
dsp.VariableIntegerDelay Delay input by time-varying integer number of sample periods

Signal Generation

dsp.ColoredNoise Colored noise generator
dsp.Chirp Generate swept-frequency cosine (chirp) signal
dsp.HDLNCO Generate real or complex sinusoidal signals—optimized for HDL code generation
dsp.NCO Generate real or complex sinusoidal signals
dsp.SignalSource Import variable from workspace
dsp.SineWave Discrete-time sinusoid

Signal Import and Export

audioDeviceWriter Play to sound card
dsp.UDPReceiver Receive UDP packets from network
dsp.UDPSender Send UDP packets to network
dsp.AudioFileReader Stream from audio file
dsp.AudioFileWriter Stream to audio file
dsp.BinaryFileReader Read data from binary file
dsp.BinaryFileWriter Write data to binary files
dsp.MatFileReader Read MAT file
dsp.MatFileWriter Write MAT file

Scopes and Data Logging

dsp.TimeScope Time domain signal display
dsp.SpectrumAnalyzer Display frequency spectrum of time-domain signals
dsp.ArrayPlot Display vectors or arrays
dsp.LogicAnalyzer Display transitions of signals over time
dsp.SignalSink Log simulation data in buffer
spbscopes.SpectrumAnalyzerConfiguration Configure Spectrum Analyzer for programmatic access

Buffers, Switches, and Counters

dsp.Buffer Buffer input signal
dsp.DelayLine Rebuffer sequence of inputs with one-sample shift
dsp.Counter Count up or down through specified range of numbers
rebuffer_delay Number of samples of delay introduced by buffering and unbuffering operations

Filter Design and Analysis

Filter Design

filterDesigner Open Filter Designer app
filterBuilder GUI-based filter design
fvtool Open Filter Visualization Tool
design Apply design method to filter specification object
designmethods Methods available for designing filter from specification object
designopts Valid input arguments and values for specification object and method
equiripple Equiripple single-rate FIR filter from specification object
fdesign Filter specification object
fdesign.bandpass Bandpass filter specification object
fdesign.bandstop Bandstop filter specification object
fdesign.highpass Highpass filter specification object
fdesign.lowpass Lowpass filter specification
fdesign.decimator Decimator filter specification object
fdesign.interpolator Interpolator filter specification
fdesign.rsrc Rational-factor sample-rate converter specification
fdesign.arbmag Arbitrary response magnitude filter specification object
fdesign.arbmagnphase Arbitrary response magnitude and phase filter specification object
fdesign.audioweighting Audio weighting filter specification object
fdesign.ciccomp CIC compensator filter specification object
fdesign.comb IIR comb filter specification object
fdesign.differentiator Differentiator filter specification object
fdesign.fracdelay Fractional delay filter specification object
fdesign.halfband Halfband filter specification object
fdesign.hilbert Hilbert filter specification object
fdesign.isinchp Inverse sinc highpass filter specification
fdesign.isinclp Inverse sinc lowpass filter specification
fdesign.notch Notch filter specification
fdesign.nyquist Nyquist filter specification
fdesign.octave Octave filter specification
fdesign.peak Peak filter specification
fdesign.polysrc Construct polynomial sample-rate converter (POLYSRC) filter designer
freqsamp Real or complex frequency-sampled FIR filter from specification object
help Help for design method with filter specification
setspecs Specifications for filter specification object
validstructures Structures for specification object with design method
designMultirateFIR Multirate FIR filter design
fircband Constrained-band equiripple FIR filter
firceqrip Constrained equiripple FIR filter
fireqint Equiripple FIR interpolators
firgr Parks-McClellan FIR filter
firhalfband Halfband FIR filter
firlpnorm Least P-norm optimal FIR filter
firls Least-square linear-phase FIR filter design
firminphase Minimum-phase FIR spectral factor
firnyquist Lowpass Nyquist (Lth-band) FIR filter
firpr2chfb Two-channel FIR filter bank for perfect reconstruction
ifir Interpolated FIR filter from filter specification
normalizefreq Switch filter specification between normalized frequency and absolute frequency
ca2tf Convert coupled allpass filter to transfer function form
cl2tf Convert coupled allpass lattice to transfer function form
iircomb IIR comb notch or peak filter
iirgrpdelay Optimal IIR filter with prescribed group-delay
iirlpnorm Least P-norm optimal IIR filter
iirlpnormc Constrained least Pth-norm optimal IIR filter
iirnotch Second-order IIR notch filter
iirpeak Second-order IIR peak or resonator filter
normalizefreq Switch filter specification between normalized frequency and absolute frequency

Filter Analysis

filterDesigner Open Filter Designer app
fvtool Open Filter Visualization Tool
freqrespest Frequency response estimate via filtering
freqrespopts Options for filter frequency response analysis
freqz Frequency response of filter
grpdelay Filter group delay
impz Filter impulse response
impzlength Impulse response length
measure Measure filter magnitude response
noisepsd Power spectral density of filter output due to roundoff noise
noisepsdopts Options for running filter output noise PSD
phasedelay Phase delay of filter
phasez Unwrapped phase response for filter
stepz Step response for filter
zerophase Zero-phase response for filter
zplane Zero-poles plots for filters
coeffs Coefficients for filters
cost Estimate cost of discrete-time or multirate filter
cumsec Vector of SOS filters for cumulative sections
disp Filter properties and values
double Cast fixed-point filter to use double-precision arithmetic
fftcoeffs Frequency-domain coefficients
filtstates.cic Store CIC filter states
norm P-norm of filter
nstates Number of filter states
order Order of fixed-point filter
reset Reset filter properties to initial conditions
firtype Type of linear phase FIR filter
isallpass Determine whether filter is allpass
isfir Determine whether filter is FIR
islinphase Determine whether filter has linear phase
ismaxphase Determine whether filter is maximum phase
isminphase Determine whether filter is minimum phase
isreal Determine whether filter uses real coefficients
issos Determine whether filter is SOS form
isstable Determine whether filter is stable
scalecheck Check scaling of SOS filter
block Generate block from a digital filter
realizemdl Simulink subsystem block for filter
allpass2wdf Allpass to Wave Digital Filter coefficient transformation
normalizefreq Switch filter specification between normalized frequency and absolute frequency
wdf2allpass Wave Digital Filter to allpass coefficient transformation

Frequency Transformations

firlp2hp Convert FIR lowpass filter to Type I FIR highpass filter
firlp2lp Convert FIR Type I lowpass to FIR Type 1 lowpass with inverse bandwidth
iirbpc2bpc Transform IIR complex bandpass filter to IIR complex bandpass filter with different characteristics
iirlp2bp Transform IIR lowpass filter to IIR bandpass filter
iirlp2bpc IIR lowpass to complex bandpass transformation
iirlp2bs Transform IIR lowpass filter to IIR bandstop filter
iirlp2bsc Transform IIR lowpass filter to IIR complex bandstop filter
iirlp2hp Transform lowpass IIR filter to highpass filter
iirlp2lp Transform lowpass IIR filter to different lowpass filter
iirlp2mb Transform IIR lowpass filter to IIR M-band filter
iirlp2mbc Transform IIR lowpass filter to IIR complex M-band filter
iirlp2xc Transform IIR lowpass filter to IIR complex N-point filter
iirlp2xn Transform IIR lowpass filter to IIR real N-point filter
iirpowcomp Power complementary IIR filter

Filter Implementation

Single-Rate Filters

dsp.AnalyticSignal Analytic signals of discrete-time inputs
dsp.Differentiator Direct form FIR fullband differentiator filter
dsp.FIRFilter Static or time-varying FIR filter
dsp.HighpassFilter FIR or IIR highpass filter
dsp.LowpassFilter FIR or IIR lowpass filter
dsp.MedianFilter Median filter
dsp.VariableBandwidthFIRFilter Variable bandwidth FIR filter
dsp.AllpassFilter Single section or cascaded allpass filter
dsp.AllpoleFilter IIR Filter with no zeros
dsp.BiquadFilter IIR filter using biquadratic structures
dsp.CoupledAllpassFilter Coupled allpass IIR filter
dsp.HighpassFilter FIR or IIR highpass filter
dsp.IIRFilter Infinite Impulse Response (IIR) filter
dsp.LowpassFilter FIR or IIR lowpass filter
dsp.NotchPeakFilter Second-order tunable notching and peaking IIR filter
dsp.VariableBandwidthIIRFilter Variable bandwidth IIR filter
convert Convert filter structure of discrete-time filter
sysobj Create filter System object from discrete-time filter
filter Filter data with filter object
dfilt.delay Delay filter
dfilt.dffir Discrete-time, direct-form FIR filter
dfilt.dffirt Discrete-time, direct-form FIR transposed filter
dfilt.dfsymfir Discrete-time, direct-form symmetric FIR filter
dfilt.dfasymfir Discrete-time, direct-form antisymmetric FIR filter
dfilt.farrowlinearfd Farrow Linear Fractional Delay filter
dfilt.farrowfd Fractional Delay Farrow filter
dfilt.fftfir Discrete-time, overlap-add, FIR filter
dfilt.latticemamax Discrete-time, lattice, moving-average filter with maximum phase
dfilt.latticemamin Discrete-time, lattice, moving-average filter with minimum phase
dfilt.scalar Discrete-time, scalar filter
dfilt.allpass Allpass filter
dfilt.calattice Coupled-allpass, lattice filter
dfilt.calatticepc Coupled-allpass, power-complementary lattice filter
dfilt.df1 Discrete-time, direct-form I filter
dfilt.df1sos Discrete-time, SOS direct-form I filter
dfilt.df1t Discrete-time, direct-form I transposed filter
dfilt.df1tsos Discrete-time, SOS direct-form I transposed filter
dfilt.df2 Discrete-time, direct-form II filter
dfilt.df2sos Discrete-time, SOS, direct-form II filter
dfilt.df2t Discrete-time, direct-form II transposed filter
dfilt.df2tsos Discrete-time, SOS direct-form II transposed filter
dfilt.latticeallpass Discrete-time, lattice allpass filter
dfilt.latticear Discrete-time, lattice, autoregressive filter
dfilt.latticearma Discrete-time, lattice, autoregressive, moving-average filter
dfilt.wdfallpass Wave digital allpass filter
dfilt.cascade Cascade of discrete-time filters
dfilt.parallel Discrete-time, parallel structure filter
dfilt.cascadeallpass Cascade of allpass discrete-time filters
dfilt.cascadewdfallpass Cascade allpass WDF filters to construct allpass WDF

Multirate and Multistage Filters

dsp.Channelizer Polyphase FFT analysis filter bank
dsp.ChannelSynthesizer Polyphase FFT synthesis filter bank
dsp.FarrowRateConverter Polynomial sample rate converter with arbitrary conversion factor
dsp.FIRDecimator Polyphase FIR decimator
dsp.FIRHalfbandDecimator Halfband decimator
dsp.FIRHalfbandInterpolator Halfband interpolator
dsp.FIRInterpolator Polyphase FIR interpolator
dsp.FIRRateConverter Sample rate converter
dsp.HDLFIRRateConverter Upsample, filter, and downsample—optimized for HDL code generation
dsp.IIRHalfbandDecimator Decimate by factor of two using polyphase IIR
dsp.IIRHalfbandInterpolator Interpolate by a factor of two using polyphase IIR
dsp.DigitalDownConverter Translate digital signal from Intermediate Frequency (IF) band to baseband and decimate it
dsp.DigitalUpConverter Interpolate digital signal and translate it from baseband to Intermediate Frequency (IF) band
dsp.FilterCascade Construct a cascade of filter System objects
dsp.SampleRateConverter Multistage sample rate converter
dsp.CICCompensationDecimator Compensate for CIC decimation filter using FIR decimator
dsp.CICCompensationInterpolator Compensate for CIC interpolation filter using FIR interpolator
dsp.CICDecimator Decimate input using Cascaded Integrator-Comb filter
dsp.CICInterpolator Interpolate signal using Cascaded Integrator-Comb filter
dsp.DyadicAnalysisFilterBank Dyadic analysis filter bank
dsp.DyadicSynthesisFilterBank Reconstruct signals from subbands
dsp.SubbandAnalysisFilter Decompose signal into high-frequency and low-frequency subbands
dsp.SubbandSynthesisFilter Reconstruct signal from high-frequency and low-frequency subbands
cascade Cascade of filter system objects
convert Convert filter structure of discrete-time filter
filter Filter data with filter object
polyphase Polyphase decomposition of multirate filter
sysobj Create filter System object from discrete-time filter

Adaptive Filters

dsp.BlockLMSFilter Compute output, error, and weights using Block LMS adaptive algorithm
dsp.LMSFilter LMS adaptive filter
dsp.RLSFilter Compute output, error and coefficients using Recursive Least Squares (RLS) algorithm
dsp.AffineProjectionFilter Compute output, error and coefficients using Affine Projection (AP) Algorithm
dsp.AdaptiveLatticeFilter Adaptive lattice filter
dsp.FastTransversalFilter Fast Transversal filter
dsp.FilteredXLMSFilter Filtered XLMS filter
dsp.FrequencyDomainAdaptiveFilter Frequency Domain Adaptive filter
dsp.KalmanFilter Estimate system measurements and states using Kalman filter

Transforms and Spectral Analysis

Transforms

dsp.DCT Discrete cosine transform (DCT)
dsp.IDCT Inverse discrete cosine transform (IDCT)
dsp.FFT Discrete Fourier transform
dsp.HDLIFFT Inverse fast Fourier transform—optimized for HDL code generation
dsp.HDLFFT Fast Fourier transform—optimized for HDL code generation
dsp.IFFT Inverse discrete Fourier transform (IDFFT)

Linear Prediction

dsp.CepstralToLPC Convert cepstral coefficients to linear prediction coefficients
dsp.LevinsonSolver Solve linear system of equations using Levinson-Durbin recursion
dsp.LPCToAutocorrelation Convert linear prediction coefficients to autocorrelation coefficients
dsp.LPCToCepstral Convert linear prediction coefficients to cepstral coefficients
dsp.LPCToLSF Convert linear prediction coefficients to line spectral frequencies
dsp.LPCToLSP Convert linear prediction coefficients to line spectral pairs
dsp.LPCToRC Convert linear prediction coefficients to reflection coefficients
dsp.LSFToLPC Convert line spectral frequencies to linear prediction coefficients
dsp.LSPToLPC Convert line spectral pairs to linear prediction coefficients
dsp.RCToAutocorrelation Convert reflection coefficients to autocorrelation coefficients
dsp.RCToLPC Convert reflection coefficients to linear prediction coefficients

Spectral Analysis

dsp.SpectrumAnalyzer Display frequency spectrum of time-domain signals
dsp.SpectrumEstimator Estimate power spectrum or power density spectrum
dsp.CrossSpectrumEstimator Estimate cross-spectral density
dsp.TransferFunctionEstimator Estimate transfer function
dsp.BurgAREstimator Estimate of autoregressive (AR) model parameters using Burg method
dsp.BurgSpectrumEstimator Parametric spectral estimate using Burg method

Statistics and Linear Algebra

Measurements and Statistics

dsp.MedianFilter Median filter
dsp.MovingAverage Moving average
dsp.MovingMaximum Moving maximum
dsp.MovingMinimum Moving minimum
dsp.MovingRMS Moving Root Mean Square
dsp.MovingStandardDeviation Moving standard deviation
dsp.MovingVariance Moving variance
dsp.Autocorrelator Autocorrelation sequence
dsp.Crosscorrelator Cross-correlation of two inputs
dsp.Maximum Find maximum value of input or sequence of inputs
dsp.Mean Find mean value of input or sequence of inputs
dsp.Median Median value of input
dsp.Minimum Find minimum values of input or sequence of inputs
dsp.RMS Root mean square of vector elements
dsp.StandardDeviation Standard deviation of input or sequence of inputs
dsp.Variance Variance of input or sequence of inputs
dsp.Histogram Histogram of input or sequence of inputs
dsp.PeakToPeak Peak-to-peak value
dsp.PeakToRMS Peak-to-root-mean-square value of vector
dsp.PulseMetrics Pulse metrics of bilevel waveforms
dsp.StateLevels State-level estimation for bilevel rectangular waveform
dsp.TransitionMetrics Transition metrics of bilevel waveforms

Array and Matrix Mathematics

dsp.ArrayVectorAdder Add array to vector along specified dimension
dsp.ArrayVectorDivider Divide array by vector along specified dimension
dsp.ArrayVectorMultiplier Multiply array by vector along specified dimension
dsp.ArrayVectorSubtractor Subtract vector from array along specified dimension
dsp.CumulativeProduct Cumulative product of channel, column, or row elements
dsp.CumulativeSum Cumulative sum of channel, column, or row elements
dsp.Normalizer Vector normalization along specified dimension
dsp.HDLComplexToMagnitudeAngle Compute magnitude and phase angle of complex signal—optimized for HDL code generation

Linear Algebra

dsp.LDLFactor Factor square Hermitian positive definite matrices into components
dsp.LevinsonSolver Solve linear system of equations using Levinson-Durbin recursion
dsp.LowerTriangularSolver Solve lower-triangular matrix equation
dsp.LUFactor Factor square matrix into lower and upper triangular matrices
dsp.UpperTriangularSolver Solve upper-triangular matrix equation

Fixed-Point Design

Fixed-Point Filters

dsp.AllpoleFilter IIR Filter with no zeros
dsp.BiquadFilter IIR filter using biquadratic structures
dsp.Differentiator Direct form FIR fullband differentiator filter
dsp.FIRFilter Static or time-varying FIR filter
dsp.HighpassFilter FIR or IIR highpass filter
dsp.IIRFilter Infinite Impulse Response (IIR) filter
dsp.LowpassFilter FIR or IIR lowpass filter
dsp.CICCompensationDecimator Compensate for CIC decimation filter using FIR decimator
dsp.CICCompensationInterpolator Compensate for CIC interpolation filter using FIR interpolator
dsp.CICDecimator Decimate input using Cascaded Integrator-Comb filter
dsp.CICInterpolator Interpolate signal using Cascaded Integrator-Comb filter
dsp.DigitalDownConverter Translate digital signal from Intermediate Frequency (IF) band to baseband and decimate it
dsp.DigitalUpConverter Interpolate digital signal and translate it from baseband to Intermediate Frequency (IF) band
dsp.FarrowRateConverter Polynomial sample rate converter with arbitrary conversion factor
dsp.FIRDecimator Polyphase FIR decimator
dsp.FIRHalfbandDecimator Halfband decimator
dsp.FIRHalfbandInterpolator Halfband interpolator
dsp.FIRInterpolator Polyphase FIR interpolator
dsp.FIRRateConverter Sample rate converter
dsp.HDLFIRRateConverter Upsample, filter, and downsample—optimized for HDL code generation
dsp.SubbandAnalysisFilter Decompose signal into high-frequency and low-frequency subbands
dsp.SubbandSynthesisFilter Reconstruct signal from high-frequency and low-frequency subbands
dsp.LMSFilter LMS adaptive filter
autoscale Automatic dynamic range scaling
denormalize Undo filter coefficient and gain changes caused by normalize
freqrespest Frequency response estimate via filtering
freqrespopts Options for filter frequency response analysis
freqz Frequency response of filter
impz Filter impulse response
isstable Determine whether filter is stable
limitcycle Response of single-rate, fixed-point IIR filter
noisepsd Power spectral density of filter output due to roundoff noise
noisepsdopts Options for running filter output noise PSD
normalize Normalize filter numerator or feed-forward coefficients
qreport Most recent fixed-point filtering operation report
reffilter Reference filter for fixed-point or single-precision filter
reorder Rearrange sections in SOS filter
scale Scale sections of SOS filter
set2int Configure filter for integer filtering
specifyall Fixed-point scaling modes in direct-form FIR filter
zplane Zero-poles plots for filters

Quantizers

dsp.ScalarQuantizerDecoder Convert each index value into quantized output value
dsp.ScalarQuantizerEncoder Associate input value with index value of quantization region
dsp.UniformDecoder Decode integer input into floating-point output
dsp.UniformEncoder Quantize and encode floating-point input into integer output
dsp.VectorQuantizerDecoder Vector quantizer codeword for given index value
dsp.VectorQuantizerEncoder Vector quantization encoding

Code Generation

DSP Algorithm Acceleration

dspunfold Generates a multi-threaded MEX file from a MATLAB function
codegen Generate C/C++ code from MATLAB code

Define System Objects

Basic Operations

matlab.System Base class for System objects
matlab.system.mixin.FiniteSource Finite source mixin class
matlab.system.StringSet Set of valid character vector values

Properties and States

matlab.System Base class for System objects
matlab.system.StringSet Set of valid character vector values

Load and Save

matlab.System Base class for System objects

Use in Simulink

Icon and Dialog

matlab.System Base class for System objects
matlab.system.mixin.CustomIcon Custom icon mixin class
matlab.system.display.Action Custom button
matlab.system.display.Header Header for System objects properties
matlab.system.display.Section Property group section for System objects
matlab.system.display.SectionGroup Section group for System objects

Input and Output Specifications

matlab.System Base class for System objects
matlab.system.mixin.Propagates Signal characteristics propagation mixin class

Nondirect Feedthrough

matlab.System Base class for System objects
matlab.system.mixin.Nondirect Nondirect feedthrough mixin class

For Each Subsystem

matlab.System Base class for System objects
Was this topic helpful?