Home       Trees       Indices       Help   
PyDSTool
Package PyDSTool :: Module Events :: Class Event
[hide private]
[frames] | no frames]

Class Event

source code

object --+
         |
        Event
Known Subclasses:
Generic Event.

Possible keys in argument dictionary at initialization:
    name, eventtol, eventdelay, starttime, bisectlimit, term, active,
    precise, vars, expr.
Instance Methods [hide private]
 
__init__(self, kw)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature		 source code
 
addToQ(self, qname, item) source code
 
createQ(self, qname, sorted=True, seq=None)
Also use to reset a queue.		 source code
 
popFromQ(self, qname) source code
 
deleteQ(self, qname) source code
 
_infostr(self, verbose=1) source code
 
info(self, verboselevel=1) source code
 
__repr__(self)
str(x)		 source code
 
__str__(self)
str(x)		 source code
 
addMethods(self) source code
 
reset(self, state=None)
Reset event`s prevsign attribute to a certain state (defaults to None)		 source code
 
__call__(self, t=None, varDict=None, parDict=None)
Report on correct sign change.		 source code
 
searchForEvents(self, trange=None, dt=None, checklevel=2, parDict=None, vars=None, inputs=None, abseps=1e-13, eventdelay=True, globalt0=0)
Search a variable-linked event, or an event with supplied vars dictionary and relevant parameters, for zero crossings.		 source code
 
contains(self, interval, val, checklevel=2) source code
 
__getstate__(self) source code
 
__setstate__(self, state) source code
 
__copy__(self) source code
 
__deepcopy__(self, memo=None, _nil=[]) source code

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, kw)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)

__repr__(self)
(Representation operator)

source code 

str(x)

Overrides: object.__repr__
(inherited documentation)

__str__(self)
(Informal representation operator)

source code 

str(x)

Overrides: object.__str__
(inherited documentation)

__call__(self, t=None, varDict=None, parDict=None)
(Call operator)

source code 

Report on correct sign change. For external inputs, add input names and vales at time t to parDict

searchForEvents(self, trange=None, dt=None, checklevel=2, parDict=None, vars=None, inputs=None, abseps=1e-13, eventdelay=True, globalt0=0)

source code  
Search a variable-linked event, or an event with supplied vars
dictionary and relevant parameters, for zero crossings.

(Variable-linked search not applicable to low level events.)

trange=None, dt=None, checklevel=2, parDict=None, vars=None, inputs=None,
    abseps=1e-13, eventdelay=True -> (ev_t, (ev_tlo, ev_thi))
where the lo-hi tuple is the smallest bound around ev_t (in
case it is None because event was not found accurately).

dt will default to 1e-3 * the time interval of the variables.
'eventinterval' inherited from the event will be used to separate
detected events.

Only pass vars dictionary when event.varlinked is False.

   Home       Trees       Indices       Help   
PyDSTool
Generated by Epydoc 3.0.1 on Sun Dec 2 23:44:19 2012 http://epydoc.sourceforge.net