Skip to content

Commit 721c318

Browse files
committed
Doc updates
1 parent 2bf0021 commit 721c318

File tree

6 files changed

+14
-10
lines changed

6 files changed

+14
-10
lines changed

docs/modules/ROOT/pages/reference/misc/dc_block.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,6 @@ struct dc_block
3737
`sps` :: Floating point value representing samples per second.
3838
`s` :: Input sample.
3939

40-
=== Constructor
41-
4240
=== Constructors and Assignment
4341

4442
[cols="1,1"]
@@ -54,6 +52,8 @@ struct dc_block
5452

5553
NOTE: C++ brace initialization may also be used.
5654

55+
=== Function Call
56+
5757
[cols="1,1,1"]
5858
|===
5959
| Expression | Semantics | Return Type

docs/modules/ROOT/pages/reference/misc/dynamic_smoother.adoc

+2
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@ The `dynamic_smoother` class is based on link:https://cytomic.com/files/dsp/Dyna
6161

6262
NOTE: C++ brace initialization may also be used.
6363

64+
=== Function Call
65+
6466
[cols="1,1,1"]
6567
|===
6668
| Expression | Semantics | Return Type

docs/modules/ROOT/pages/reference/misc/one_pole_lowpass.adoc

+2
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ struct one_pole_lowpass
5050

5151
NOTE: C++ brace initialization may also be used.
5252

53+
=== Function Call
54+
5355
[cols="1,1,1"]
5456
|===
5557
| Expression | Semantics | Return Type

docs/modules/ROOT/pages/reference/misc/onset_gate.adoc

+2
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,5 @@ In addition to valid expressions for `{noise_gate}`, `onset_gate` allows these e
5757

5858
NOTE: C++ brace initialization may also be used.
5959

60+
61+

docs/modules/ROOT/pages/reference/misc/peak.adoc

+4-6
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,9 @@ The result is a bool corresponding to the peaks. Tip: For measuring periods, loo
1212

1313
image::peaks.svg[alt="Peaks", title="Peaks response", width="750px" align=center, link={imagesdir}/peaks.svg]
1414

15-
The blue trace represents the input signal, the green trace represents the peak envelope follower, and the red trace represents the peaks: the output of the peak processor. The peak envelope follower follows the input signal when the signal is rising and decays slowly when the signal is falling. An attenuated version of this envelope serves as the reference input to a xref:reference/misc/schmitt_trigger.adoc[Schmitt Trigger]. The attenuation is controlled by the processor's sensitivity parameter: a positive fraction less than one. Higher values indicate higher sensitivity. The signal is compared to this reference and the output is high when the signal is greater than the envelope, plus or minus some hysteresis.
15+
The blue trace is the input signal, the green trace is the peak envelope follower, and the red trace is the output of the peak processor. The peak envelope follower tracks the input signal when the signal is rising and decays slowly when the signal is falling. An attenuated version of this envelope serves as the reference input to a xref:reference/misc/schmitt_trigger.adoc[Schmitt Trigger]. The attenuation is controlled by the processor's sensitivity parameter: a positive fraction less than one. Higher values indicate higher sensitivity. The signal is compared to this reference and the output is high when the signal is greater than the envelope, plus or minus some hysteresis.
1616

17-
18-
19-
Note that the peak envelope follower is not included in the peak processor. The xref:reference/envelope/peak_envelope_follower.adoc[Peak Envelope Follower] is a separate processor that generates the envelope. The peak envelope follower inherently suppresses low-level positive-going peaks due to its slow decay rate, as illustrated in the graph.
17+
Note that the peak envelope follower is not included in the peak processor. The xref:reference/envelope/peak_envelope_follower.adoc[Peak Envelope Follower] is a separate processor that generates the envelope. The peak envelope follower naturally suppresses low-level positive-going peaks due to its slow decay rate, as illustrated in the graph.
2018

2119
== Include
2220

@@ -47,8 +45,6 @@ Note that the peak envelope follower is not included in the peak processor. The
4745
`s` :: Input sample.
4846
`env` :: The reference envelope.
4947

50-
=== Constructor
51-
5248
=== Constructors and Assignment
5349

5450
[cols="1,1"]
@@ -62,6 +58,8 @@ Note that the peak envelope follower is not included in the peak processor. The
6258

6359
NOTE: C++ brace initialization may also be used.
6460

61+
=== Function Call
62+
6563
[cols="1,1,1"]
6664
|===
6765
| Expression | Semantics | Return Type

docs/modules/ROOT/pages/reference/misc/schmitt_trigger.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,6 @@ struct schmitt_trigger
3636
`s` :: Input sample.
3737
`ref` :: A reference signal.
3838

39-
=== Constructor
40-
4139
=== Constructors and Assignment
4240

4341
[cols="1,1"]
@@ -53,6 +51,8 @@ struct schmitt_trigger
5351

5452
NOTE: C++ brace initialization may also be used.
5553

54+
=== Function Call
55+
5656
[cols="1,1,1"]
5757
|===
5858
| Expression | Semantics | Return Type

0 commit comments

Comments
 (0)