ca.nengo.model

Interface Origin

All Superinterfaces:

java.lang.Cloneable, java.io.Serializable

All Known Subinterfaces:

Decoder

All Known Implementing Classes:

BasicDecoder, BasicOrigin, BiasOrigin, DecodedOrigin, EnsembleOrigin, NetworkArrayImpl.ArrayOrigin, NetworkImpl.OriginWrapper, ProbeableOrigin, SpikeGeneratorOrigin

public interface Origin
extends java.io.Serializable, java.lang.Cloneable

An source of information in a circuit model. Origins arise from Ensembles, ExternalInputs, and individual Neurons (although the latter Origins are mainly used internally within Ensembles, ie an Ensemble typically combines Neuron Origins into Ensemble Origins).

An Origin object will often correspond loosely to the anatomical origin of a neural projection in the brain. However, there is not a strict correspondance. In particular, an Origin object may relate specifically to a particular decoding of activity in an Ensemble. For example, suppose a bundle of axons bifurcates and terminates in two places. This would be modelled with two Origin objects if the postsynaptic Ensembles received different functions of the variables represented by the presynaptic Ensemble. So, an Origin is best thought about as a source of information in a certain form, rather than an anatomical source of axons.

Method Summary

Methods

Modifier and Type	Method and Description
Origin	clone()
Origin	clone(Node node) Clone method that changes necessary parameters to point to a new parent, for use in cloning ensembles, etc.
int	getDimensions()
java.lang.String	getName()
Node	getNode()
boolean	getRequiredOnCPU()
InstantaneousOutput	getValues()
void	setRequiredOnCPU(boolean val)
void	setValues(InstantaneousOutput val)

Method Detail

getName

java.lang.String getName()

Returns:

Name of this Origin (unique in the scope of a source of Origins, eg a Neuron or Ensemble)

getDimensions

int getDimensions()

Returns:

Dimensionality of information coming from this Origin (eg number of axons, or dimension of decoded function of variables represented by the Ensemble)

getValues

InstantaneousOutput getValues()
                              throws SimulationException

Returns:

Instantaneous output from this Origin.

Throws:

SimulationException - if there is any problem retrieving values

setValues

void setValues(InstantaneousOutput val)

Parameters:

Instantaneous - output from this Origin.

setRequiredOnCPU

void setRequiredOnCPU(boolean val)

getRequiredOnCPU

boolean getRequiredOnCPU()

getNode

Node getNode()

Returns:

The Node to which the Origin belongs

clone

Origin clone()
             throws java.lang.CloneNotSupportedException

Returns:

Valid clone

Throws:

java.lang.CloneNotSupportedException - if clone cannot be made

clone

Origin clone(Node node)
             throws java.lang.CloneNotSupportedException

Clone method that changes necessary parameters to point to a new parent, for use in cloning ensembles, etc.

Parameters:

e - New parent ensemble

Returns:

A clone of the origin for the new parent ensemble

Throws:

java.lang.CloneNotSupportedException - if clone cannot be made