From ebe008413d0602a826fb592e2074e5dd00c96b75 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aur=C3=A9lien=20Jaquier?= <72930209+AurelienJaquier@users.noreply.github.com> Date: Fri, 8 Nov 2024 12:38:29 +0100 Subject: [PATCH] talk about special features in use-case (#413) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --------- Co-authored-by: Jaquier Aurélien Tristan --- README.md | 2 ++ docs/source/python_example1.rst | 5 ++++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bb99851a..303bfc0a 100644 --- a/README.md +++ b/README.md @@ -139,6 +139,8 @@ To get a list with all the available feature names efel.get_feature_names() ``` +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. + To change the spike detection threshold setting (default is -20 mV) ```python diff --git a/docs/source/python_example1.rst b/docs/source/python_example1.rst index f0355655..dc647daf 100644 --- a/docs/source/python_example1.rst +++ b/docs/source/python_example1.rst @@ -9,11 +9,14 @@ To get a list with all the available eFeature names:: efel.get_feature_names() +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 `__ for extra-cellular features, `here `__ for bpap_attenuation feature and `here `__ for check_ais_initiation feature. + The python function to extract eFeatures is get_feature_values(...). Below is a short example on how to use this function. The code and example trace are available -`here `_:: +`here `__:: """Basic example 1 for eFEL"""