openbraininstitute / neurodamus / 21910816959

91%

push

github

Implement extracellular stimulus: module "spatially_uniform_e_field" (#425)

## Context
Implements the extracellular stimulus of pattern
spatially_uniform_e_field. It allows the summation of multiple `fields`
in the same stimulus block, as well as the combination of multiple
spatially_uniform_e_field stimulus blocks. For each spatially_uniform_e_field stimulus:
- Rotate/translate all segments' local positions to obtain the global coordinates
- For the new axon and myelin sections, interpolate their local positions along local soma y-axis, then rotate/translate them into global coordinates
- Compute extracellular potentials by (seg_global_pos - vec_soma_global_pos) .dot (Ex,Ey,Ez)

## Scope
1. New class `SpatiallyUniformEField` in `stimulus_manger.py`
2. New class `ElectrodeSource` in `stimuli.py`
3. Function `get_all_segment_points` in `metype.py` to compute the
global coordinates of all the segment points

## Testing
1. new unit test in `test_metype.py` for `get_all_segment_points`
2. fix `test_get_section_id` in `test_metype.py` which should assert the
section ids of the test cell.
3. new unit tests for the new electric field stimulus
- unit/test_single_extracellular_stimulus.py (single stimulus block)
- unit/test_multiple_extracellular_stimulus.py (multiple stimulus
blocks)
- unit-mpi/test_extracellular_stimulus.py (mpi test)
- scientific/test_extracellular_stimulation (for reporting)
4. And the rotation to the current ring test big-cell nodes file, to
enable the computation of segments' global coordinates. Should have no
impact on the other unit tests.

## Review
* [x] PR description is complete
* [x] Coding style (imports, function length, New functions, classes or
files) are good
* [x] Unit/Scientific test added
* [ ] Updated Readme, in-code, developer documentation

## Docs


https://github.com/openbraininstitute/sonata-extension/blob/master/source/sonata_simulation.rst

---------

Co-authored-by: Alessandro Cattabiani <cattabiani@users.noreply.github.com>

246 of 255 new or added lines in 6 files covered. (96.47%)

7538 of 8299 relevant lines covered (90.83%)

2.29 hits per line