-
Notifications
You must be signed in to change notification settings - Fork 0
model_status.m
tools.model_status( stage, label, ... ) returns the model status ( done, incomplete, missing, or not ready ) for ViNERS for a given model step & output label. The part of the filename in (parentheses) is the label. If label is empty, any model output from that stage will do.
see also ViNERS folder structure overview
tools.model_status is part of package +tools
- axon_population (axons)
- nerve_anatomy (sensitivity or potential)
- membrane_currents (I_m)
- axon_sfap (sfap)
- axon_thresholds (threshold)
- nerve_stimulation (stim)
- nerve_recording (ENG)
- ECAP_recording (ECAP)
tools.model_status( stage, label, 'done' ) returns true/false depending on whether a certain stage has been completed.
Similarly, tools.model_status( stage, label, 'ready' ) returns true/false depending on whether the prerequisites for a certain stage have been met.
Be sure to set tools.file before running this to make sure you're working in the correct subject, sample, and run!
NOTE: for nerve_recording, the syntax is: tools.model_status(stage, waveType, label, ...). For a list of wave types, models.nerve_recording('-list')`. These differ in the underlying temporal pattern of simulated population activity. Also, tools.model_status is not guaranteed to be able to distinguish between an incomplete nerve_recording run and a nerve_recording run with non-standard parameters but should work for the default cases.
In general, if label is not set tools.model_status is less reliable. Specifically, it may not be fully able to determine whether output generation is 'incomplete' vs. 'done', but at no point will it mistake 'done' and 'not started', and it will return text after 'incomplete' which should be helpful.