org.simbrain.network.neuron_update_rules.activity_generators

Class SinusoidalRule

java.lang.Object

org.simbrain.network.core.NeuronUpdateRule

org.simbrain.network.neuron_update_rules.activity_generators.SinusoidalRule

All Implemented Interfaces:

ActivityGenerator, BoundedUpdateRule

public class SinusoidalRule
extends NeuronUpdateRule
implements BoundedUpdateRule, ActivityGenerator

SinusoidalNeuron produces a sine wave; inputs are ignored. TODO: Input generator

Nested Class Summary

Nested classes/interfaces inherited from class org.simbrain.network.core.NeuronUpdateRule

NeuronUpdateRule.InputType

Field Summary

Fields inherited from class org.simbrain.network.core.NeuronUpdateRule

DEFAULT_INCREMENT, increment, inputType

Constructor Summary

Constructors

Constructor and Description
SinusoidalRule()

Method Summary

Modifier and Type	Method and Description
SinusoidalRule	deepCopy() Returns a deep copy of the update rule.
boolean	getAddNoise()
java.lang.String	getDescription() Returns a brief description of this update rule.
double	getFrequency()
double	getLowerBound() Returns the lower bound.
Randomizer	getNoiseGenerator()
double	getPhase()
double	getRandomValue() Returns a random value between the upper and lower bounds of this neuron.
Network.TimeType	getTimeType() Returns the type of time update (discrete or continuous) associated with this neuron.
double	getUpperBound() Returns the upper bound.
void	init(Neuron neuron) TODO: Doesn't feel like good API...
void	setAddNoise(boolean addNoise)
void	setFrequency(double frequency)
void	setLowerBound(double floor) Sets the lower bound of this neuron update rule's activation.
void	setNoiseGenerator(Randomizer noise)
void	setPhase(double phase)
void	setUpperBound(double ceiling) Sets the upper bound of this neuron update rule's activation.
void	update(Neuron neuron) Apply the update rule.

Methods inherited from class org.simbrain.network.core.NeuronUpdateRule

clear, contextualDecrement, contextualIncrement, decrementActivation, getDefaultIncrement, getGraphicalLowerBound, getGraphicalUpperBound, getIncrement, getInputType, getToolTipText, incrementActivation, isSkipsSynapticUpdates, isSpikingNeuron, setIncrement, setInputType

Methods inherited from class java.lang.Object

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

Constructor Detail

SinusoidalRule

public SinusoidalRule()

Method Detail

getTimeType

public Network.TimeType getTimeType()

Returns the type of time update (discrete or continuous) associated with this neuron.

Specified by:

getTimeType in class NeuronUpdateRule

Returns:

the time type

init

public void init(Neuron neuron)

TODO: Doesn't feel like good API... Used to set values of the neuron using this rule to accommodate this rule.

Specified by:

init in interface ActivityGenerator

deepCopy

public SinusoidalRule deepCopy()

Returns a deep copy of the update rule.

Specified by:

deepCopy in class NeuronUpdateRule

Returns:

Duplicated update rule

update

public void update(Neuron neuron)

Apply the update rule.

Specified by:

update in class NeuronUpdateRule

Parameters:

neuron - parent neuron

getNoiseGenerator

public Randomizer getNoiseGenerator()

Returns:

Random noise generator dialog.

setNoiseGenerator

public void setNoiseGenerator(Randomizer noise)

Parameters:

noise - The noise to set.

getAddNoise

public boolean getAddNoise()

Returns:

Returns the addNoise.

setAddNoise

public void setAddNoise(boolean addNoise)

Parameters:

addNoise - The addNoise to set.

getPhase

public double getPhase()

Returns:

Returns the upperValue.

setPhase

public void setPhase(double phase)

Parameters:

phase - The phase to set.

getFrequency

public double getFrequency()

Returns:

Returns the frequency.

setFrequency

public void setFrequency(double frequency)

Parameters:

frequency - The frequency to set.

getDescription

public java.lang.String getDescription()

Description copied from class: NeuronUpdateRule

Returns a brief description of this update rule. Used in combo boxes in the GUI.

Specified by:

getDescription in class NeuronUpdateRule

Returns:

the description.

setUpperBound

public void setUpperBound(double ceiling)

Description copied from interface: BoundedUpdateRule

Sets the upper bound of this neuron update rule's activation.

Specified by:

setUpperBound in interface BoundedUpdateRule

Parameters:

ceiling - the upper bound

setLowerBound

public void setLowerBound(double floor)

Description copied from interface: BoundedUpdateRule

Sets the lower bound of this neuron update rule's activation.

Specified by:

setLowerBound in interface BoundedUpdateRule

Parameters:

floor - the lower bound

getRandomValue

public double getRandomValue()

Description copied from class: NeuronUpdateRule

Returns a random value between the upper and lower bounds of this neuron. Update rules that require special randomization should override this method.

Overrides:

getRandomValue in class NeuronUpdateRule

Returns:

the random value.

getUpperBound

public double getUpperBound()

Description copied from interface: BoundedUpdateRule

Returns the upper bound.

Specified by:

getUpperBound in interface BoundedUpdateRule

Returns:

the upper boud

getLowerBound

public double getLowerBound()

Description copied from interface: BoundedUpdateRule

Returns the lower bound.

Specified by:

getLowerBound in interface BoundedUpdateRule

Returns:

the lower bound