carputils.model.Stimulus

class carputils.model.Stimulus(name=None, **kwargs)

Represents a single stimulus argument to openCARP.

Args:

name : str, optional

A short descriptive name for this stimulus

**kwargs

The remaining fields for the stimulus

classmethod forced_foot(act_sequence=None, pulse_file=None)

Create a forced foot stimulus using a pulse file.

Args:

act_sequence : str, optional

Path of the activation sequence to use for the stimulus - if not given will be computed

pulse_file : str, optional

Path of the trace to use to prescribe the foot, without .trc extension - a sensible default is used if not given

classmethod forced_foot_exponential(act_sequence=None)

Create a forced foot stimulus with an exponential shape.

Args:

act_sequence : str, optional

Path of the activation sequence to use for the stimulus - if not given will be computed

opts_formatted(index)

Return the command line options for this model component.

index : int

The array index to use in generating the option list