summaryrefslogtreecommitdiff
path: root/help/en_US/uencode.xml
blob: b5cede139f887102bb842c34cd1826c1f156daee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
<?xml version="1.0" encoding="UTF-8"?>

<!--
 *
 * This help file was generated from uencode.sci using help_from_sci().
 *
 -->

<refentry version="5.0-subset Scilab" xml:id="uencode" xml:lang="en"
          xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xmlns:svg="http://www.w3.org/2000/svg"
          xmlns:ns3="http://www.w3.org/1999/xhtml"
          xmlns:mml="http://www.w3.org/1998/Math/MathML"
          xmlns:scilab="http://www.scilab.org"
          xmlns:db="http://docbook.org/ns/docbook">

  <refnamediv>
    <refname>uencode</refname>
    <refpurpose>Performs uniform quantization of the input into 2^n levels</refpurpose>
  </refnamediv>


<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   y=uencode(u,n,v,'signflag')
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
Uniformly quantizes the input vector or n-dimensional array u into 2^n levels in the interval [-v,v]
If v is not specified, its default value is 1
'signflag' is a string that determines the nature of the quantization
If signflag='unsigned' then y contains unsigned integers in the range [0,2^n-1] corresponding to the 2^n levels
If signflag='unsigned' then y contains signed integers in the range [-2^(n-1),2^(n-1)-1] corresponding to the 2^n levels
The  size of the integers in y in bits(8,16, or 32) depends on the value of n
If the input lies beyond +/- v it is saturated
Example
y=uencode(-1:0.5:1,3)
y  =
   </para>
   <para>
0  2  4  6  7
Author
Ankur Mallick
References
[1] International Telecommunication Union. General Aspects of Digital Transmission Systems: Vocabulary of Digital Transmission and Multiplexing, and Pulse Code Modulation (PCM) Terms. ITU-T Recommendation G.701. March, 1993.
</para>
</refsection>

<refsection>
   <title>See also</title>
   <simplelist type="inline">
   <member><link linkend="udecode">udecode</link></member>
   <member><link linkend="floor">floor</link></member>
   </simplelist>
</refsection>
</refentry>