summaryrefslogtreecommitdiff
path: root/help/en_US/oct_interp.xml
blob: 48146eaf6e4ecdceaed4b072c8da37f4e9a40198 (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
<?xml version="1.0" encoding="UTF-8"?>

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

<refentry version="5.0-subset Scilab" xml:id="oct_interp" 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>oct_interp</refname>
    <refpurpose>function y = interp(x, q, n, Wc)</refpurpose>
  </refnamediv>


<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   y = interp(x, q)
   y = interp(x, q, n)
   y = interp(x, q, n, Wc)
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>x:</term>
      <listitem><para> scalar or vector of complex or real numbers</para></listitem></varlistentry>
   <varlistentry><term>q:</term>
      <listitem><para> positive integer value, or logical</para></listitem></varlistentry>
   <varlistentry><term>n:</term>
      <listitem><para> positive integer, default value 4</para></listitem></varlistentry>
   <varlistentry><term>Wc:</term>
      <listitem><para> non decreasing vector or scalar, starting from 0 uptill 1, default value 0.5</para></listitem></varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
This is an Octave function.
This function upsamples the signal x by a factor of q, using an order 2*q*n+1 FIR filter.
The second argument q must be an integer. The default values of the third and fourth arguments (n, Wc) are 4 and 0.5 respectively.
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
interp(1,2)
ans  =
0.4792743    0.3626016
   ]]></programlisting>
</refsection>
</refentry>