Skip to content
This repository was archived by the owner on Feb 26, 2025. It is now read-only.

Commit ebe0084

Browse files
AurelienJaquierJaquier Aurélien Tristan
andauthored
talk about special features in use-case (#413)
--------- Co-authored-by: Jaquier Aurélien Tristan <[email protected]>
1 parent 21d828b commit ebe0084

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,8 @@ To get a list with all the available feature names
139139
efel.get_feature_names()
140140
```
141141

142+
Note that the extra-cellular features, the bpap_attenuation feature and the check_ais_initiation feature are not listed above because they have to be used in a special way, as described [here](https://github.com/BlueBrain/eFEL/blob/master/examples/extracellular/extrafeats_example.ipynb) for extra-cellular features, [here](https://github.com/BlueBrain/eFEL/blob/master/docs/source/eFeatures.rst#bpap_attenuation) for bpap_attenuation feature and [here](https://github.com/BlueBrain/eFEL/blob/master/docs/source/eFeatures.rst#check_ais_initiation) for check_ais_initiation feature.
143+
142144
To change the spike detection threshold setting (default is -20 mV)
143145

144146
```python

docs/source/python_example1.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,14 @@ To get a list with all the available eFeature names::
99

1010
efel.get_feature_names()
1111

12+
Note that the extra-cellular features, the bpap_attenuation feature and the check_ais_initiation feature are not listed above because they have to be used in a special way,
13+
as described `here <https://github.com/BlueBrain/eFEL/blob/master/examples/extracellular/extrafeats_example.ipynb>`__ for extra-cellular features, `here <https://github.com/BlueBrain/eFEL/blob/master/docs/source/eFeatures.rst#bpap_attenuation>`__ for bpap_attenuation feature and `here <https://github.com/BlueBrain/eFEL/blob/master/docs/source/eFeatures.rst#check_ais_initiation>`__ for check_ais_initiation feature.
14+
1215
The python function to extract eFeatures is get_feature_values(...).
1316
Below is a short example on how to use this function.
1417

1518
The code and example trace are available
16-
`here <https://github.com/BlueBrain/eFEL/blob/master/examples/basic/basic_example1.py>`_::
19+
`here <https://github.com/BlueBrain/eFEL/blob/master/examples/basic/basic_example1.py>`__::
1720

1821
"""Basic example 1 for eFEL"""
1922

0 commit comments

Comments
 (0)