bluepyefe.target

EFeatureTarget class

Classes

EFeatureTarget(efeature_name, ...[, ...])

E-feature target defined by an efeature to compute for a given protocol and amplitude.

class EFeatureTarget(efeature_name, efel_feature_name, protocol_name, amplitude, tolerance, efel_settings=None)[source]

Bases: object

E-feature target defined by an efeature to compute for a given protocol and amplitude. Contains the resulting values

Constructor.

Parameters:
  • efeature_name (str) – name of the feature (can be different than the efel_feature_name - e.g. Spikecount_phase1)

  • efel_feature_name (str) – name of the eFeature in the eFEL library (ex: ‘AP1_peak’)

  • protocol_name (str) – name of the recording from which the efeature should be computed

  • amplitude (float) – amplitude of the current stimuli for which the efeature should be computed (expressed as a percentage of the threshold amplitude (rheobase))

  • tolerance (float) – tolerance around the target amplitude in which an experimental recording will be seen as a hit during efeatures extraction (expressed as a percentage of the threshold amplitude (rheobase))

  • efel_settings (dict) – target specific efel settings.

add_effective_threshold()[source]

If auto threshold detection was used during feature extraction, update the efel settings with the Threshold that was actually used

append(value, files=None)[source]

Append a feature value to the present target

as_dict(save_files_used=False, default_std_value=0.001)[source]

Returns the target in the form of a dictionary in a legacy format

clear()[source]

Clear the list of feature values

property mean

Average of the e-feature value at target

property sample_size

Number of value that matched the target present

property std

Standard deviation of the e-feature value at target

property values

Return all values.