Documentation Center

  • Trial Software
  • Product Updates

Contents

dsp.PhaseUnwrapper System object

Package: dsp

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.

Construction

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

H = dsp.PhaseUnwrapper('PropertyName',PropertyValue,...) returns an unwrapped System object, H, 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. This property applies when you set the FrameBasedProcessing to true. 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 .

FrameBasedProcessing

Enable frame-based processing

Set this property to true to enable frame-based processing. Set this property to false to enable sample-based processing. The default is true.

Methods

cloneCreate phase unwrapper object with same property values
getNumInputsNumber of expected inputs to the step method
getNumOutputsNumber of outputs of the step method
isLockedLocked status for input attributes and nontunable properties
releaseAllow property value and input characteristics changes
resetReset internal states of Phase Unwrapper System object
stepUnwrap input phase signal input

Examples

Unwrap input phase data:

hunwrap = 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 = step(hunwrap, p'); 
figure,stem(p); hold 
stem(y, 'r');

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.

Objects and blocks interpret frames differently. Objects process inputs as frames or as samples by setting the FrameBasedProcessing property. Blocks process inputs as frames or as samples by inheriting the frame information from the input ports. See Set the FrameBasedProcessing Property of a System object for more information.

See Also

Was this topic helpful?