← Back to branch summary

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

« back to all changes in this revision

Viewing changes to opcodes/wgbowedbar.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:
opcodes/wgbowedbar.xml
1
 
 
2
 
<refentry id="wgbowedbar">
3
 
<indexterm id="IndexWgbowedbar"><primary>wgbowedbar</primary></indexterm>
4
 
  <refentryinfo><title>Signal Generators:Waveguide Physical Modeling</title></refentryinfo>
5
 
  <refmeta>
6
 
    <refentrytitle>wgbowedbar</refentrytitle>
7
 
  </refmeta>
8
 
 
9
 
 
10
 
 
11
 
  <refnamediv>
12
 
    <refname>wgbowedbar</refname>
13
 
    <refpurpose>
14
 
      A physical model of a bowed bar.
15
 
          </refpurpose>
16
 
  </refnamediv>
17
 
 
18
 
  <refsect1>
19
 
    <title>Description</title>
20
 
    <para>
21
 
      A physical model of a bowed bar, belonging to the &nameperry; family of waveguide instruments.
22
 
    </para>
23
 
  </refsect1>
24
 
 
25
 
  <refsect1>
26
 
    <title>Syntax</title>
27
 
    <synopsis>ares <command>wgbowedbar</command> kamp, kfreq, kpos, kbowpres, kgain [, iconst] [, itvel] \
28
 
      [, ibowpos] [, ilow]</synopsis>
29
 
  </refsect1>
30
 
 
31
 
  <refsect1>
32
 
    <title>Initialization</title>
33
 
    <para>
34
 
      <emphasis>iconst</emphasis> (optional, default=0) -- an integration constant. Default is zero.
35
 
    </para>
36
 
 
37
 
    <para>
38
 
      <emphasis>itvel</emphasis> (optional, default=0) -- either 0 or 1. When <emphasis>ktvel</emphasis> = 0, the bow velocity follows an ADSR style trajectory. When <emphasis>ktvel</emphasis> = 1, the value of the bow velocity decays in an exponentially.
39
 
    </para>
40
 
 
41
 
    <para>
42
 
      <emphasis>ibowpos</emphasis> (optional, default=0) -- the position on the bow, which affects the bow velocity trajectory.
43
 
    </para>
44
 
 
45
 
    <para>
46
 
      <emphasis>ilow</emphasis> (optional, default=0) -- lowest frequency required
47
 
    </para>
48
 
  </refsect1>
49
 
 
50
 
  <refsect1>
51
 
    <title>Performance</title>
52
 
    <para>
53
 
      <emphasis>kamp</emphasis> -- amplitude of signal
54
 
    </para>
55
 
 
56
 
    <para>
57
 
      <emphasis>kfreq</emphasis> -- frequency of signal
58
 
    </para>
59
 
 
60
 
    <para>
61
 
      <emphasis>kpos</emphasis> -- position of the bow on the bar, in the range 0 to 1
62
 
    </para>
63
 
 
64
 
    <para>
65
 
      <emphasis>kbowpres</emphasis> -- pressure of the bow (as in <emphasis>wgbowed</emphasis>)
66
 
    </para>
67
 
 
68
 
    <para>
69
 
      <emphasis>kgain</emphasis> -- gain of filter. A value of about 0.809 is suggested.
70
 
    </para>
71
 
  </refsect1>
72
 
 
73
 
  <refsect1>
74
 
    <title>Examples</title>
75
 
    <para>
76
 
      Here is an example of the wgbowedbar opcode. It uses the file <ulink url="examples/wgbowedbar.csd"><citetitle>wgbowedbar.csd</citetitle></ulink>.
77
 
 
78
 
      <example>
79
 
        <title>Example of the wgbowedbar opcode.</title>
80
 
 
81
 
        
82
 
 
83
 
        <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>
84
 
          <xi:include href="examples-xml/wgbowedbar.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
85
 
      </example>
86
 
    </para>
87
 
  </refsect1>
88
 
 
89
 
  <refsect1>
90
 
    <title>Credits</title>
91
 
    <para>
92
 
      <simplelist>
93
 
        <member>Author: &namejohn; (after &nameperry;)</member>
94
 
        <member>University of Bath, Codemist Ltd.</member>
95
 
        <member>Bath, UK</member>
96
 
      </simplelist>
97
 
    </para>
98
 
 
99
 
    <para>New in Csound version 4.07</para>
100
 
  </refsect1>
101
 
</refentry>
 
1
 
 
2
<refentry id="wgbowedbar">
 
3
<indexterm id="IndexWgbowedbar"><primary>wgbowedbar</primary></indexterm>
 
4
  <refentryinfo><title>Signal Generators:Waveguide Physical Modeling</title></refentryinfo>
 
5
  <refmeta>
 
6
    <refentrytitle>wgbowedbar</refentrytitle>
 
7
  </refmeta>
 
8
 
 
9
  <refnamediv>
 
10
    <refname>wgbowedbar</refname>
 
11
    <refpurpose>
 
12
      A physical model of a bowed bar.
 
13
    </refpurpose>
 
14
  </refnamediv>
 
15
 
 
16
  <refsect1>
 
17
    <title>Description</title>
 
18
    <para>
 
19
      A physical model of a bowed bar, belonging to the &nameperry; family of waveguide instruments.
 
20
    </para>
 
21
  </refsect1>
 
22
 
 
23
  <refsect1>
 
24
    <title>Syntax</title>
 
25
    <synopsis>ares <command>wgbowedbar</command> kamp, kfreq, kpos, kbowpres, kgain [, iconst] [, itvel] \
 
26
      [, ibowpos] [, ilow]</synopsis>
 
27
  </refsect1>
 
28
 
 
29
  <refsect1>
 
30
    <title>Initialization</title>
 
31
    <para>
 
32
      <emphasis>iconst</emphasis> (optional, default=0) -- an integration constant. Default is zero.
 
33
    </para>
 
34
 
 
35
    <para>
 
36
      <emphasis>itvel</emphasis> (optional, default=0) -- either 0 or 1. When <emphasis>itvel</emphasis> = 0, the bow velocity follows an ADSR style trajectory. When <emphasis>itvel</emphasis> = 1, the value of the bow velocity decays in an exponentially.
 
37
    </para>
 
38
 
 
39
    <para>
 
40
      <emphasis>ibowpos</emphasis> (optional, default=0) -- the position on the bow, which affects the bow velocity trajectory.
 
41
    </para>
 
42
 
 
43
    <para>
 
44
      <emphasis>ilow</emphasis> (optional, default=0) -- lowest frequency required
 
45
    </para>
 
46
  </refsect1>
 
47
 
 
48
  <refsect1>
 
49
    <title>Performance</title>
 
50
    <para>
 
51
      <emphasis>kamp</emphasis> -- amplitude of signal
 
52
    </para>
 
53
 
 
54
    <para>
 
55
      <emphasis>kfreq</emphasis> -- frequency of signal
 
56
    </para>
 
57
 
 
58
    <para>
 
59
      <emphasis>kpos</emphasis> -- position of the bow on the bar, in the range 0 to 1
 
60
    </para>
 
61
 
 
62
    <para>
 
63
      <emphasis>kbowpres</emphasis> -- pressure of the bow (as in <emphasis>wgbowed</emphasis>)
 
64
    </para>
 
65
 
 
66
    <para>
 
67
      <emphasis>kgain</emphasis> -- gain of filter. A value of about 0.809 is suggested.
 
68
    </para>
 
69
  </refsect1>
 
70
 
 
71
  <refsect1>
 
72
    <title>Examples</title>
 
73
    <para>
 
74
      Here is an example of the wgbowedbar opcode. It uses the file <ulink url="examples/wgbowedbar.csd"><citetitle>wgbowedbar.csd</citetitle></ulink>.
 
75
 
 
76
      <example>
 
77
        <title>Example of the wgbowedbar opcode.</title>
 
78
 
 
79
        
 
80
 
 
81
        <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>
 
82
          <xi:include href="examples-xml/wgbowedbar.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
 
83
      </example>
 
84
    </para>
 
85
  </refsect1>
 
86
 
 
87
  <refsect1>
 
88
    <title>Credits</title>
 
89
    <para>
 
90
      <simplelist>
 
91
        <member>Author: &namejohn; (after &nameperry;)</member>
 
92
        <member>University of Bath, Codemist Ltd.</member>
 
93
        <member>Bath, UK</member>
 
94
      </simplelist>
 
95
    </para>
 
96
 
 
97
    <para>New in Csound version 4.07</para>
 
98
  </refsect1>
 
99
</refentry>