2.1.1.4. RestingPotential¶
-
class
RestingPotential
(observation={'mean': None, 'std': None}, name='Resting Membrane Potential Test')[source]¶ Bases:
sciunit.tests.Test
Test the cell’s resting membrane potential
- Parameters
score_type (<class 'sciunit.scores.complete.ZScore'>) –
description (Test the cell's resting membrane potential) –
observation (
typing.Dict
[str
,float
]) –name (
str
) –
Attributes Summary
brief description of the test objective
Methods Summary
compute_score
(observation, prediction[, verbose])Generates a score given the observations provided in the constructor and the prediction generated by generate_prediction.
generate_prediction
(model[, verbose])Generate a prediction from a model using the required capabilities.
validate_observation
(observation)Validate the observation provided to the constructor.
Attributes Documentation
-
description
: str = "Test the cell's resting membrane potential"¶ brief description of the test objective
Methods Documentation
-
compute_score
(observation, prediction, verbose=False)[source]¶ Generates a score given the observations provided in the constructor and the prediction generated by generate_prediction.
Must generate a score of score_type. No default implementation.
- Parameters
observation (
typing.Dict
[str
,float
]) –prediction (
float
) –verbose (
bool
) –
- Return type
sciunit.scores.complete.ZScore