blob: 31523decf886ea214a179ab58dc7a33b526b8b22 (
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
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
*
* This help file was generated from unwrap2.sci using help_from_sci().
*
-->
<refentry version="5.0-subset Scilab" xml:id="unwrap2" 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>unwrap2</refname>
<refpurpose>Unwrap radian phases by adding or subtracting multiples of 2*pi.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>
B = unwrap(X)
B = unwrap(X, TOL)
B = unwrap(X, TOL, DIM)
</synopsis>
</refsynopsisdiv>
<refsection>
<title>Parameters</title>
<variablelist>
</variablelist>
</refsection>
<refsection>
<title>Description</title>
<para>
This function unwraps radian phases by adding or subtracting multiples of 2*pi as appropriate to remove jumps greater than TOL.
</para>
<para>
TOL defaults to pi.
</para>
<para>
Unwrap will work along the dimension DIM. If DIM is unspecified it defaults to the first non-singleton dimension.
</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
unwrap2([1,2,3])
ans =
1. 2. 3.
]]></programlisting>
</refsection>
</refentry>
|
