efel.settings¶
efel Settings class
Classes
|
eFEL settings class. |
- class efel.settings.Settings(Threshold=-20.0, DerivativeThreshold=10.0, DownDerivativeThreshold=-12.0, dependencyfile_path='/home/docs/checkouts/readthedocs.org/user_builds/efel/envs/latest/lib/python3.10/site-packages/efel/DependencyV5.txt', spike_skipf=0.1, max_spike_skip=2, interp_step=0.1, burst_factor=1.5, strict_burst_factor=2.0, voltage_base_start_perc=0.9, voltage_base_end_perc=1.0, current_base_start_perc=0.9, current_base_end_perc=1.0, rise_start_perc=0.0, rise_end_perc=1.0, initial_perc=0.1, min_spike_height=20.0, strict_stiminterval=False, initburst_freq_threshold=50, initburst_sahp_start=5, initburst_sahp_end=100, DerivativeWindow=3, voltage_base_mode='mean', current_base_mode='mean', precision_threshold=1e-10, sahp_start=5.0, ignore_first_ISI=True, impedance_max_freq=50.0)[source]¶
eFEL settings class.
- Threshold¶
Spike detection threshold (default: -20.0).
- Type:
float
- DerivativeThreshold¶
Threshold value for derivative calculations
- Type:
float
- (default
10.0).
- DownDerivativeThreshold¶
Threshold value for downward derivative
- Type:
float
- calculations (default
-12.0).
- dependencyfile_path¶
Path to the dependency file
- Type:
str
- (default
‘DependencyV5.txt’).
- spike_skipf¶
Fraction of spikes to skip (default: 0.1).
- Type:
float
- max_spike_skip¶
Maximum number of spikes to skip (default: 2).
- Type:
int
- interp_step¶
Interpolation step (default: 0.1).
- Type:
float
- burst_factor¶
Burst factor (default: 1.5).
- Type:
float
- strict_burst_factor¶
Strict burst factor (default: 2.0).
- Type:
float
- voltage_base_start_perc¶
Voltage base start percentage (default: 0.9).
- Type:
float
- voltage_base_end_perc¶
Voltage base end percentage (default: 1.0).
- Type:
float
- current_base_start_perc¶
Current base start percentage (default: 0.9).
- Type:
float
- current_base_end_perc¶
Current base end percentage (default: 1.0).
- Type:
float
- rise_start_perc¶
Rise start percentage (default: 0.0).
- Type:
float
- rise_end_perc¶
Rise end percentage (default: 1.0).
- Type:
float
- initial_perc¶
Initial percentage (default: 0.1).
- Type:
float
- min_spike_height¶
Minimum spike height (default: 20.0).
- Type:
float
- strict_stiminterval¶
Strict stimulus interval (default: False).
- Type:
bool
- initburst_freq_threshold¶
Initial burst frequency threshold
- Type:
int
- (default
- initburst_sahp_start¶
Initial burst SAHP start (default: 5).
- Type:
int
- initburst_sahp_end¶
Initial burst SAHP end (default: 100).
- Type:
int
- DerivativeWindow¶
Derivative window (default: 3).
- Type:
int
- voltage_base_mode¶
Voltage base mode (default: “mean”).
- Type:
str
- current_base_mode¶
Current base mode (default: “mean”).
- Type:
str
- precision_threshold¶
Precision threshold (default: 1e-10).
- Type:
float
- sahp_start¶
SAHP start (default: 5.0).
- Type:
float
- ignore_first_ISI¶
Ignore first ISI (default: True).
- Type:
bool
- impedance_max_freq¶
Impedance maximum frequency (default: 50.0).
- Type:
float
- Parameters:
Threshold (
float
)DerivativeThreshold (
float
)DownDerivativeThreshold (
float
)dependencyfile_path (
str
)spike_skipf (
float
)max_spike_skip (
int
)interp_step (
float
)burst_factor (
float
)strict_burst_factor (
float
)voltage_base_start_perc (
float
)voltage_base_end_perc (
float
)current_base_start_perc (
float
)current_base_end_perc (
float
)rise_start_perc (
float
)rise_end_perc (
float
)initial_perc (
float
)min_spike_height (
float
)strict_stiminterval (
bool
)initburst_freq_threshold (
int
)initburst_sahp_start (
int
)initburst_sahp_end (
int
)DerivativeWindow (
int
)voltage_base_mode (
str
)current_base_mode (
str
)precision_threshold (
float
)sahp_start (
float
)ignore_first_ISI (
bool
)impedance_max_freq (
float
)
- set_setting(setting_name, new_value)[source]¶
Set a certain setting to a new value.
- Parameters:
setting_name (str) – Name of the setting to be modified.
new_value (Union[int, float, str, bool]) – New value for the setting.
- Raises:
ValueError – If the value is of the wrong type.
FileNotFoundError – If the path to the dependency file does not exist
(for 'dependencyfile_path' setting). –
- Return type:
None