# quantencode (MathScript RT Module Function)

LabVIEW 2012 MathScript RT Module Help

Edition Date: June 2012

Part Number: 373123C-01

»View Product Info

Owning Class: filter implementation

Requires: MathScript RT Module

## Syntax

y = quantencode(x, n)

y = quantencode(x, n, r)

y = quantencode(x, n, r, s)

Legacy Name: `uencode`

## Description

Uses quantization to convert floating-point inputs to integer outputs. Quantization transforms real floating-point numbers into integers. You can use quantencode to solve overflow problems.

Details

Examples

## Inputs

Name Description
x Specifies the real or complex numbers to encode. The elements of x must fall in the range [-r, r]. LabVIEW treats the elements outside of this range as overflows and saturates the overflows.
n Specifies the level of quantization. n is a positive integer between 2 and 32. If n is in the range [2, 8], the output data type is int8/uint8. If n is in the range [9, 16], the output data type is int16/uint16. If n is in the range [17, 32], the output data type is int32/uint32.
r Specifies the range of x. r is a positive number. The default is 1.
s Specifies the data type of the outputs. s accepts the following values.

 'signed' Directs LabVIEW to output signed integers with magnitudes in the range [-2^(n-1), 2^(n-1)-1]. 'unsigned' (default) Directs LabVIEW to output unsigned integers with magnitudes in the range [0, 2^n-1].

## Outputs

Name Description
y Returns the quantized integers.

## Details

quantencode does not accept complex inputs. To encode and decode a complex x, use quantencode and quantdecode separately on the real and imaginary parts of x and then combine the results, as shown in the following example.

X = real(input)                        %get the real part of the input
Y = imag(input)                        %get the imaginary part of the input

X = quantencode(X, 4, 1, 'unsigned')   %encode X
Y = quantencode(Y, 4, 1, 'unsigned')   %encode Y

X = quantdecode(X, 4, 1, 'wrap')       %decode X
Y = quantdecode(Y, 4, 1, 'wrap')       %decode Y

output = complex(X, Y)                 %combine the real and imaginary parts

The following table lists the support characteristics of this function.

 Supported in the LabVIEW Run-Time Engine Yes Supported on RT targets Yes Suitable for bounded execution times on RT Not characterized

## Examples

X = -1:0.01:1;
Y = quantencode(X, 4, 1, 'signed');
X1 = quantdecode(Y, 4, 1);
plot(X, X1)