fix tutorial

aim-lab · Jun 6, 2023 · 09fb6ee · 09fb6ee
1 parent ab280e5
commit 09fb6ee
Show file tree

Hide file tree

Showing 14 changed files with 31 additions and 48 deletions.
diff --git a/docs/build/.doctrees/environment.pickle b/docs/build/.doctrees/environment.pickle
diff --git a/docs/build/.doctrees/index.doctree b/docs/build/.doctrees/index.doctree
diff --git a/docs/build/.doctrees/tutorials/pecg_analysis.doctree b/docs/build/.doctrees/tutorials/pecg_analysis.doctree
diff --git a/docs/build/_modules/index.html b/docs/build/_modules/index.html
@@ -97,7 +97,6 @@
 <p class="caption" role="heading"><span class="caption-text">tutorials:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../tutorials/pecg_analysis.html">ECG morphological analysis</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../tutorials/pecg_Holter_analysis.html">ECG morphological analysis</a></li>
 </ul>
 
 

diff --git a/docs/build/_sources/index.rst.txt b/docs/build/_sources/index.rst.txt
@@ -23,7 +23,7 @@ TUTORIALS
    :caption: tutorials:
 
    tutorials/pecg_analysis.rst
-   tutorials/pecg_Holter_analysis.rst
+
 
 
 

diff --git a/docs/build/_sources/tutorials/pecg_analysis.rst.txt b/docs/build/_sources/tutorials/pecg_analysis.rst.txt
@@ -1,27 +1,25 @@
 ECG morphological analysis
 ==========================
 
-In this tutorial you will learn how to use **PhysioZoo ECG** to compute the morphological biomarkers and export the computed values.
-(link: https://physiozoo.com/)
+In this tutorial you will learn how to use **PhysioZoo ECG** to engineer morphological ECG  biomarkers and export their values.
 
 **Introduction**
 ----------------------
 An electrocardiogram (ECG) is a simple test that uses temporary electrodes on the chest and limbs to monitor, track, and document the heart's electrical activity. 
 The ECG provides information about the function of the intracardiac conduction system, which is responsible for generating and propagating electrical impulses through the heart. 
 The ECG records the sequence of depolarization and repolarization of the atria and ventricles, which are represented by different waves on the ECG.
 
-Studying the morphological statistics of the signal may provide information on the underlying physiological heart condition. 
-**PhysioZoo ECG** provides the framework and tools for extracting morphological biomarkers from the ECG signal.
+Studying the morphological characteristics of the ECG may provide information on  underlying physiological heart conditions. 
+**PhysioZoo ECG** provides a framework and tools for extracting morphological biomarkers from the ECG signal.
 
 **Performing ECG morphological analysis**
 ------------------------------------------------------------
-Start by entering the ECG interface by clicking on the 'Peak Detection' tab on the top right, then load some ECG example by clicking File -> Open data file -> ECG_example.txt. The program will automaticly present the 
-ECG file you uploded.
+Start by entering the ECG interface by clicking on the 'Peak Detection' tab on the top right, then load some ECG example by clicking File -> Open data file -> Human_example_ecg_12_leads_short.txt. The program will automaticly present the ECG file you imported.
 
 .. image:: before_analysis.png
    :align: center
 
-To perform your morphological analysis, please follow these instructions:
+To perform the analysis, please follow the 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:
 
@@ -33,21 +31,20 @@ To perform your morphological analysis, please follow these instructions:
 
 #. 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. The fiducial poits will be detected and highlighted while the biomarkers will be automatically engineered and displayed on the lower pannels.
 
 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. 
 
 .. image:: after_analysis.png
    :align: center
 
-.. 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.
+.. note:: For multilead anlysis only the median of each biomarker will be presented in the table, while for single lead anlysis 6 statistical mesurment computed over the selected window (defined by W.S. W.L.) will be presented for each biomarker namely: mean, median, min, max. IQR and std.
 
 **Exporting morphological biomarkers**
 --------------------------------------------
 
-You can export the morphological biomarkers by **PhysioZoo ECG**. Go to File -> Save Fiducial statistics. The excel file that you saved containe all the computed biomarkers for each lead. 
+You can export the morphological biomarkers. Go to File -> Save Fiducial Biomarkers. The excel file contains the engineered ECG biomarkers for each lead. 
 
 .. image:: results_mor_analysis.PNG
    :align: center

diff --git a/docs/build/genindex.html b/docs/build/genindex.html
@@ -97,7 +97,6 @@
 <p class="caption" role="heading"><span class="caption-text">tutorials:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="tutorials/pecg_analysis.html">ECG morphological analysis</a></li>
-<li class="toctree-l1"><a class="reference internal" href="tutorials/pecg_Holter_analysis.html">ECG morphological analysis</a></li>
 </ul>
 
 

diff --git a/docs/build/index.html b/docs/build/index.html
@@ -98,7 +98,6 @@
 <p class="caption" role="heading"><span class="caption-text">tutorials:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="tutorials/pecg_analysis.html">ECG morphological analysis</a></li>
-<li class="toctree-l1"><a class="reference internal" href="tutorials/pecg_Holter_analysis.html">ECG morphological analysis</a></li>
 </ul>
 
 
@@ -266,12 +265,6 @@ <h1>TUTORIALS<a class="headerlink" href="#tutorials" title="Permalink to this he
 <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>
-<li class="toctree-l1"><a class="reference internal" href="tutorials/pecg_Holter_analysis.html">ECG morphological analysis</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="tutorials/pecg_Holter_analysis.html#introduction"><strong>Introduction</strong></a></li>
-<li class="toctree-l2"><a class="reference internal" href="tutorials/pecg_Holter_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_Holter_analysis.html#exporting-morphological-biomarkers"><strong>Exporting morphological biomarkers</strong></a></li>
-</ul>
-</li>
 </ul>
 </div>
 </div>

diff --git a/docs/build/py-modindex.html b/docs/build/py-modindex.html
@@ -100,7 +100,6 @@
 <p class="caption" role="heading"><span class="caption-text">tutorials:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="tutorials/pecg_analysis.html">ECG morphological analysis</a></li>
-<li class="toctree-l1"><a class="reference internal" href="tutorials/pecg_Holter_analysis.html">ECG morphological analysis</a></li>
 </ul>
 
 

diff --git a/docs/build/search.html b/docs/build/search.html
@@ -100,7 +100,6 @@
 <p class="caption" role="heading"><span class="caption-text">tutorials:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="tutorials/pecg_analysis.html">ECG morphological analysis</a></li>
-<li class="toctree-l1"><a class="reference internal" href="tutorials/pecg_Holter_analysis.html">ECG morphological analysis</a></li>
 </ul>