Engee documentation

Unwrap

Removes the phase gap in the signal.

blockType: Unwrap

Path in the library:

/Signal Operations/Signal Operations/Unwrap

Description

Block Unwrap restores each channel of the input signal by adding or subtracting a multiple of , to each element of the channel. The block recognizes phase gaps that exceed the value of the parameter. Tolerance(radians).

Ports

Input

# IN_1 — Input signal
scalar | vector | the matrix

Details

Input signal for recovery. The phase of the input signal should be expressed in radians.

Data types

Float16, Float32, Float64, Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64

Complex numbers support

I don’t

Output

# OUT_1 — Output signal
scalar | vector | the matrix

Details

The restored signal.

The unit stores the size and dimension of the input signal, and the sampling rate of the output signal is equal to the sampling rate of the input.

Data types

Float64

Complex numbers support

I don’t

Parameters

Main

# Tolerance(radians) — gap size
Real number

Details

The size of the gap that the block recognizes as a true phase gap. By default the value is set to , and not less, in order to avoid changing the natural characteristics of the signal.

To increase the sensitivity of the block, set the parameter Tolerance(radians) the value is slightly smaller .

Default value

pi

Program usage name

Tolerance

Tunable

No

Evaluatable

Yes

# Input processing — input signal processing method
Elements as channels (sample based) | Columns as channels (frame based)

Details

Specify the input signal processing method:

  • Columns as channels (frame based) — when this value is selected, the unit processes each column of the input signal as a separate channel;

  • Elements as channels (sample based) — when this value is selected, the unit processes each element of the input signal as a separate channel.

Values

Elements as channels (sample based) | Columns as channels (frame based)

Default value

Columns as channels (frame based)

Program usage name

InputProcessing

Tunable

No

Evaluatable

No

# Reset initial phase to zero for each input frame — checking consecutive frames
Logical

Details

When this check box is unchecked, the block ignores the boundaries between frames of the input signal and does not reset the initial phase value to zero with each new input signal. In this mode, the unit continuously expands the data in each column of the input signal.

The figure below shows how the block expands the data when this checkbox is unchecked.

unwrap 1

When this check box is checked, the block processes each frame of input data independently and resets the initial phase value for each new frame.

The figure below shows how the block expands the data when this check box is selected.

unwrap 2

Dependencies

To use this parameter, set for the parameter Input processing value Columns as channels (frame based). In the sampling processing mode, the block does not reset the initial phase value to zero for each new input.

Default value

false (switched off)

Program usage name

ResetInitialPhaseToZeroForEachInputFrame

Tunable

No

Evaluatable

No