boone.spike

Class SpikeSet

java.lang.Object

boone.PatternSet

boone.spike.SpikeSet

All Implemented Interfaces:

Storable, java.lang.Cloneable

public class SpikeSet
extends PatternSet

A spike set links lists of doubles to specific neurons. Each value in a list represents a point in the simulation time. There are three different types of lists in a spike set:

• Inputs: Each value in the list defines a point in the simulation time, at which the linked input neuron will emit a spike.
• Targets: Each value in the list defines a point in the simulation time, at which the linked output neuron is expected to emit a spike. The values in this list do not control the output of the specified neuron. Its intended use is to train a SpikingNeuralNet.
• Outputs: Each value in the list represents a point in the simulation time, at which the linked output neuron emitted a spike.

Use SpikingNeuralNet.setInput(SpikeSet) to set the network input to the input data of a given spike set. Use SpikingNeuron.record(SpikeSet, double, double) or SpikingNeuron.recordStart(SpikeSet) to record the output of a specific SpikingNeuron into a given spike set .

Version:

$Id: SpikeSet.java 2229 2014-11-06 jmory $

Author:

Johannes Mory

Field Summary

Fields inherited from class boone.PatternSet

filter, inputs, names, outputs, props, targets

Constructor Summary

Constructors

Constructor and Description
SpikeSet()

Method Summary

Modifier and Type	Method and Description
SpikeSet	clone() Returns a deep clone of the spike set.
java.util.List<java.lang.Double>	getInputSpikes(Neuron inputNeuron) Get the input of the specified input neuron.
java.util.List<java.lang.Double>	getOutputSpikes(Neuron outputNeuron) Get the output of the specified output neuron.
java.util.List<java.lang.Double>	getTargetSpikes(Neuron outputNeuron) Get the target values of the specified output neuron.
void	setInputSpikes(Neuron inputNeuron, java.util.List<java.lang.Double> input) Set the input for the specified input neuron.
void	setOutputSpikes(Neuron outputNeuron, java.util.List<java.lang.Double> output) Set the output for the specified output neuron.
void	setTargetSpikes(Neuron outputNeuron, java.util.List<java.lang.Double> target) Set the target values for the specified output neuron.

Methods inherited from class boone.PatternSet

addInput, fromXML, getFilter, getInput, getInputPatternSize, getInputs, getNames, getNextElement, getOutput, getOutputPatternSize, getOutputs, getProperties, getTarget, getTargetLabel, getTargetLabelCount, getTargetLabelOfPattern, getTargetPatternSize, getTargets, hasMoreElements, load, load, save, save, setFilter, setInputs, setProperties, setTargetLabel, setTargets, shuffle, size, toString, toXML, writeValues

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SpikeSet

public SpikeSet()

Method Detail

getInputSpikes

public java.util.List<java.lang.Double> getInputSpikes(Neuron inputNeuron)

Get the input of the specified input neuron. Each value in the list defines a point in the simulation time, at which the linked input neuron will emit a spike.

Parameters:

inputNeuron - the input neuron that will emit the spikes

Returns:

a list of doubles defining the points in the simulation time, at which the linked input neuron will emit a spike, or null if no input is linked to the specified input neuron

setInputSpikes

public void setInputSpikes(Neuron inputNeuron,
                           java.util.List<java.lang.Double> input)

Set the input for the specified input neuron. Each value in the list defines a point in the simulation time, at which the linked input neuron will emit a spike.

Parameters:

inputNeuron - the input neuron that will emit the spikes

input - a list of doubles defining the points in the simulation time, at which the linked input neuron will emit a spike, or null if no input is linked to the specified input neuron

getTargetSpikes

public java.util.List<java.lang.Double> getTargetSpikes(Neuron outputNeuron)

Get the target values of the specified output neuron. Each value in the list defines a point in the simulation time, at which the linked output neuron is expected to emit a spike. The values in this list do not control the output of the specified neuron. Its intended use is to train a SpikingNeuralNet.

Parameters:

outputNeuron - the output neuron that emits the spikes

Returns:

a list of doubles defining the points in the simulation time, at which the linked output neuron is expected to emit a spike, or null if no list is linked to the specified output neuron

setTargetSpikes

public void setTargetSpikes(Neuron outputNeuron,
                            java.util.List<java.lang.Double> target)

Set the target values for the specified output neuron. Each value in the list defines a point in the simulation time, at which the linked output neuron is expected to emit a spike. The values in this list do not control the output of the specified neuron. Its intended use is to train a SpikingNeuralNet.

Parameters:

outputNeuron - the output neuron that emits the spikes

target - a list of doubles defining the points in the simulation time, at which the linked output neuron is expected to emit a spike, or null if no list is linked to the specified output neuron

getOutputSpikes

public java.util.List<java.lang.Double> getOutputSpikes(Neuron outputNeuron)

Get the output of the specified output neuron. Each value in the list represents a point in the simulation time, at which the linked output neuron emitted a spike.

Parameters:

outputNeuron - the output neuron that emitted the spikes

Returns:

a list of doubles representing the points in the simulation time, at which the linked output neuron emitted a spike, or null if no output is linked to the specified neuron

setOutputSpikes

public void setOutputSpikes(Neuron outputNeuron,
                            java.util.List<java.lang.Double> output)

Set the output for the specified output neuron. Each value in the list represents a point in the simulation time, at which the linked output neuron emitted a spike.

Parameters:

outputNeuron - the output neuron that emitted the spikes

output - a list of doubles representing the points in the simulation time, at which the linked output neuron emitted a spike, or null if no output is linked to the specified neuron

clone

public SpikeSet clone()
               throws java.lang.CloneNotSupportedException

Returns a deep clone of the spike set.

Overrides:

clone in class PatternSet

Returns:

a clone

Throws:

java.lang.CloneNotSupportedException - should not happen