Skip to content

Commit

Permalink
add .h linking and update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Jaquier Aurélien Tristan committed May 2, 2024
1 parent 2b06fa6 commit f9b44d7
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 92 deletions.
90 changes: 0 additions & 90 deletions docs/source/eFeatures.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2027,96 +2027,6 @@ Difference between maximum voltage during stimulus and voltage base
maximum_voltage_from_voltagebase = maximum_voltage - voltage_base



Requested eFeatures
===================

Cpp features
------------

AHP_depth_last
~~~~~~~~~~~~~~

Relative voltage values at the last after-hyperpolarization

- **Required features**: voltage_base (mV), last_AHP_values (mV)
- **Units**: mV
- **Pseudocode**: ::

last_AHP_values = last_min_element(voltage, peak_indices)
AHP_depth = last_AHP_values[:] - voltage_base


AHP_time_from_peak_last
~~~~~~~~~~~~~~~~~~~~~~~

Time between AP peaks and last AHP depths

- **Required features**: peak_indices, min_AHP_values (mV)
- **Units**: ms
- **Pseudocode**: ::

last_AHP_indices = last_min_element(voltage, peak_indices)
AHP_time_from_peak_last = t[last_AHP_indices[:]] - t[peak_indices[i]]


steady_state_voltage_stimend_from_voltage_base
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The average voltage during the last 90% of the stimulus duration realtive to voltage_base

- **Required features**: steady_state_voltage_stimend (mV), voltage_base (mV)
- **Units**: mV
- **Pseudocode**: ::

steady_state_voltage_stimend_from_voltage_base = steady_state_voltage_stimend - voltage_base


min_duringstim_from_voltage_base
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The minimum voltage during stimulus

- **Required features**: min_duringstim (mV), voltage_base (mV)
- **Units**: mV
- **Pseudocode**: ::

min_duringstim_from_voltage_base = minimum_voltage - voltage_base


max_duringstim_from_voltage_base
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The minimum voltage during stimulus

- **Required features**: max_duringstim (mV), voltage_base (mV)
- **Units**: mV
- **Pseudocode**: ::

max_duringstim_from_voltage_base = maximum_voltage - voltage_base

diff_max_duringstim
~~~~~~~~~~~~~~~~~~~

Difference between maximum and steady state during stimulation

- **Required features**: max_duringstim (mV), steady_state_voltage_stimend (mV)
- **Units**: mV
- **Pseudocode**: ::

diff_max_duringstim: max_duringstim - steady_state_voltage_stimend

diff_min_duringstim
~~~~~~~~~~~~~~~~~~~

Difference between minimum and steady state during stimulation

- **Required features**: min_duringstim (mV), steady_state_voltage_stimend (mV)
- **Units**: mV
- **Pseudocode**: ::

diff_min_duringstim: min_duringstim - steady_state_voltage_stimend

Python features
---------------

Expand Down
2 changes: 2 additions & 0 deletions efel/cppcore/BasicFeatures.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/

#include "BasicFeatures.h"


int BasicFeatures::interpolate(mapStr2intVec& IntFeatureData,
mapStr2doubleVec& DoubleFeatureData,
Expand Down
2 changes: 2 additions & 0 deletions efel/cppcore/SpikeEvent.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
*/


#include "SpikeEvent.h"

#include <math.h>

#include <algorithm>
Expand Down
1 change: 0 additions & 1 deletion efel/cppcore/SpikeEvent.h
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,6 @@ int time_to_interburst_min(mapStr2intVec& IntFeatureData,
int postburst_slow_ahp_indices(mapStr2intVec& IntFeatureData,
mapStr2doubleVec& DoubleFeatureData,
mapStr2Str& StringData);

int postburst_slow_ahp_values(mapStr2intVec& IntFeatureData,
mapStr2doubleVec& DoubleFeatureData,
mapStr2Str& StringData);
Expand Down
2 changes: 2 additions & 0 deletions efel/cppcore/SpikeShape.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
*/


#include "SpikeShape.h"

#include <math.h>

#include <algorithm>
Expand Down
2 changes: 1 addition & 1 deletion efel/cppcore/SpikeShape.h
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ int AP1_amp(mapStr2intVec& IntFeatureData,
mapStr2Str& StringData);
int AP2_amp(mapStr2intVec& IntFeatureData,
mapStr2doubleVec& DoubleFeatureData,
mapStr2Str& StringData)
mapStr2Str& StringData);
int mean_AP_amplitude(mapStr2intVec& IntFeatureData,
mapStr2doubleVec& DoubleFeatureData,
mapStr2Str& StringData);
Expand Down
1 change: 1 addition & 0 deletions efel/cppcore/Subthreshold.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/

#include "Subthreshold.h"

#include <math.h>

Expand Down

0 comments on commit f9b44d7

Please sign in to comment.