Package topo :: Package transferfn :: Module basic :: Class Hysteresis
[hide private]
[frames] | no frames]

Class Hysteresis

source code


Smoothly interpolates a matrix between simulation time steps, with exponential falloff.
Nested Classes [hide private]

Inherited from param.parameterized.Parameterized: __metaclass__

Instance Methods [hide private]
 
__init__(self, **params)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
__call__(self, x) source code
 
reset(self) source code
 
state_push(self)
Save this instance's state.
source code
 
state_pop(self)
Restore the most recently saved state.
source code

Inherited from TransferFnWithState: override_plasticity_state, restore_plasticity_state

Inherited from param.parameterized.Parameterized: __getstate__, __repr__, __setstate__, __str__, debug, defaults, force_new_dynamic_value, get_param_values, get_value_generator, inspect_value, message, print_param_values, script_repr, set_default, set_dynamic_time_fn, set_param, verbose, warning

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

Class Methods [hide private]

Inherited from param.parameterized.Parameterized: params, print_param_defaults

Class Variables [hide private]
  time_constant = param.Number(default= 0.3, doc= ...
Controls the time scale of the interpolation.
  name = <param.parameterized.String object at 0x95d8764>
String identifier for this object.

Inherited from TransferFnWithState: plastic

Inherited from base.functionfamily.TransferFn: norm_value

Inherited from param.parameterized.Parameterized: print_level

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, **params)
(Constructor)

source code 
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Overrides: object.__init__
(inherited documentation)

__call__(self, x)
(Call operator)

source code 
Overrides: base.functionfamily.TransferFn.__call__

state_push(self)

source code 

Save this instance's state.

For Parameterized instances, this includes the state of dynamically generated values.

Subclasses that maintain short-term state should additionally save and restore that state using state_push() and state_pop().

Generally, this method is used by operations that need to test something without permanently altering the objects' state.

Overrides: param.parameterized.Parameterized.state_push
(inherited documentation)

state_pop(self)

source code 

Restore the most recently saved state.

See state_push() for more details.

Overrides: param.parameterized.Parameterized.state_pop
(inherited documentation)

Class Variable Details [hide private]

time_constant

Controls the time scale of the interpolation.
Value:
param.Number(default= 0.3, doc= """
        Controls the time scale of the interpolation.""")