File tree Expand file tree Collapse file tree 2 files changed +12
-6
lines changed Expand file tree Collapse file tree 2 files changed +12
-6
lines changed Original file line number Diff line number Diff line change @@ -38,7 +38,13 @@ Creating a free and open source framework that contains the generic algorithms a
38
38
1 . [ PSD] ( docs/plots.md#41-psd )
39
39
1 . [ Parameters] ( docs/plots.md#411-parameters )
40
40
2 . [ Returns] ( docs/plots.md#412-returns )
41
- 1 . [ Example usage] ( docs/plots.md#413-example-usage )
41
+ 3 . [ Example usage] ( docs/plots.md#413-example-usage )
42
+ 2 . [ Waterfall] ( docs/plots.md#41-psd )
43
+ 1 . [ Construction] ( docs/plots.md#421-parameters )
44
+ 2 . [ Methods] ( docs/plots.md#422-returns )
45
+ 3 . [ Example usage] ( docs/plots.md#423-example-usage )
46
+ 1 . [ Example usage] ( docs/plots.md#4231-with-discrete-data )
47
+ 2 . [ Example usage] ( docs/plots.md#4232-with-stream-data )
42
48
5 . [ Timeseries] ( docs/timeseries.md )
43
49
1 . [ Initialize timeseries object] ( docs/timeseries.md#51-initialize-the-timeseries-object )
44
50
2 . [ Retrieve timeseries] ( docs/timeseries.md#521-retrieve-timeseries-object )
Original file line number Diff line number Diff line change @@ -63,7 +63,7 @@ plt.show()
63
63
## 4.2 Waterfall
64
64
The ` plot.waterfall.Waterfall ` class can be used to generate waterfall plots.
65
65
66
- ### 4.1 .1 Construction
66
+ ### 4.2 .1 Construction
67
67
68
68
| Parameter | Description |
69
69
| --- | --- |
@@ -73,7 +73,7 @@ The `plot.waterfall.Waterfall` class can be used to generate waterfall plots.
73
73
| fig | An imaging object, like ` pyplot.figure() ` |
74
74
| mode | String ` {discrete, stream} ` . The mode to operate on. Use discrete for discrete datasets, and stream for stream data. Defaults to ` stream ` . |
75
75
76
- ### 4.1 .2 Methods
76
+ ### 4.2 .2 Methods
77
77
| Method | Description | Parameters |
78
78
| --- | --- |
79
79
| init_plot(self) | Initialize the plot |
@@ -84,8 +84,8 @@ The `plot.waterfall.Waterfall` class can be used to generate waterfall plots.
84
84
| animated_plotter(self) | Returns the figure and update function for matplotlib animation |
85
85
| get_center_freq(self) | Returns the center frequency stored in the filterbank header |
86
86
87
- ### 4.1 .3 Example Usage
88
- #### With discrete data
87
+ ### 4.2 .3 Example Usage
88
+ #### 4.2.3.1 With discrete data
89
89
``` python
90
90
import matplotlib.animation as animation
91
91
from filterbank.header import read_header
@@ -103,7 +103,7 @@ img = wf.get_image()
103
103
pyl.show(img)
104
104
```
105
105
106
- #### With stream data
106
+ #### 4.2.3.2 With stream data
107
107
``` python
108
108
import matplotlib.animation as animation
109
109
from filterbank.header import read_header
You can’t perform that action at this time.
0 commit comments