carputils.model.stimulus.Stimulus Class Reference

Represents a single stimulus argument to openCARP. More...

Inheritance diagram for carputils.model.stimulus.Stimulus:

Public Member Functions
def	__init__ (self, name=None, kwargs)
def	opts_formatted (self, index)
def	forced_foot (cls, act_sequence=None, pulse_file=None)
	Create a forced foot stimulus using a pulse file. More...
def	forced_foot_exponential (cls, act_sequence=None)
	Create a forced foot stimulus with an exponential shape. More...
Public Member Functions inherited from carputils.model.general.AbstractModelComponent
def	__init__ (self, fields)
def	opts (self)
	Generator that yields field name - value pairs for the command line. More...
def	opts_formatted (self, index)
	Return the command line options for this model component. More...

Static Public Attributes
string	PRM_ARRAY = 'stim'
string	PRM_LENGTH = 'num_stim'
list	FIELDS
Static Public Attributes inherited from carputils.model.general.AbstractModelComponent
	PRM_ARRAY = None
	PRM_LENGTH = None
list	FIELDS = []

Detailed Description

Represents a single stimulus argument to openCARP.

Parameters

name	str, optional A short descriptive name for this stimulus **kwargs The remaining fields for the stimulus

Constructor & Destructor Documentation

__init__()

def carputils.model.stimulus.Stimulus.__init__	(		self,
			name = None,
			kwargs
	)

Member Function Documentation

forced_foot()

def carputils.model.stimulus.Stimulus.forced_foot	(		cls,
			act_sequence = None,
			pulse_file = None
	)

Create a forced foot stimulus using a pulse file.

Parameters

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

forced_foot_exponential()

def carputils.model.stimulus.Stimulus.forced_foot_exponential	(		cls,
			act_sequence = None
	)

Create a forced foot stimulus with an exponential shape.

Parameters

act_sequence

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

opts_formatted()

def carputils.model.stimulus.Stimulus.opts_formatted	(		self,
			index
	)

Member Data Documentation

FIELDS

list carputils.model.stimulus.Stimulus.FIELDS

static

Initial value:

=  ['name', 'elec.vtx_file', 'elec.vtx_fcn', 'elec.dump_vtx_file', 'elec.p1', 'elec.p0',
              'elec.geom_type', 'elec.geomID', 'elec.radius', 'ptcl.start', 'ptcl.bcl', 'ptcl.npls',
              'ptcl.stimlist', 'ptcl.name', 'ptcl.duration', 'pulse.strength', 'pulse.s2',
              'pulse.tau_edge', 'pulse.tilt_ampl', 'pulse.tilt_time', 'pulse.file', 'pulse.shape',
              'pulse.name', 'pulse.tau_plateau', 'pulse.bias', 'crct.type', 'crct.total_current',
              'crct.balance', 'crct.total_current', 'elec.domain']

PRM_ARRAY

string carputils.model.stimulus.Stimulus.PRM_ARRAY = 'stim'

static

PRM_LENGTH

string carputils.model.stimulus.Stimulus.PRM_LENGTH = 'num_stim'

static

---

The documentation for this class was generated from the following file:

• carputils/model/stimulus.py