Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

talk about special features in use-case #413

Merged
merged 3 commits into from
Nov 8, 2024
Merged

talk about special features in use-case #413

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6765ebc
talk about special features in use-case
Nov 8, 2024
2598174
use github links instead of readthedocs in readme and example
Nov 8, 2024
f1e845e
use anonymous hyperlink references in use-case .rst documentation
Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 4 additions & 1 deletion docs/source/python_example1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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.

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 <https://github.com/BlueBrain/eFEL/blob/master/examples/basic/basic_example1.py>`_::
`here <https://github.com/BlueBrain/eFEL/blob/master/examples/basic/basic_example1.py>`__::

"""Basic example 1 for eFEL"""

Expand Down
Loading