biophysics_fitting ❭ evaluator ❭ Evaluator ❭ evaluate

Evaluator.evaluate¶

biophysics_fitting.evaluator.Evaluator.evaluate(features_dict, raise_=True)¶

Extracts features from a simulation result computed by biophysics_fitting.simulator.Simulator.run()

Details on how to set up the Evaluator are in the docstring of the Evaluator class.

Parameters:¶

• features_dict (dict) – a dictionary of stimulus names as keys, and corresponding voltage traces as values.

• raise_ (bool) – Whether or not to raise an error if the required voltage trace is not in features_dict.keys(). If False, will not raise an error, and evaluate all features that can be evaluated given the provided features_dict.

Raises:¶

KeyError – if the Evaluator tries to evaluate a trace with a name that is not present in features_dict.keys() and raise_ is set to True.

Returns:¶

Whatever the return value is of Evaluator.setup.finalize_funs. Usually, this is the output of get_Evaluator(),

Return type:¶

obj