Documentation

This is machine translation

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

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

dsp.PhaseUnwrapper System object

Unwrap signal phase

Description

The PhaseUnwrapper object unwraps the signal phase input specified in radians.

To unwrap the signal phase input:

  1. Define and set up your System object™. See Construction.

  2. Call step to unwrap the signal phase according to the properties of dsp.PhaseUnwrapper. The behavior of step is specific to each object in the toolbox.

Note

Starting in R2016b, instead of using the step method to perform the operation defined by the System object, you can call the object with arguments, as if it were a function. For example, y = step(obj,x) and y = obj(x) perform equivalent operations.

Construction

phUnwrap = dsp.PhaseUnwrapper returns a System object, phUnwrap. This System object adds or subtracts appropriate multiples of 2πto each input element to remove phase discontinuities (unwrap).

phUnwrap = dsp.PhaseUnwrapper('PropertyName',PropertyValue,...) returns an unwrapped System object, phUnwrap, with each specified property set to the specified value.

Properties

InterFrameUnwrap

Enable unwrapping of phase discontinuities between successive frames

Set this property to false to unwrap phase discontinuities only within the frame. Set this property to true to also unwrap phase discontinuities between successive frames. The default is true.

Tolerance

Jump size as true phase discontinuity

Specify the jump size that the phase unwrapper recognizes as a true phase discontinuity. The default is set to π (rather than a smaller value) to avoid altering legitimate signal features. To increase the phase wrapper sensitivity, set the Tolerance property to a value slightly less than π.

Methods

resetReset internal states of Phase Unwrapper System object
stepUnwrap input phase signal input
Common to All System Objects
clone

Create System object with same property values

getNumInputs

Expected number of inputs to a System object

getNumOutputs

Expected number of outputs of a System object

isLocked

Check locked states of a System object (logical)

release

Allow System object property value changes

Examples

expand all

Note: This example runs only in R2016b or later. If you are using an earlier release, replace each call to the function with the equivalent step syntax. For example, myObject(x) becomes step(myObject,x).

phUnwrap = dsp.PhaseUnwrapper;
p = [0 2/5 4/5 -4/5 -2/5 0 2/5 4/5 -4/5 -2/5 0 2/5 ...
    4/5 -4/5, -2/5]*pi;
y = phUnwrap(p');
figure,stem(p); hold
Current plot held
stem(y, 'r');
legend('Input (blue)','Unwrapped data (red)');
hold off;

Algorithms

This object implements the algorithm, inputs, and outputs described on the Unwrap block reference page. The object properties correspond to the Simulink® block parameters.

Extended Capabilities

See Also

Introduced in R2012a

Was this topic helpful?