Commit c30ba177 authored by Gregor Moenke's avatar Gregor Moenke

Update README.md

parent 7f8389b6
......@@ -83,10 +83,12 @@ into the command line.
For running directly from the source, see also [this document](./doc/gui_from_source.md)
### Usage ###
## Usage ##
-------------
#### Data import ####
Almost every input field and checkbox has a tool tip attached for quick reference.
### Data import ###
In general pyBOAT expects tabular data, with each column
representing a signal. Just open your saved time-series data by using ``` Open ```
......@@ -99,7 +101,7 @@ Please see examples of the supported formats in the
In case you want to interpolate missing data or you want to define your own
separator, the ```Import..``` button will spawn a menu with further options.
#### Analysis ####
### Analysis ###
After successful import, you can simply click on the table representing
your data to select a specific time-series in the ``` DataViewer ```.
......@@ -110,7 +112,7 @@ The general layout of the ```DataViewer``` to set up the analysis is shown here:
<img src="./doc/DataViewer.png" alt="drawing" width="800"/>
##### Detrending #####
#### Detrending ####
The featured sinc-detrending is an optimal high-pass filter and removes low frequencies (high periods)
......@@ -120,7 +122,7 @@ Check the ``` Trend ``` and/or ``` Detrended Signal ``` checkbox(es)
and click ``` Refresh Plot ```
to see the effect of the filter on the selected time series.
##### Amplitude Envelope #####
#### Amplitude Envelope ####
If there is a strong trend in the amplitudes alone, for example a slow decay, pyBOAT offers
a simple sliding-window operation to estimate this envelope. The ```Window Size```
......@@ -130,7 +132,7 @@ to see the detected envelope. When running the
Wavelet analysis, there is an option ```Normalize with Envelope``` to remove it
from the signal.
##### Set up Wavelet Analysis #####
#### Setting up the Wavelet Analysis ####
Set the parameters for the Wavelet Analysis in the lower right:
......@@ -144,7 +146,7 @@ Set the parameters for the Wavelet Analysis in the lower right:
Leave the ``` Use the detrended signal ``` box checked if you want to use the sinc-detrending.
``` Analyze Signal ``` will perform the Wavelet transform of the selected signal.
#### Wavelet Power Spectrum ####
### Wavelet Power Spectrum ###
The input signal for the Wavelet analysis and the resulting 2d-power-spectrum are shown with aligned time axis.
The y-axis indicates the periods(frequencies) selected for analysis.
......@@ -159,7 +161,7 @@ respective box.
<img src="./doc/spectrum.png" alt="drawing" width="500"/>
##### Ridge Analysis #####
#### Ridge Analysis ####
To extract intantaneous frequency and associated phase, a 1d-*ridge* (a profile) has to be traced through the
2d-power spectrum:
......@@ -180,7 +182,7 @@ red line in spectrum plot, note that no default ridge is shown in a fresh
``` Wavelet Spectrum ``` window. For a quick check hit the ``` Detect Maximum Ridge ``` button.
You can also smooth the ridge if needed.
##### Ridge Results #####
### Ridge Results ###
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment