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
3838 1 . [ PSD] ( docs/plots.md#41-psd )
3939 1 . [ Parameters] ( docs/plots.md#411-parameters )
4040 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 )
42485 . [ Timeseries] ( docs/timeseries.md )
4349 1 . [ Initialize timeseries object] ( docs/timeseries.md#51-initialize-the-timeseries-object )
4450 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()
6363## 4.2 Waterfall
6464The ` plot.waterfall.Waterfall ` class can be used to generate waterfall plots.
6565
66- ### 4.1 .1 Construction
66+ ### 4.2 .1 Construction
6767
6868| Parameter | Description |
6969| --- | --- |
@@ -73,7 +73,7 @@ The `plot.waterfall.Waterfall` class can be used to generate waterfall plots.
7373| fig | An imaging object, like ` pyplot.figure() ` |
7474| mode | String ` {discrete, stream} ` . The mode to operate on. Use discrete for discrete datasets, and stream for stream data. Defaults to ` stream ` . |
7575
76- ### 4.1 .2 Methods
76+ ### 4.2 .2 Methods
7777| Method | Description | Parameters |
7878| --- | --- |
7979| init_plot(self) | Initialize the plot |
@@ -84,8 +84,8 @@ The `plot.waterfall.Waterfall` class can be used to generate waterfall plots.
8484| animated_plotter(self) | Returns the figure and update function for matplotlib animation |
8585| get_center_freq(self) | Returns the center frequency stored in the filterbank header |
8686
87- ### 4.1 .3 Example Usage
88- #### With discrete data
87+ ### 4.2 .3 Example Usage
88+ #### 4.2.3.1 With discrete data
8989``` python
9090import matplotlib.animation as animation
9191from filterbank.header import read_header
@@ -103,7 +103,7 @@ img = wf.get_image()
103103pyl.show(img)
104104```
105105
106- #### With stream data
106+ #### 4.2.3.2 With stream data
107107``` python
108108import matplotlib.animation as animation
109109from filterbank.header import read_header
You can’t perform that action at this time.
0 commit comments