updated table of contents, expanded filterbank.md

Author: albertvankiel

README.md

@@ -14,4 +14,10 @@ Creating a free and open source framework that contains the generic algorithms a
 
 # Table of contents
 1. [Getting started](docs/gettingstarted.md)
+    1. [Example filterbank files](docs/gettingstarted.md#11-example-filterbank-files)
+    2. [Import](docs/gettingstarted.md#12-import)
 2. [Filterbank tutorial](docs/filterbank.md)
+    1. [Create filterbank object](docs/filterbank.md#21-create-filterbank-object)
+    2. [Read header from filterbank data](docs/filterbank.md#22-read-header-from-filterbank-data)
+    3. [Read filterbank file to 3d numpy array](docs/filterbank.md#23-read-filterbank-file-to-3d-numpy-array)
+    4. [Select a range of data from the filterbank file](docs/filterbank.md#24-select-a-range-of-data-from-the-filterbank-file)

docs/filterbank.md

@@ -4,13 +4,14 @@
 ```
 filterbank = Filterbank(<PATH TO FILTERBANK FILE>)
 ```
-
+This is an example without parameters, see 2.3 for an example with the parameters.
 ### 2.2 Read the header from filterbank data
 ```
 filterbank.header
 ```
 
 Header data contains the following:
+```
 * source_name 
 * DM
 * machine_id
@@ -23,27 +24,21 @@ Header data contains the following:
 * tstart
 * tsamp
 * nifs
-
+```
 freq_range = fch1 + nchans  
 time_range = tstart + (tsamp/24/60/60)
 
 freq_range is a tuple with a frequency start and a frequency stop  
 The same applies to time_range
 
-### Read filterbank file to 3d numpy array
+### 2.3 Read filterbank file to 3d numpy array
+The attributes time_range and freq_range can be passed as parameters to select a specific portion of the filterbank file, for example:  
 ```
-filterbank.read_filterbank 
-```
-time_range and freq_range can be passed as parameters to select a specific portion of the data, for example:  
-```
-filterbank.read_filterbank(freq_range, time_range)
+filterbank = Filterbank(<PATH TO FILTERBANK FILE>, freq_range, time_range)
 ```
 
-### Select a range of data from the filterbank file
-```
-filterbank.select_data
-```
-time_range and freq_range can be passed as parameters to select a specific portion of the data, for example:  
+### 2.4 Select a range of data from the filterbank file
+The select_data method can be used to select a subset from the data read by the read_filterbank method.
 ```
-filterbank.read_filterbank(freq_range, time_range)
+filterbank.select_data(freq_range, time_range)
 ```

docs/gettingstarted.md

@@ -1,12 +1,12 @@
 # 1. Getting started
 
-## Example filterbank files
+## 1.1 Example filterbank files
 ### Use one of the following filterbank files as an example:
 * <a href="https://git.dev.ti-more.net/uploads/-/system/personal_snippet/2/bc063035797e978034adfb6f2da75e70/pspm8.fil">8 bit</a>
 * <a href="https://git.dev.ti-more.net/uploads/-/system/personal_snippet/2/3da35656df8f722441579847974a03cb/pspm16.fil">16 bit</a>
 * <a href="https://git.dev.ti-more.net/uploads/-/system/personal_snippet/2/e6015ec024ad1f53d4c2f39511620db1/pspm32.fil">32 bit</a>
 
-## Import
+## 1.2 Import
 ```
 from filterbank.filterbank import *
 ```