Skip to content

Commit

Permalink
add tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
SheinaG committed Apr 23, 2023
1 parent 41fdfd0 commit ff4b4a3
Show file tree
Hide file tree
Showing 9 changed files with 42 additions and 22 deletions.
Binary file modified docs/build/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/.doctrees/tutorials/pecg_analysis.doctree
Binary file not shown.
Binary file added docs/build/_images/results_mor_analysis.PNG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 14 additions & 6 deletions docs/build/_sources/tutorials/pecg_analysis.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,17 @@ ECG file you uploded.

To perform your morphological analysis, please follow these instructions:

#. Prefiltering the signal: On the left panel, select the "Configuration" tab. On the bottom of the tab, you will find a section labeled: **Fiducials filtering parameters**
which refers to two filters applied to your signal before analysis:

#. Prefiltering the signal: On the left panel, select the "Configuration" tab. On the bottom of the tab, you will find a section labeled: **Fiducials filtering parameters** which refers to two filters applied to your signal before analysis:

* The bandpass filter in the range of [0.67,100] Hz. Its purpose is to remove the baseline wander and high frequency noise. Check the box labeled *Bandpass filter* if you want to use it

* The notch filter. Its purpose is to remove the powerline interface. If you want to use it, choose the frequency of the powerline interface of the country where the ECG was recorded.

#. Definition of the window for anlysis: On the right panel, define the W.S. (start of the window) and the W.L. (length of the window) you want to analyze.
You can analyze all of your signal or part of it. Note that if you analyze a long window,it may take some time.
#. Definition of the window for anlysis: On the right panel, define the W.S. (start of the window) and the W.L. (length of the window) you want to analyze. You can analyze all of your signal or part of it. Note that if you analyze a long window,it may take some time.

#. Visualization of multiple leads: Choose the leads you want to visualize and the leads on which you want to plot the fiducial points.

#. Click the *Find Fiducials* button.
#. Click the **Find Fiducials** button.

Congrats! You have made your first morphological analysis with **PhysioZoo ECG**!
The biomarkers are divided into two different categories: Duration and Amplitudes, the statistical measurments of the biomarkers will be presented in a table, in the bottom panel.
Expand All @@ -46,6 +44,16 @@ The biomarkers are divided into two different categories: Duration and Amplitude
.. note:: For multilead anlysis only the median of each biomarker will be presented in the table, while for singel lead anlysis 6 statistical mesurment will be presented for each biomarker:
mean, median, min, max. IQR and std.

**Exporting morphological biomarkers**
--------------------------------------------

You can export the morphological biomarkers and the prefiltered ECG signal generated by **PhysioZoo ECG**. Go to File -> Save Fiducial statistics. The excel file that you saved containe all the computed biomarkers for each lead.

.. image:: results_mor_analysis.PNG
:align: center






Expand Down
1 change: 1 addition & 0 deletions docs/build/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,7 @@ <h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to
<li class="toctree-l1"><a class="reference internal" href="tutorials/pecg_analysis.html">ECG morphological analysis</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorials/pecg_analysis.html#introduction"><strong>Introduction</strong></a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/pecg_analysis.html#performing-ecg-morphological-analysis"><strong>Performing ECG morphological analysis</strong></a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/pecg_analysis.html#exporting-morphological-biomarkers"><strong>Exporting morphological biomarkers</strong></a></li>
</ul>
</li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/searchindex.js

Large diffs are not rendered by default.

21 changes: 12 additions & 9 deletions docs/build/tutorials/pecg_analysis.html
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@
<li class="toctree-l1 current"><a class="current reference internal" href="#">ECG morphological analysis</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#introduction"><strong>Introduction</strong></a></li>
<li class="toctree-l2"><a class="reference internal" href="#performing-ecg-morphological-analysis"><strong>Performing ECG morphological analysis</strong></a></li>
<li class="toctree-l2"><a class="reference internal" href="#exporting-morphological-biomarkers"><strong>Exporting morphological biomarkers</strong></a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -184,19 +185,16 @@ <h2><strong>Performing ECG morphological analysis</strong><a class="headerlink"
ECG file you uploded.</p>
<img alt="../_images/before_analysis.png" class="align-center" src="../_images/before_analysis.png" />
<p>To perform your morphological analysis, please follow these instructions:</p>
<p>#. Prefiltering the signal: On the left panel, select the “Configuration” tab. On the bottom of the tab, you will find a section labeled: <strong>Fiducials filtering parameters</strong>
which refers to two filters applied to your signal before analysis:</p>
<blockquote>
<div><ul class="simple">
<ol class="arabic simple">
<li><p>Prefiltering the signal: On the left panel, select the “Configuration” tab. On the bottom of the tab, you will find a section labeled: <strong>Fiducials filtering parameters</strong> which refers to two filters applied to your signal before analysis:</p>
<ul class="simple">
<li><p>The bandpass filter in the range of [0.67,100] Hz. Its purpose is to remove the baseline wander and high frequency noise. Check the box labeled <em>Bandpass filter</em> if you want to use it</p></li>
<li><p>The notch filter. Its purpose is to remove the powerline interface. If you want to use it, choose the frequency of the powerline interface of the country where the ECG was recorded.</p></li>
</ul>
</div></blockquote>
<p>#. Definition of the window for anlysis: On the right panel, define the W.S. (start of the window) and the W.L. (length of the window) you want to analyze.
You can analyze all of your signal or part of it. Note that if you analyze a long window,it may take some time.</p>
<ol class="arabic simple">
</li>
<li><p>Definition of the window for anlysis: On the right panel, define the W.S. (start of the window) and the W.L. (length of the window) you want to analyze. You can analyze all of your signal or part of it. Note that if you analyze a long window,it may take some time.</p></li>
<li><p>Visualization of multiple leads: Choose the leads you want to visualize and the leads on which you want to plot the fiducial points.</p></li>
<li><p>Click the <em>Find Fiducials</em> button.</p></li>
<li><p>Click the <strong>Find Fiducials</strong> button.</p></li>
</ol>
<p>Congrats! You have made your first morphological analysis with <strong>PhysioZoo ECG</strong>!
The biomarkers are divided into two different categories: Duration and Amplitudes, the statistical measurments of the biomarkers will be presented in a table, in the bottom panel.</p>
Expand All @@ -207,6 +205,11 @@ <h2><strong>Performing ECG morphological analysis</strong><a class="headerlink"
</div>
<p>mean, median, min, max. IQR and std.</p>
</div>
<div class="section" id="exporting-morphological-biomarkers">
<h2><strong>Exporting morphological biomarkers</strong><a class="headerlink" href="#exporting-morphological-biomarkers" title="Permalink to this heading"></a></h2>
<p>You can export the morphological biomarkers and the prefiltered ECG signal generated by <strong>PhysioZoo ECG</strong>. Go to File -&gt; Save Fiducial statistics. The excel file that you saved containe all the computed biomarkers for each lead.</p>
<img alt="../_images/results_mor_analysis.PNG" class="align-center" src="../_images/results_mor_analysis.PNG" />
</div>
</div>


Expand Down
20 changes: 14 additions & 6 deletions docs/tutorials/pecg_analysis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,17 @@ ECG file you uploded.

To perform your morphological analysis, please follow these instructions:

#. Prefiltering the signal: On the left panel, select the "Configuration" tab. On the bottom of the tab, you will find a section labeled: **Fiducials filtering parameters**
which refers to two filters applied to your signal before analysis:

#. Prefiltering the signal: On the left panel, select the "Configuration" tab. On the bottom of the tab, you will find a section labeled: **Fiducials filtering parameters** which refers to two filters applied to your signal before analysis:

* The bandpass filter in the range of [0.67,100] Hz. Its purpose is to remove the baseline wander and high frequency noise. Check the box labeled *Bandpass filter* if you want to use it

* The notch filter. Its purpose is to remove the powerline interface. If you want to use it, choose the frequency of the powerline interface of the country where the ECG was recorded.

#. Definition of the window for anlysis: On the right panel, define the W.S. (start of the window) and the W.L. (length of the window) you want to analyze.
You can analyze all of your signal or part of it. Note that if you analyze a long window,it may take some time.
#. Definition of the window for anlysis: On the right panel, define the W.S. (start of the window) and the W.L. (length of the window) you want to analyze. You can analyze all of your signal or part of it. Note that if you analyze a long window,it may take some time.

#. Visualization of multiple leads: Choose the leads you want to visualize and the leads on which you want to plot the fiducial points.

#. Click the *Find Fiducials* button.
#. Click the **Find Fiducials** button.

Congrats! You have made your first morphological analysis with **PhysioZoo ECG**!
The biomarkers are divided into two different categories: Duration and Amplitudes, the statistical measurments of the biomarkers will be presented in a table, in the bottom panel.
Expand All @@ -46,6 +44,16 @@ The biomarkers are divided into two different categories: Duration and Amplitude
.. note:: For multilead anlysis only the median of each biomarker will be presented in the table, while for singel lead anlysis 6 statistical mesurment will be presented for each biomarker:
mean, median, min, max. IQR and std.

**Exporting morphological biomarkers**
--------------------------------------------

You can export the morphological biomarkers and the prefiltered ECG signal generated by **PhysioZoo ECG**. Go to File -> Save Fiducial statistics. The excel file that you saved containe all the computed biomarkers for each lead.

.. image:: results_mor_analysis.PNG
:align: center






Expand Down
Binary file added docs/tutorials/results_mor_analysis.PNG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ff4b4a3

Please sign in to comment.