boone.spike

Class Spike

java.lang.Object

boone.map.Function

boone.spike.Spike

All Implemented Interfaces:

Storable, java.lang.Cloneable

public class Spike
extends Function

This function is the default function that is used to describe the form of the spikes generated by a SpikingNeuron in a SpikingNeuralNet. The Spike function is the default activation function for a SpikingNeuron. By default a Spike describes the form of spikes of biological neurons and includes absolute and relative refractoriness phase.

Version:

$Id: Spike.java 2286 2015-08-04 jmory $

Author:

Johannes Mory

Nested Class Summary

Nested classes/interfaces inherited from class boone.map.Function

Function.AboutEqual, Function.AtLeast, Function.AtMost, Function.CatmullRomSpline, Function.Clip, Function.Composition, Function.Exponential, Function.GreaterThan, Function.Identity, Function.LessThan, Function.NaturalSpline, Function.NotImplemented, Function.ReLU, Function.Scaled, Function.Sigmoid, Function.Signum, Function.SignumWithoutZero, Function.Sinus, Function.SoftMax, Function.Spline, Function.TanH

Constructor Summary

Constructors

Constructor and Description
Spike() Create a new Spike, with defaults for the parameters.
Spike(double abs, double absDur, double rel, double relDur) Create a new Spike, with the specified parameter values.

Method Summary

Modifier and Type	Method and Description
Spike	clone() Return a deep copy of this object.
boolean	equals(java.lang.Object other)
void	fromXML(org.jdom2.Element element) Reads attributes from XML tree.
double	getAbsDur() Returns the absolute refractory period.
double	getMaxValue() Return the duration of the absolute refractoriness phase.
double	getMinValue() Return the smallest possible function value.
double	getRelDur() Returns the relative refractory period.
double	map(double s) Map a value through the function.
double	mapDerivative(double s) Map a value through the first derivative of this function.
void	setAbsDur(double absDur) Sets the absolute refractory period.
void	setRelDur(double relDur) Sets the relative refractory period.
org.jdom2.Element	toXML(org.jdom2.Element element) Writes specific attributes to XML tree.

Methods inherited from class boone.map.Function

create, mapSecondDerivative, setParameters

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Spike

public Spike()

Create a new Spike, with defaults for the parameters. The defaults generate a function that describes the form of spikes of biological neurons.

Spike

public Spike(double abs,
             double absDur,
             double rel,
             double relDur)

Create a new Spike, with the specified parameter values.

Parameters:

abs - the maximum value the neuron potential is above its resting potential during the absolute refractoriness phase

absDur - the duration of the absolute refractoriness phase in milliseconds

rel - the maximum value the neuron potential is below its resting potential during the relative refractoriness phase

relDur - factor that defines the duration of the relative refractoriness phase

Method Detail

getAbsDur

public double getAbsDur()

Returns the absolute refractory period.

Returns:

the period [ms]

setAbsDur

public void setAbsDur(double absDur)

Sets the absolute refractory period.

Parameters:

absDur - the period [ms]

getRelDur

public double getRelDur()

Returns the relative refractory period.

Returns:

the period [ms]

setRelDur

public void setRelDur(double relDur)

Sets the relative refractory period.

Parameters:

relDur - the period [ms]

map

public double map(double s)

Description copied from class: Function

Map a value through the function.

Overrides:

map in class Function

mapDerivative

public double mapDerivative(double s)

Description copied from class: Function

Map a value through the first derivative of this function.

Overrides:

mapDerivative in class Function

getMinValue

public double getMinValue()

Description copied from class: Function

Return the smallest possible function value. If no exact value can be produced easily, this should return an estimation (lower bound).

Specified by:

getMinValue in class Function

Returns:

the minimum function result.

getMaxValue

public double getMaxValue()

Return the duration of the absolute refractoriness phase.

Specified by:

getMaxValue in class Function

Returns:

the maximum function result.

fromXML

public void fromXML(org.jdom2.Element element)

Description copied from interface: Storable

Reads attributes from XML tree.

Specified by:

fromXML in interface Storable

Overrides:

fromXML in class Function

Parameters:

element - a JDOM element

toXML

public org.jdom2.Element toXML(org.jdom2.Element element)

Writes specific attributes to XML tree.

Specified by:

toXML in interface Storable

Overrides:

toXML in class Function

Parameters:

element - the parent element

Returns:

the function element

clone

public Spike clone()

Description copied from class: Function

Return a deep copy of this object. By default, just calls super.clone().

Overrides:

clone in class Function

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object