summaryrefslogtreecommitdiff
path: root/opcodes/trlowest.xml
diff options
context:
space:
mode:
Diffstat (limited to 'opcodes/trlowest.xml')
-rw-r--r--opcodes/trlowest.xml61
1 files changed, 23 insertions, 38 deletions
diff --git a/opcodes/trlowest.xml b/opcodes/trlowest.xml
index 17af346..ee3ef29 100644
--- a/opcodes/trlowest.xml
+++ b/opcodes/trlowest.xml
@@ -7,79 +7,65 @@
<refentrytitle>trlowest</refentrytitle>
</refmeta>
-
-
<refnamediv>
<refname>trlowest</refname>
<refpurpose>
- Extracts the lowest-frequency track from a streaming track input signal.
-
+ Extracts the lowest-frequency track from a streaming track input signal.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
- The trlowest opcode takes an input containg TRACKS pv streaming signals (as generated,
- for instance by partials) and outputs only the lowest track. In addition it outputs
- two k-rate signals, corresponding to the frequency and amplitude of the lowest track
- signal.
- </para>
+ The <emphasis>trlowest</emphasis> opcode takes an input containg TRACKS pv streaming signals (as generated,
+ for instance by <emphasis>partials</emphasis>) and outputs only the lowest track. In addition it outputs
+ two k-rate signals, corresponding to the frequency and amplitude of the lowest track
+ signal.
+ </para>
</refsect1>
<refsect1>
<title>Syntax</title>
- <synopsis>fsig, kfr,kamp <command>trlowest</command> fin1, kscal</synopsis>
+ <synopsis>fsig, kfr, kamp <command>trlowest</command> fin1, kscal</synopsis>
</refsect1>
<refsect1>
<title>Performance</title>
- <para>
+ <para>
<emphasis>fsig</emphasis> -- output pv stream in TRACKS format
</para>
-
- <para>
+
+ <para>
<emphasis>kfr</emphasis> -- frequency (in Hz) of the lowest-frequency track
</para>
-
- <para>
+
+ <para>
<emphasis>kamp</emphasis> -- amplitude of the lowest-frequency track
</para>
<para>
-
- <emphasis>fin</emphasis> -- input pv stream in TRACKS format.
+
+ <emphasis>fin</emphasis> -- input pv stream in TRACKS format.
</para>
-
+
<para>
<emphasis>kscal</emphasis> -- amplitude scaling of output.
- </para>
-
+ </para>
</refsect1>
<refsect1>
<title>Examples</title>
<para>
+ Here is an example of the trlowest opcode. It uses the file <ulink url="examples/trlowest.csd"><citetitle>trlowest.csd</citetitle></ulink>.
<example>
- <title>Example</title>
- <programlisting>
-ain inch 1 ; input signal
-fs1,fsi2 pvsifd ain,2048,512,1 ; ifd analysis
-fst partials fs1,fsi2,.003,1,3,500 ; partial tracking
-flow,kfr,kamp trlowest fst,1 ; lowest freq-track
- aout tradsyn flow, 1, 1, 1, 1 ; resynthesis of lowest frequency
-out aout
- </programlisting>
+ <title>Example of the trlowest opcode.</title>
+ <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>
+ <xi:include href="examples-xml/trlowest.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</example>
-
-
</para>
-
<para>
-The example above shows partial tracking of an ifd-analysis signal, extraction of
-the lowest frequency and resynthesis.
-
+ The example above shows partial tracking of an ifd-analysis signal, extraction of
+ the lowest frequency and resynthesis.
</para>
-
</refsect1>
<refsect1>
@@ -90,7 +76,6 @@ the lowest frequency and resynthesis.
<member>February 2006 </member>
</simplelist>
</para>
- <para>New in Csound5.01</para>
-
+ <para>New in Csound 5.01</para>
</refsect1>
</refentry>