qubx :: data_types :: StimulusRecord :: Class StimulusRecord
[hide private]
[frames] | no frames]

Class StimulusRecord

source code

     object --+    
              |    
util_types.Anon --+
                  |
                 StimulusRecord

Describes how to find and idealize the time course of a model variable. It can be constant, an analog signal, or an expression in terms of segment index, time since seg-start, and named analog signals. Read-only please. You are more likely to encounter a qubx.table.TableRow with the same fields.

Instance Methods [hide private]
 
__init__(self, name, stim_type=0, signal_index=None, expr='0', latency_ms=0.0, shaping='', known_amps=[0.0], add_deltas=True, delta=0.5, min_dur_ms=1.0, expr_index=None, active=True)
x.__init__(...) initializes x; see help(type(x)) for signature
source code

Inherited from util_types.Anon: __getattr__, __repr__, __str__, clone

Inherited from util_types.Anon (private): _find_arg_dicts, _str_indent

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Instance Variables [hide private]
  Add_deltas
whether to add more stimulus levels when idealizing
  Delta_amp
minimum difference between added levels
  Expr
f(seg, t[, signalname[0], signalname[1], ...]) -> float, if stim_type == STIM_TYPE_EXPR
  Known_amps
list of known stimulus levels for idealization
  Latency
[ms] milliseconds of delay to add
  Min_dur
[ms] events any shorter are subsumed by their neighbor
  Name
the model variable e.g.
  Shaping
name of a shaping plugin
  Signal_index
index in dataview.signals, if stim_type == STIM_TYPE_SIGNAL
  Type
STIM_TYPE_CONST, STIM_TYPE_SIGNAL, or STIM_TYPE_EXPR
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, name, stim_type=0, signal_index=None, expr='0', latency_ms=0.0, shaping='', known_amps=[0.0], add_deltas=True, delta=0.5, min_dur_ms=1.0, expr_index=None, active=True)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

Instance Variable Details [hide private]

Name

the model variable e.g. 'Voltage'