~ubuntu-branches/ubuntu/trusty/csound-manual/trusty-proposed

« back to all changes in this revision

Viewing changes to opcodes/integ.xml

  • Committer: Bazaar Package Importer
  • Author(s): Felipe Sateler
  • Date: 2011-08-01 22:21:58 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20110801222158-90kslkp5ujci2f5d
Tags: 1:5.13~dfsg-1
* New upstream release
 - Add Menno Knevel to the copyright file
 - Refresh patch 2000-stripped-opcodes.diff
 - Update copyright hints file
* Update Vcs-* headers
* Bump Standards-Version

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
 
2
 
<refentry id="integ">
3
 
<indexterm id="IndexInteg"><primary>integ</primary></indexterm>
4
 
  <refentryinfo><title>Signal Modifiers:Sample Level Operators</title></refentryinfo>
5
 
  <refmeta>
6
 
    <refentrytitle>integ</refentrytitle>
7
 
  </refmeta>
8
 
 
9
 
 
10
 
 
11
 
  <refnamediv>
12
 
    <refname>integ</refname>
13
 
    <refpurpose>
14
 
      Modify a signal by integration.
15
 
          </refpurpose>
16
 
  </refnamediv>
17
 
 
18
 
  <refsect1>
19
 
    <title>Description</title>
20
 
    <para>
21
 
      Modify a signal by integration.
22
 
    </para>
23
 
  </refsect1>
24
 
 
25
 
  <refsect1>
26
 
    <title>Syntax</title>
27
 
    <synopsis>ares <command>integ</command> asig [, iskip]</synopsis>
28
 
 
29
 
    <synopsis>kres <command>integ</command> ksig [, iskip]</synopsis>
30
 
  </refsect1>
31
 
 
32
 
  <refsect1>
33
 
    <title>Initialization</title>
34
 
    <para>
35
 
      <emphasis>iskip</emphasis> (optional) -- initial disposition of internal save space (see <link linkend="reson"><citetitle>reson</citetitle></link>). The default value is 0.
36
 
    </para>
37
 
  </refsect1>
38
 
 
39
 
  <refsect1>
40
 
    <title>Performance</title>
41
 
    <para>
42
 
      <emphasis>integ</emphasis> and <link linkend="diff"><citetitle>diff</citetitle></link> perform integration and differentiation on an input control signal or audio signal. Each is the converse of the other, and applying both will reconstruct the original signal. Since these units are special cases of low-pass and high-pass filters, they produce a scaled (and phase shifted) output that is frequency-dependent. Thus <emphasis>diff</emphasis> of a sine produces a cosine, with amplitude <emphasis>2 * sin(pi * Hz / <emphasis>sr</emphasis>)</emphasis> that of the original (for each component partial); <emphasis>integ</emphasis> will inversely affect the magnitudes of its component inputs. With this understanding, these units can provide useful signal modification.
43
 
    </para>
44
 
  </refsect1>
45
 
 
46
 
  <refsect1>
47
 
    <title>Examples</title>
48
 
    <para>
49
 
      Here is an example of the integ opcode. It uses the file <ulink url="examples/integ.csd"><citetitle>integ.csd</citetitle></ulink>.
50
 
 
51
 
      <example>
52
 
        <title>Example of the integ opcode.</title>
53
 
 
54
 
        
55
 
 
56
 
        <para>See the sections <link linkend="UsingRealTime"><citetitle>Real-time Audio</citetitle></link> and <link linkend="CommandFlags"><citetitle>Command Line Flags</citetitle></link> for more information on using command line flags.</para>
57
 
          <xi:include href="examples-xml/integ.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
58
 
      </example>
59
 
    </para>
60
 
  </refsect1>
61
 
 
62
 
  <refsect1>
63
 
    <title>See Also</title>
64
 
    <para>
65
 
      <link linkend="diff"><citetitle>diff</citetitle></link>,
66
 
      <link linkend="downsamp"><citetitle>downsamp</citetitle></link>,
67
 
      <link linkend="interp"><citetitle>interp</citetitle></link>,
68
 
      <link linkend="samphold"><citetitle>samphold</citetitle></link>,
69
 
      <link linkend="upsamp"><citetitle>upsamp</citetitle></link>
70
 
    </para>
71
 
  </refsect1>
72
 
 
73
 
  <refsect1>
74
 
    <title>Credits</title>
75
 
    <para>Example written by &namekevin;.</para>
76
 
  </refsect1>
77
 
</refentry>
 
1
 
 
2
<refentry id="integ">
 
3
<indexterm id="IndexInteg"><primary>integ</primary></indexterm>
 
4
  <refentryinfo><title>Signal Modifiers:Sample Level Operators</title></refentryinfo>
 
5
  <refmeta>
 
6
    <refentrytitle>integ</refentrytitle>
 
7
  </refmeta>
 
8
 
 
9
  <refnamediv>
 
10
    <refname>integ</refname>
 
11
    <refpurpose>
 
12
      Modify a signal by integration.
 
13
    </refpurpose>
 
14
  </refnamediv>
 
15
 
 
16
  <refsect1>
 
17
    <title>Description</title>
 
18
    <para>
 
19
      Modify a signal by integration.
 
20
    </para>
 
21
  </refsect1>
 
22
 
 
23
  <refsect1>
 
24
    <title>Syntax</title>
 
25
    <synopsis>ares <command>integ</command> asig [, iskip]</synopsis>
 
26
 
 
27
    <synopsis>kres <command>integ</command> ksig [, iskip]</synopsis>
 
28
  </refsect1>
 
29
 
 
30
  <refsect1>
 
31
    <title>Initialization</title>
 
32
    <para>
 
33
      <emphasis>iskip</emphasis> (optional) -- initial disposition of internal save space (see <link linkend="reson"><citetitle>reson</citetitle></link>). The default value is 0.
 
34
    </para>
 
35
  </refsect1>
 
36
 
 
37
  <refsect1>
 
38
    <title>Performance</title>
 
39
    <para>
 
40
      <emphasis>integ</emphasis> and <link linkend="diff"><citetitle>diff</citetitle></link> perform integration and differentiation on an input control signal or audio signal. Each is the converse of the other, and applying both will reconstruct the original signal. Since these units are special cases of low-pass and high-pass filters, they produce a scaled (and phase shifted) output that is frequency-dependent. Thus <emphasis>diff</emphasis> of a sine produces a cosine, with amplitude 2 * <emphasis>pi</emphasis> * Hz / <emphasis>sr</emphasis> that of the original (for each component partial); <emphasis>integ</emphasis> will inversely affect the magnitudes of its component inputs. With this understanding, these units can provide useful signal modification.
 
41
    </para>
 
42
  </refsect1>
 
43
 
 
44
  <refsect1>
 
45
    <title>Examples</title>
 
46
    <para>
 
47
      Here is an example of the integ opcode. It uses the file <ulink url="examples/integ.csd"><citetitle>integ.csd</citetitle></ulink>.
 
48
      <example>
 
49
        <title>Example of the integ opcode.</title>
 
50
        <para>See the sections <link linkend="UsingRealTime"><citetitle>Real-time Audio</citetitle></link> and <link linkend="CommandFlags"><citetitle>Command Line Flags</citetitle></link> for more information on using command line flags.</para>
 
51
          <xi:include href="examples-xml/integ.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 
52
      </example>
 
53
    </para>
 
54
  </refsect1>
 
55
 
 
56
  <refsect1>
 
57
    <title>See Also</title>
 
58
    <para>
 
59
      <link linkend="diff"><citetitle>diff</citetitle></link>,
 
60
      <link linkend="downsamp"><citetitle>downsamp</citetitle></link>,
 
61
      <link linkend="interp"><citetitle>interp</citetitle></link>,
 
62
      <link linkend="samphold"><citetitle>samphold</citetitle></link>,
 
63
      <link linkend="upsamp"><citetitle>upsamp</citetitle></link>
 
64
    </para>
 
65
  </refsect1>
 
66
</refentry>