added usage examples to filterbank.md

Author: albertvankiel

docs/filterbank.md

@@ -1,22 +1,49 @@
-# Filterbank Tutorial
+# 2. Filterbank Tutorial
 
-### Create a filterbank object
-> ``` filterbank = Filterbank(<PATH TO FILTERBANK FILE>) ```
+### 2.1 Create a filterbank object
+```
+filterbank = Filterbank(<PATH TO FILTERBANK FILE>)
+```
 
-### Read the header from filterbank data
-> ``` filterbank.header ```
+### 2.2 Read the header from filterbank data
+```
+filterbank.header
+```
 
-### Read filterbank file to 3d numpy array
-> ``` filterbank.read_filterbank ```
+Header data contains the following:
+* source_name 
+* DM
+* machine_id
+* telescope_id
+* data_type
+* fch1
+* foff
+* nchans
+* nbits
+* tstart
+* tsamp
+* nifs
 
-### Calculate the frequency range
-> ``` filterbank.setup_freqs ```
+freq_range = fch1 + nchans  
+time_range = tstart + (tsamp/24/60/60)
 
-### Calculate the time range
-> ``` filterbank.setup_time ```
+freq_range is a tuple with a frequency start and a frequency stop  
+The same applies to time_range
 
-### Calculate the channel range
-> ``` filterbank.setup_chans ```
+### Read filterbank file to 3d numpy array
+```
+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)
+```
 
 ### Select a range of data from the filterbank file
-> ``` filterbank.select_data ```
+```
+filterbank.select_data
+```
+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)
+```

docs/gettingstarted.md

@@ -1,4 +1,4 @@
-# Getting started
+# 1. Getting started
 
 ## Example filterbank files
 ### Use one of the following filterbank files as an example:
@@ -7,4 +7,6 @@
 * <a href="https://git.dev.ti-more.net/uploads/-/system/personal_snippet/2/e6015ec024ad1f53d4c2f39511620db1/pspm32.fil">32 bit</a>
 
 ## Import
-> ```from filterbank.filterbank import *```
+```
+from filterbank.filterbank import *
+```