Skip to content

Commit be893e2

Browse files
committed
draft of coil description
1 parent ecd8d90 commit be893e2

1 file changed

Lines changed: 15 additions & 8 deletions

File tree

docs/modules/BrainStimulator/ModelTMSCoil.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,19 @@ The ModelTMSCoil module will use a set of parameters from the module UI (or modu
99
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.
1010

1111
Module parameters used to generate the TMS coil geometry and field data are:
12-
-
12+
- Model Type: Type of output geometry and current source representation to use.
13+
- Coil Shape: Shape of the coil to generate. O-shape is one loop, 8-shape is two loops.
14+
- Current (dI/dt) [A/µs (10e6 A/s)]: Value of the current derivative used in the TMS coil. Units are assumed to be Amps per microsecond or 10e6 Amps per second
15+
- Rings/Windings: Number of wire rings/windings (per Stack) used in the coil. Total number of windings/rings in a loop is [Rings/Windings] x [Stack].
16+
- Wings angle: relative angle placement of loops in an 8-shaped coil model.
17+
- Radius Inner [mm]: Inner radius of each loop of the coil.
18+
- Radius Outer [mm]: Outer radius of each loop of the coil.
19+
- Outer Distance [mm]: Distance between the two loops of a 8-shape coil
20+
- Stack: Number of layers of wire windings (or wire rings) in the coil. Total number of windings/rings in a loop is `[Rings/Windings] * [Stack]`.
21+
- Stack Step [mm]: distance between wire stacks. Height of the coil will be `[Stack Step] x ([Stack] - 1])`.
22+
- Level of Detail: Refers to the resolution of the output mesh. Higher detail level will produce meshes with more points and edges.
23+
1324

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.
25+
The output of the module will be a SCIRun Field **Mesh** with the geometries and field data representing the TMS coil. The mesh and data type will depend on the Model Type.
26+
- Circle and Spiral types will output a curvelinear mesh with nodes and edges. The scalar data on the nodes represents the current sources (dI/dt).
27+
- The Magnetic Dipole type will produce a point cloud mesh with vector data indicating the magnetic moment for each loop of the coil. There will be one node per loop (max of two) located at the center of the loop, and the vector is the magnectic moment generated by the current through the coil.

0 commit comments

Comments
 (0)