summaryrefslogtreecommitdiff
path: root/modules/sound/help/en_US/analyze.xml
blob: a847e50e247fa41aec1142df84ad8cbf82043c89 (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
<?xml version="1.0" encoding="UTF-8"?>
<!--
    * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
    * Copyright (C) ????-2006 - INRIA - Scilab 
    * 
    * This file must be used under the terms of the CeCILL.
    * This source file is licensed as described in the file COPYING, which
    * you should have received as part of this distribution.  The terms
    * are also available at    
    * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
    *
 -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="analyze">
    <refnamediv>
        <refname>analyze</refname>
        <refpurpose>frequency plot of a sound signal</refpurpose>
    </refnamediv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>fmin,fmax,rate,points</term>
                <listitem>
                    <para>scalars. default values fmin=100,fmax=1500,rate=22050,points=8192;</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            Make a frequency plot of the signal <literal>w</literal> with sampling rate <literal>rate</literal>.
            The data must be at least <literal>points</literal> long.
            The maximal frequency plotted will be <literal>fmax</literal>, the minimal <literal>fmin</literal>.
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[ 
// At first we create 0.5 seconds of sound parameters.
t=soundsec(0.5);

// Then we generate the sound.
s=sin(440*t)+sin(220*t)/2+sin(880*t)/2;
[nr,nc]=size(t);
s(nc/2:nc)=sin(330*t(nc/2:nc));
analyze(s);
 ]]></programlisting>
        <scilab:image>
            t=soundsec(0.5);
            s=sin(440*t)+sin(220*t)/2+sin(880*t)/2;
            [nr,nc]=size(t);
            s(nc/2:nc)=sin(330*t(nc/2:nc));
            analyze(s);
        </scilab:image>
    </refsection>
</refentry>