summaryrefslogtreecommitdiff
path: root/help/en_US/unwrap2.xml
diff options
context:
space:
mode:
Diffstat (limited to 'help/en_US/unwrap2.xml')
-rw-r--r--help/en_US/unwrap2.xml60
1 files changed, 60 insertions, 0 deletions
diff --git a/help/en_US/unwrap2.xml b/help/en_US/unwrap2.xml
new file mode 100644
index 0000000..31523de
--- /dev/null
+++ b/help/en_US/unwrap2.xml
@@ -0,0 +1,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>