get_Evaluator¶

biophysics_fitting.hay.default_setup.get_Evaluator(step=False, vInit=False, bAP_kwargs={}, BAC_kwargs={}, StepOne_kwargs={}, StepTwo_kwargs={}, StepThree_kwargs={}, interpolate_voltage_trace=True)¶

Get a Evaluator object for the Hay protocol.

Sets up an evaluator object for the Hay protocol, including measuring functions for bAP, BAC and three step current stimuli.

Parameters:¶

step : bool¶

Whether to include step current measurements (not implemented yet).

vInit : bool¶

Whether to include vInit measurements. (not implemented yet)

bAP_kwargs : dict¶

Keyword arguments for the bAP measurement function.

BAC_kwargs : dict¶

Keyword arguments for the BAC measurement function.

StepOne_kwargs : dict¶

Keyword arguments for the StepOne measurement function.

StepTwo_kwargs : dict¶

Keyword arguments for the StepTwo measurement function.

StepThree_kwargs : dict¶

Keyword arguments for the StepThree measurement function.

interpolate_voltage_trace : bool¶

Whether to interpolate the voltage trace to a fixed time interval.

Returns:¶

An evaluator object.

Return type:¶

Evaluator

Raises:¶

NotImplementedError – If :paramref:vInit is set to True.

See also

See Hay et al. [2] for more information.