Skip to content

Commit ecd8d90

Browse files
committed
some more text for brain stim modules
1 parent d82fc48 commit ecd8d90

2 files changed

Lines changed: 37 additions & 0 deletions

File tree

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# ModelTMSCoil
2+
3+
Generate a TMS coil geometry with current sources to model include in TMS modeling pipeline.
4+
5+
**Detailed Description**
6+
7+
The ModelTMSCoil module will use a set of parameters from the module UI (or module state) to generate mesh with field data to represent a TMS stimulation device in a TMS modeling pipeline. This module is designed to work with the [SolveBioSavart](SolveBioSavart.md) module where the current sources of the coil will be used to estimate the magnetic field through a target domain.
8+
9+
See the [Brain Stimulator Toolkit](https://github.com/SCIInstitute/BrainStimulator) and its [Manual](https://github.com/SCIInstitute/BrainStimulator/blob/master/Documentation/Manuals/BrainStimulatorTutorial.pdf) for more information.
10+
11+
Module parameters used to generate the TMS coil geometry and field data are:
12+
-
13+
14+
Inputs to the module are:
15+
- Coil (Field type): a TMS coil field, assumed to match the format of the [ModelTMSCoil](ModelTMSCoil.md) module output.
16+
- Mesh [Field type]: head or domain mesh for the magnetic field prediction
17+
18+
Outputs are only generated when ports are connected. These are:
19+
- VectorBField (Matrix type): Matrix containing the **magnetic field** values for each point on the domain mesh. Use [SetFieldData](../ChangeFieldData/SetFieldData.md) to reassign these values to the mesh
20+
- VectorAField (Matrix type): Matrix containing the **magnetic vector potential** values for each point on the domain mesh. Use [SetFieldData](../ChangeFieldData/SetFieldData.md) to reassign these values to the mesh.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# SolveBioSavart
2+
3+
Calculation of magnetic field through a given domain mesh with a TMS coil geometry.
4+
5+
**Detailed Description**
6+
7+
The modules calculates the magnetic field due to given TMS coil geometry and parameters at through a provide domain mesh based on the Biot-Savart law.
8+
9+
See the [Brain Stimulator Toolkit](https://github.com/SCIInstitute/BrainStimulator) and its [Manual](https://github.com/SCIInstitute/BrainStimulator/blob/master/Documentation/Manuals/BrainStimulatorTutorial.pdf) for more information.
10+
11+
Inputs to the module are:
12+
- Coil (Field type): a TMS coil field, assumed to match the format of the [ModelTMSCoil](ModelTMSCoil.md) module output.
13+
- Mesh [Field type]: head or domain mesh for the magnetic field prediction
14+
15+
Outputs are only generated when ports are connected. These are:
16+
- VectorBField (Matrix type): Matrix containing the **magnetic field** values for each point on the domain mesh. Use [SetFieldData](../ChangeFieldData/SetFieldData.md) to reassign these values to the mesh
17+
- VectorAField (Matrix type): Matrix containing the **magnetic vector potential** values for each point on the domain mesh. Use [SetFieldData](../ChangeFieldData/SetFieldData.md) to reassign these values to the mesh.

0 commit comments

Comments
 (0)