FIX: correct electrode parameters (#63)

* FIX: correct electrode parameters According to Lead-DBS specs https://github.com/netstim/leaddbs/blob/develop/templates/electrode_models/ea_resolve_elspec.m * update tests for AbbottStJude electrode * update tests for MedtronicSenSight electrode * update electrode documentation --------- Co-authored-by: JPPayonk <[email protected]>
SFB-ELAINE · Dec 20, 2024 · bc13f5e · bc13f5e
1 parent 2d68102
commit bc13f5e
Show file tree

Hide file tree

Showing 34 changed files with 484 additions and 348 deletions.
diff --git a/docs/electrode_files/Abbott_Active_Tip.rst b/docs/electrode_files/Abbott_Active_Tip.rst
@@ -2,53 +2,51 @@
 Abbott St. Jude Active Tip
 ==========================
 
-* Manufacturer: Abbott / St. Jude
-* Products: Abbott / St. Jude 6142- 6145, Abbott / St. Jude 6146-6149
-* Models: 6142, 6143, 6144, 6145, 6146, 6147, 6148, 6149
+* **Manufacturer:** `Abbott <https://www.abbott.com/>`_  
+* **Products:** Abbott / St. Jude 6142-6145, Abbott / St. Jude 6146-6149  
+* **Models:** 6142, 6143, 6144, 6145, 6146, 6147, 6148, 6149  
 
-Source documentation: `Source <https://manuals.sjm.com/~/media/manuals/product-manual-pdfs/8/6/86a4f8d2-35ab-42f8-9fa3-a53c22dda2dd.pdf>`_.
-The source documentation also contains information 
-about :doc:`Abbot St. Jude Directed <./Abbott_StJude_Directed>`.
+Source documentation: `Source <https://manuals.sjm.com/~/media/manuals/product-manual-pdfs/8/6/86a4f8d2-35ab-42f8-9fa3-a53c22dda2dd.pdf>`_.  
+The source documentation also contains information about :doc:`Abbott St. Jude Directed <./Abbott_StJude_Directed>`.
 
 -----------------------------------
 St. Jude Traditional Lead 6142-6145
 -----------------------------------
 
 .. image:: electrode_pictures/St-Jude-6142-6145.svg
-
+   :alt: Illustration of St. Jude Traditional Lead 6142-6145
 
 ~~~~~~~~~~~~~~~~~~~~~~~
 Default Parameters (mm)
 ~~~~~~~~~~~~~~~~~~~~~~~
-     		* tip_length = 3.0
-                * contact_length = 1.5
-                * contact_spacing = 1.5
-                * lead_diameter = 1.4
-                * total_length = 400.0
-                
-	
+
+* tip_length = 3.0
+* contact_length = 1.5
+* contact_spacing = 1.5
+* lead_diameter = 1.4
+* total_length = 400.0
+
 -----------------------------------
 St. Jude Traditional Lead 6146-6149
 -----------------------------------
-
-.. image:: electrode_pictures/St-Jude-6146-6149.svg
 
+.. image:: electrode_pictures/St-Jude-6146-6149.svg
+   :alt: Illustration of St. Jude Traditional Lead 6146-6149
 
 ~~~~~~~~~~~~~~~~~~~~~~~
 Default Parameters (mm)
 ~~~~~~~~~~~~~~~~~~~~~~~
-     		* tip_length = 3.0
-                * contact_length = 1.5
-                * contact_spacing = 0.5
-                * lead_diameter = 1.4
-                * total_length = 400.0  
 
-.. note::  The total length does not influence the computational domain that's why all the above electrodes are modeled at 400mm 
+* tip_length = 3.0
+* contact_length = 1.5
+* contact_spacing = 0.5
+* lead_diameter = 1.4
+* total_length = 400.0  
 
 ----
 Code
 ----
 
 .. autoclass:: ossdbs.electrodes.abbott_stjude.AbbottStJudeActiveTipModel
-    :members:
-    :show-inheritance:
+    :members:  
+    :show-inheritance:  
diff --git a/docs/electrode_files/Abbott_StJude_Directed.rst b/docs/electrode_files/Abbott_StJude_Directed.rst
@@ -1,53 +1,52 @@
 ========================
-Abbott St. Jude Directed 
+Abbott St. Jude Directed
 ========================
 
-* Manufacturer: Abbott / St. Jude
-* Products: Abbott / St. Jude 6172, Abbott / St. Jude 6173
-* Models: 6172, 6173
+* **Manufacturer:** `Abbott <https://www.abbott.com/>`_
+* **Products:** Abbott / St. Jude 6172, Abbott / St. Jude 6173  
+* **Models:** 6172, 6173  
 
-Source documentation: `Source <https://manuals.sjm.com/~/media/manuals/product-manual-pdfs/8/6/86a4f8d2-35ab-42f8-9fa3-a53c22dda2dd.pdf>`_.
-The source documentation also contains information 
-about :doc:`Abbot St. Jude Active Tip <./Abbott_Active_Tip>`
+Source documentation: `Source <https://manuals.sjm.com/~/media/manuals/product-manual-pdfs/8/6/86a4f8d2-35ab-42f8-9fa3-a53c22dda2dd.pdf>`_.  
+The source documentation also contains information about :doc:`Abbott St. Jude Active Tip <./Abbott_Active_Tip>`.
 
 -------------------------------------------------
 St. Jude Medical Infinity ™ Directional Lead 6172
 -------------------------------------------------
 
 .. image:: electrode_pictures/Abott_St_Jude_6172.svg
-
+   :alt: Illustration of Abbott St. Jude Infinity Directional Lead 6172
 
 ~~~~~~~~~~~~~~~~~~~~~~~
 Default Parameters (mm)
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-     		* tip_length = 1.5
-                * contact_length = 1.5
-                * contact_spacing = 0.5
-                * lead_diameter = 1.29
-                * total_length = 400.0
-
+* tip_length = 1.0
+* contact_length = 1.5
+* contact_spacing = 0.5
+* lead_diameter = 1.29
+* total_length = 400.0
 
 -------------------------------------------------
 St. Jude Medical Infinity ™ Directional Lead 6173
 -------------------------------------------------
-
-.. image:: electrode_pictures/Abott_St_Jude_6173.svg
 
+.. image:: electrode_pictures/Abott_St_Jude_6173.svg
+   :alt: Illustration of Abbott St. Jude Infinity Directional Lead 6173
 
 ~~~~~~~~~~~~~~~~~~~~~~~
 Default Parameters (mm)
 ~~~~~~~~~~~~~~~~~~~~~~~
-     		* tip_length = 1.5
-                * contact_length = 1.5
-                * contact_spacing = 1.5
-                * lead_diameter = 1.29
-                * total_length = 400.0  
+
+* tip_length = 1.0
+* contact_length = 1.5
+* contact_spacing = 1.5
+* lead_diameter = 1.29
+* total_length = 400.0
 
 ----
 Code
 ----
 
 .. autoclass:: ossdbs.electrodes.abbott_stjude.AbbottStJudeDirectedModel
-    :members:
-    :show-inheritance:
+    :members:  
+    :show-inheritance:  
diff --git a/docs/electrode_files/Boston_Scientific_Cartesia.rst b/docs/electrode_files/Boston_Scientific_Cartesia.rst
@@ -2,62 +2,58 @@
 Boston Scientific Cartesia
 ==========================
 
-* Manufacturer: Boston Scientific
-* Product: Boston Scientific Cartesia
-* Serial name: CartesiaX, CartesiaHX
+* **Manufacturer:** `Boston Scientific <https://www.bostonscientific.com/en-US/home.html>`_ 
+* **Product:** Boston Scientific Cartesia  
+* **Serial name:** CartesiaX, CartesiaHX  
 
-Source documentation:
-`Source PDF <https://www.bostonscientific.com/content/dam/elabeling/nm/92495783-02_Vercis_TM-DBS_Systems_Surgical_Implant_Manual_multi-OUS_s.pdf>`_.
-`Source Webpage <https://www.bostonscientific.com/en-US/products/deep-brain-stimulation-systems/vercise-genus-dbs-system/leads.html>`_.
+Source documentation:  
+`Source PDF <https://www.bostonscientific.com/content/dam/elabeling/nm/92495783-02_Vercis_TM-DBS_Systems_Surgical_Implant_Manual_multi-OUS_s.pdf>`_  
+`Source Webpage <https://www.bostonscientific.com/en-US/products/deep-brain-stimulation-systems/vercise-genus-dbs-system/leads.html>`_  
 
-
-The source documentation also contains information about
-:doc:`Boston Scientific Directed Lead (DB-2202) <./Boston_Scientific_Vercise_Directed>`.
+The source documentation also contains information about :doc:`Boston Scientific Directed Lead (DB-2202) <./Boston_Scientific_Vercise_Directed>`.
 
 ---------------------------
 Boston Scientific CartesiaX
 ---------------------------
 
-
 ~~~~~~~~~~~~~~~~~~~~~~~
 Default Parameters (mm)
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-                * tip_length = 1.1
-                * contact_length = 1.5
-                * contact_spacing = 0.5
-                * lead_diameter = 1.3
-                * total_length = 450.0
-                * contacts_skipped = 5.0
+* tip_length = 1.1
+* contact_length = 1.5
+* contact_spacing = 0.5
+* lead_diameter = 1.3
+* total_length = 450.0
+* contacts_skipped = 5.0
 
 ----
 Code
 ----
 
 .. autoclass:: ossdbs.electrodes.boston_scientific_cartesia.BostonScientificCartesiaXModel
-    :members:
-    :show-inheritance:
+    :members:  
+    :show-inheritance:  
 
 ----------------------------
 Boston Scientific CartesiaHX
 ----------------------------
 
-
 ~~~~~~~~~~~~~~~~~~~~~~~
 Default Parameters (mm)
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-                * tip_length = 1.1
-                * contact_length = 1.5
-                * contact_spacing = 0.5
-                * lead_diameter = 1.3
-                * total_length = 450.0
-                * contacts_skipped = 7.0
+* tip_length = 1.1
+* contact_length = 1.5
+* contact_spacing = 0.5
+* lead_diameter = 1.3
+* total_length = 450.0
+* contacts_skipped = 7.0
 
 ----
 Code
 ----
 
 .. autoclass:: ossdbs.electrodes.boston_scientific_cartesia.BostonScientificCartesiaHXModel
-    :members:
-    :show-inheritance:
+    :members:  
+    :show-inheritance:  
diff --git a/docs/electrode_files/Boston_Scientific_Vercise.rst b/docs/electrode_files/Boston_Scientific_Vercise.rst
@@ -2,23 +2,22 @@
 Boston Scientific Vercise
 =========================
 
-* Manufacturer: Boston Scientific
-* Product: Boston Scientific Standard Lead
-* Serial name: DB-2201
+* **Manufacturer:** `Boston Scientific <https://www.bostonscientific.com/en-US/home.html>`_
+* **Product:** Boston Scientific Standard Lead  
+* **Serial name:** DB-2201  
 
-Source documentation:
-`Source PDF <https://www.bostonscientific.com/content/dam/elabeling/nm/92495783-02_Vercis_TM-DBS_Systems_Surgical_Implant_Manual_multi-OUS_s.pdf>`_.
-`Source Webpage <https://www.bostonscientific.com/en-US/products/deep-brain-stimulation-systems/vercise-genus-dbs-system/leads.html>`_.
+Source documentation:  
+`Source PDF <https://www.bostonscientific.com/content/dam/elabeling/nm/92495783-02_Vercis_TM-DBS_Systems_Surgical_Implant_Manual_multi-OUS_s.pdf>`_  
+`Source Webpage <https://www.bostonscientific.com/en-US/products/deep-brain-stimulation-systems/vercise-genus-dbs-system/leads.html>`_  
 
-The source documentation also contains information about
-:doc:`Boston Scientific Directed Lead (DB-2202) <./Boston_Scientific_Vercise_Directed>`.
+The source documentation also contains information about :doc:`Boston Scientific Directed Lead (DB-2202) <./Boston_Scientific_Vercise_Directed>`.
 
 ---------------------------------------
 Boston Scientific Standard Lead DB-2201
 ---------------------------------------
 
 .. image:: electrode_pictures/Boston-Scientific-Vercise.svg
-
+   :alt: Illustration of Boston Scientific Standard Lead DB-2201
 
 ~~~~~~~~~~~~~~~~~~~~~~~
 Default Parameters (mm)
@@ -35,5 +34,5 @@ Code
 ----
 
 .. autoclass:: ossdbs.electrodes.boston_scientific_vercise.BostonScientificVerciseModel
-    :members:
-    :show-inheritance:
+    :members:  
+    :show-inheritance:  
diff --git a/docs/electrode_files/Boston_Scientific_Vercise_Directed.rst b/docs/electrode_files/Boston_Scientific_Vercise_Directed.rst
@@ -1,23 +1,23 @@
 ==================================
 Boston Scientific Vercise Directed
 ==================================
-* Manufacturer: Boston Scientific
-* Product: Boston Scientific Directional Lead
-* Serial name: DB-2202
 
-Source documentation:
-`Source PDF <https://www.bostonscientific.com/content/dam/elabeling/nm/92495783-02_Vercis_TM-DBS_Systems_Surgical_Implant_Manual_multi-OUS_s.pdf>`_.
-`Source Webpage <https://www.bostonscientific.com/en-US/products/deep-brain-stimulation-systems/vercise-genus-dbs-system/leads.html>`_.
+* **Manufacturer:** `Boston Scientific <https://www.bostonscientific.com/en-US/home.html>`_
+* **Product:** Boston Scientific Directional Lead  
+* **Serial name:** DB-2202  
 
-The source documentation also contains information about
-:doc:`Boston Scientific Standard Lead (DB-2201) <./Boston_Scientific_Vercise>`.
+Source documentation:  
+`Source PDF <https://www.bostonscientific.com/content/dam/elabeling/nm/92495783-02_Vercis_TM-DBS_Systems_Surgical_Implant_Manual_multi-OUS_s.pdf>`_  
+`Source Webpage <https://www.bostonscientific.com/en-US/products/deep-brain-stimulation-systems/vercise-genus-dbs-system/leads.html>`_  
+
+The source documentation also contains information about :doc:`Boston Scientific Standard Lead (DB-2201) <./Boston_Scientific_Vercise>`.
 
 ------------------------------------------
 Boston Scientific Directional Lead DB-2202
 ------------------------------------------
 
 .. image:: electrode_pictures/Boston-Scientific-Vercise-directed.svg
-
+   :alt: Illustration of Boston Scientific Directional Lead DB-2202
 
 ~~~~~~~~~~~~~~~~~~~~~~~
 Default Parameters (mm)
@@ -34,5 +34,5 @@ Code
 ----
 
 .. autoclass:: ossdbs.electrodes.boston_scientific_vercise.BostonScientificVerciseDirectedModel
-    :members:
-    :show-inheritance:
+    :members:  
+    :show-inheritance: