Package topo :: Package transferfn :: Module misc :: Class AttributeTrackingTF
[hide private]
[frames] | no frames]

Class AttributeTrackingTF

source code


Keeps track of attributes of a specified Parameterized over time, for analysis or plotting.

Useful objects to track include sheets (e.g. "topo.sim['V1']"), projections ("topo.sim['V1'].projections['LateralInhibitory']"), or an output_function.

Any attribute whose value is a matrix the same size as the activity matrix can be tracked. Only specified units within this matrix will be tracked.

If no object is specified, this function will keep track of the incoming activity over time.

The results are stored in a dictionary named 'values', as (time, value) pairs indexed by the parameter name and unit. For instance, if the value of attribute 'x' is v for unit (0.0,0.0) at time t, values['x'][(0.0,0.0)]=(t,v).

Updating of the tracked values can be disabled temporarily using the plastic parameter.

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

Inherited from basic.TransferFnWithState: override_plasticity_state, restore_plasticity_state, state_pop, state_push

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]
  object = param.Parameter(default= None, doc= ...
Parameterized instance whose parameters will be tracked.
  attrib_names = param.List(default= [], doc= ...
List of names of the function object's parameters that should be stored.
  units = param.List(default= [(0.0, 0.0)], doc= ...
Sheet coordinates of the unit(s) for which parameter values will be stored.
  step = param.Number(default= 1, doc= ...
How often to update the tracked values.
  coordframe = param.Parameter(default= None, doc= ...
The SheetCoordinateSystem to use to convert the position into matrix coordinates.
  name = <param.parameterized.String object at 0xb5898ec>
String identifier for this object.

Inherited from basic.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__

Class Variable Details [hide private]

object

Parameterized instance whose parameters will be tracked.

If this parameter's value is a string, it will be evaluated first (by calling Python's eval() function). This feature is designed to allow circular references, so that the OF can track the object that owns it, without causing problems for recursive traversal (as for script_repr()).

Value:
param.Parameter(default= None, doc= """
        Parameterized instance whose parameters will be tracked.

        If this parameter's value is a string, it will be evaluated first
        (by calling Python's eval() function).  This feature is designed to
        allow circular references, so that the OF can track the object that
        owns it, without causing problems for recursive traversal (as for
        script_repr()).""")

attrib_names

List of names of the function object's parameters that should be stored.
Value:
param.List(default= [], doc= """
        List of names of the function object's parameters that should be stored.""\
")

units

Sheet coordinates of the unit(s) for which parameter values will be stored.
Value:
param.List(default= [(0.0, 0.0)], doc= """
        Sheet coordinates of the unit(s) for which parameter values will be stored\
.""")

step

How often to update the tracked values.

For instance, step=1 means to update them every time this OF is called; step=2 means to update them every other time.

Value:
param.Number(default= 1, doc= """
        How often to update the tracked values.

        For instance, step=1 means to update them every time this OF is
        called; step=2 means to update them every other time.""")

coordframe

The SheetCoordinateSystem to use to convert the position into matrix coordinates. If this parameter's value is a string, it will be evaluated first(by calling Python's eval() function). This feature is designed to allow circular references, so that the OF can track the object that owns it, without causing problems for recursive traversal (as for script_repr()).
Value:
param.Parameter(default= None, doc= """
        The SheetCoordinateSystem to use to convert the position
        into matrix coordinates. If this parameter's value is a string,
        it will be evaluated first(by calling Python's eval() function).
        This feature is designed to allow circular references,
        so that the OF can track the object that
        owns it, without causing problems for recursive traversal (as for
        script_repr()).""")