Rename classes
finsberg opened this issue · 1 comments
finsberg commented
Based on suggestion from suggested by @nforsch we could implement the following abstract classes (i.e classes that cannot be instantiated)
Single
andMulti
- This refer to the number of measurements / parameter sets.
Single
is only one measurement
- This refer to the number of measurements / parameter sets.
State
andStates
- This refer to the number of states (e.g voltage, calcium).
State
is only one state.
- This refer to the number of states (e.g voltage, calcium).
Beat
andBeats
- This refer to the number of beats.
Beat
is just a single beat. Beat
should contain all the methods that we could use to analyze a beatBeats
should contain methods likebeatrate
,chop
,num_beats
- There should also be some pointer to the parent
Beats
fromBeat
so that we can compute features such as the corrected APD (cAPD)
- This refer to the number of beats.
Then we implement the following classes using multiple inheritance
SingleStateBeat
: e.g one beat of voltage and one parameter setMultiStateBeat
: e.g one beat of voltage and multiple parameter setsSingleStateBeats
: e.g multiple beats of voltage and one parameter setMultiStateBeats
: e.g multiple beats of voltage and multiple parameter setsSingleStatesBeat
: e.g one beat of voltage and calcium (or more states), and one parameter setMultiStatesBeat
: e.g one beat of voltage and calcium (or more states), and multiple parameter setsSingleStatesBeats
: e.g mutiple beats of voltage and calcium (or more states), and one parameter setMultiStatesBeats
: e.g multiple beats of voltage and calcium (or more states), and multiple parameter sets
Whether multiple inheritance is the way to go, I am not sure, but I like this naming convention.
finsberg commented
I don't think we want to fix this one