API reference

FEM

The FEM class contains all the classes and methods required to build a proper finite element model.

To construct the mesh, use one of the following methods:

• mesh_from_array

• mesh_from_nii

• mesh_from_masks

• mesh_from_niis

Next, add fields to the mesh with:

• field_from_elems

• field_from_array

• field_from_nii

Finally, add sensors with:

• add_point_sensor

• add_point_sensor_on

• add_point_sensor_in

• add_point_sensors

• add_point_sensors_on

• add_point_sensors_in

• add_point_sensors_from_tsv

• add_point_sensors_from_tsv_on

• add_point_sensors_from_tsv_in

EEG

The EEG module contains everything related with electroencephalography.

Leadfield

The Leadfield module provides both the single and parametric classes to compute respectively a single leadfield matrix and a parametric leadfield matrix.

The single leadfield matrix can be obtained with the ProbEEGLeadfield and SolEEGLeadfield classes. The parametric leadfield atrix on the other hand is computed with the ProbParamEEGLeadfield, SolParamEEGLeadfield and SurrEEGLeadfield classes.

HD-tDCS