summaryrefslogtreecommitdiff
path: root/help/en_US/scilab_en_US_help/octave_functions.html
blob: 345acc240c749a87fd727ab83fd905a12587442e (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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
<html><head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <title>octave_functions</title>
    <style type="text/css" media="all">
      @import url("scilab_code.css");
      @import url("xml_code.css");
      @import url("c_code.css");
      @import url("style.css");
    </style>
  </head>
  <body>
    <div class="manualnavbar">
    <table width="100%"><tr>
      <td width="30%">
    	<span class="previous"><a href="lteZadoffChuSeq.html">&lt;&lt; lteZadoffChuSeq</a></span>

      </td>
      <td width="40%" class="center">
      	<span class="top"><a href="section_1f049b1e3111e3d1d538e7603f77f589.html">FOSSEE_Communication_Systems_Toolbox</a></span>

      </td>
      <td width="30%" class="next">
      	<span class="next"><a href="ssbdemod.html">ssbdemod &gt;&gt;</a></span>

      </td>
    </tr></table>
      <hr />
    </div>



    <span class="path" dir="ltr"><a href="index.html">FOSSEE_Communication_Systems_Toolbox</a> &gt;&gt; <a href="section_1f049b1e3111e3d1d538e7603f77f589.html">FOSSEE_Communication_Systems_Toolbox</a> &gt; octave_functions</span>

    <br /><br />
    <div class="refnamediv"><h1 class="refname">octave_functions</h1>
    <p class="refpurpose">Call functions available in communications (and any other) package of Octave. The actual function call is &#0034;octave_fun&#0034; and is available as a part of &#0034;FOSSEE-Scilab-Octave-Toolbox&#0034;</p></div>


<div class="refsynopsisdiv"><h3 class="title">Syntax</h3>
   <div class="synopsis"><pre><span class="default">[</span><span class="default">y1</span><span class="default">, </span><span class="default">y2</span><span class="default">, ...] = </span><span class="default">octave_fun</span><span class="default">(</span>&#0034;<span class="default">octave_function</span>&#0034;<span class="default">,</span><span class="default">input1</span><span class="default">,</span><span class="default">input2</span><span class="default">,...)</span>
<span class="default">[</span><span class="default">y1</span><span class="default">, </span><span class="default">y2</span><span class="default">, ...] = </span><span class="default">octave_fun</span><span class="default">(</span>&#0034;<span class="default">octave_function</span>&#0034;<span class="default">,</span><span class="default">input1</span><span class="default">,</span><span class="default">input2</span><span class="default">,...,</span><span class="default">optional_input1</span><span class="default">,</span><span class="default">optional_input2</span><span class="default">,...)</span>
<span class="default">[</span><span class="default">y1</span><span class="default">, </span><span class="default">y2</span><span class="default">, ...] = </span><span class="default">octave_fun</span><span class="default">(</span>&#0034;<span class="default">octave_function</span>&#0034;<span class="default">,</span>&#0034;<span class="default">octave_package</span>&#0034;<span class="default">,</span><span class="default">input1</span><span class="default">,</span><span class="default">input2</span><span class="default">,...)</span>
<span class="default">[</span><span class="default">y1</span><span class="default">, </span><span class="default">y2</span><span class="default">, ...] = </span><span class="default">octave_fun</span><span class="default">(</span>&#0034;<span class="default">octave_function</span>&#0034;<span class="default">,</span>&#0034;<span class="default">octave_package</span>&#0034;<span class="default">,</span><span class="default">input1</span><span class="default">,</span><span class="default">input2</span><span class="default">,...,</span><span class="default">optional_input1</span><span class="default">,</span><span class="default">optional_input2</span><span class="default">,...)</span></pre></div></div>

<div class="refsection"><h3 class="title">Parameters</h3>
   <dl><dt><span class="term">y :</span>
            <dd><p class="para">ouput as returned by octave. It can be a vector or matrix of doubles</p></dd></dt>
        <dt><span class="term">octave_function :</span>
            <dd><p class="para">name of the function in octave that has to be called. It has to be a string in double quotes</p></dd></dt>
        <dt><span class="term">input :</span>
            <dd><p class="para">input as expected by the octave function. It can be a vector or matrix of doubles</p></dd></dt>
        <dt><span class="term">optional_input :</span>
            <dd><p class="para">an optional argument that the given octave function can accept. It has to be a string in double quotes</p></dd></dt>
        <dt><span class="term">octave_package :</span>
            <dd><p class="para">name of the package in octave that has to be loaded as required by the octave function. It has to be a string in double quotes</p></dd></dt></dl></div>

<div class="refsection"><h3 class="title">Description</h3>
   <p class="para">This function accepts an octave function name with the relevant inputs and returns the output as generated. It requires Octave to be installed along with necessary packages.</p>
   <p class="para"></p>
   <p class="para"></p></div>

<div class="refsection"><h3 class="title">Examples</h3>
   <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabcomment">// Reshape a given array using octave and its </span><span class="scilabcomment">&#0034;</span><span class="scilabcomment">communications</span><span class="scilabcomment">&#0034;</span><span class="scilabcomment"> package.</span>
<span class="scilabcomment">// See help in octave for more information about </span><span class="scilabcomment">&#0034;</span><span class="scilabcomment">reshape</span><span class="scilabcomment">&#0034;</span><span class="scilabcomment"> function.</span>
<span class="scilabcomment">// Note that this example requires the </span><span class="scilabcomment">&#0034;</span><span class="scilabcomment">communications</span><span class="scilabcomment">&#0034;</span><span class="scilabcomment"> package to be installed in octave and the </span><span class="scilabcomment">&#0034;</span><span class="scilabcomment">FOSSEE-Scilab-Octave-Toolbox</span><span class="scilabcomment">&#0034;</span><span class="scilabcomment"> loaded in scilab.</span>
<span class="scilabid">x</span> <span class="scilaboperator">=</span> <span class="scilabopenclose">[</span><span class="scilabnumber">1</span><span class="scilabdefault">,</span> <span class="scilabnumber">2</span><span class="scilabdefault">,</span> <span class="scilabnumber">3</span><span class="scilabdefault">,</span> <span class="scilabnumber">4</span><span class="scilabopenclose">]</span><span class="scilabdefault">;</span>
<span class="scilabid">dim1</span> <span class="scilaboperator">=</span> <span class="scilabnumber">2</span><span class="scilabdefault">;</span>
<span class="scilabid">dim2</span> <span class="scilaboperator">=</span> <span class="scilabnumber">2</span><span class="scilabdefault">;</span>
<span class="scilabid">output</span> <span class="scilaboperator">=</span> <span class="scilabid">octave_fun</span><span class="scilabopenclose">(</span><span class="scilabstring">&#0034;</span><span class="scilabstring">reshape</span><span class="scilabstring">&#0034;</span><span class="scilabdefault">,</span> <span class="scilabstring">&#0034;</span><span class="scilabstring">communications</span><span class="scilabstring">&#0034;</span><span class="scilabdefault">,</span> <span class="scilabid">x</span><span class="scilabdefault">,</span> <span class="scilabid">dim1</span><span class="scilabdefault">,</span> <span class="scilabid">dim2</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div>

<div class="refsection"><h3 class="title">Examples</h3>
   <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabcomment">// Compute the Q function using octave and its </span><span class="scilabcomment">&#0034;</span><span class="scilabcomment">communications</span><span class="scilabcomment">&#0034;</span><span class="scilabcomment"> package.</span>
<span class="scilabcomment">// See help in octave for more information about </span><span class="scilabcomment">&#0034;</span><span class="scilabcomment">qfunc</span><span class="scilabcomment">&#0034;</span><span class="scilabcomment"> function.</span>
<span class="scilabcomment">// Note that this example requires the </span><span class="scilabcomment">&#0034;</span><span class="scilabcomment">communications</span><span class="scilabcomment">&#0034;</span><span class="scilabcomment"> package to be installed in octave and the </span><span class="scilabcomment">&#0034;</span><span class="scilabcomment">FOSSEE-Scilab-Octave-Toolbox</span><span class="scilabcomment">&#0034;</span><span class="scilabcomment"> loaded in scilab.</span>
<span class="scilabid">M</span> <span class="scilaboperator">=</span> <span class="scilabopenclose">[</span><span class="scilabnumber">1</span><span class="scilabdefault">,</span> <span class="scilabnumber">2</span><span class="scilabdefault">;</span> <span class="scilabnumber">3</span><span class="scilabdefault">,</span> <span class="scilabnumber">4</span><span class="scilabopenclose">]</span><span class="scilabdefault">;</span>
<span class="scilabid">output</span> <span class="scilaboperator">=</span> <span class="scilabid">octave_fun</span><span class="scilabopenclose">(</span><span class="scilabstring">&#0034;</span><span class="scilabstring">qfunc</span><span class="scilabstring">&#0034;</span><span class="scilabdefault">,</span> <span class="scilabstring">&#0034;</span><span class="scilabstring">communications</span><span class="scilabstring">&#0034;</span><span class="scilabdefault">,</span> <span class="scilabid">M</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div>

<div class="refsection"><h3 class="title">Authors</h3>
   <ul class="itemizedlist"><li class="member">Rupak Rokade</li></ul></div>
    <br />

    <div class="manualnavbar">
    <table width="100%">
    <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr>
<tr>
      <td width="30%">
    	<span class="previous"><a href="lteZadoffChuSeq.html">&lt;&lt; lteZadoffChuSeq</a></span>

      </td>
      <td width="40%" class="center">
      	<span class="top"><a href="section_1f049b1e3111e3d1d538e7603f77f589.html">FOSSEE_Communication_Systems_Toolbox</a></span>

      </td>
      <td width="30%" class="next">
      	<span class="next"><a href="ssbdemod.html">ssbdemod &gt;&gt;</a></span>

      </td>
    </tr></table>
      <hr />
    </div>
  </body>
</html>