org.simbrain.util.environment

Class SmellSource

java.lang.Object

org.simbrain.util.environment.SmellSource

public class SmellSource
extends java.lang.Object

Stimulus represent a distal stimulus in the form of a vector. It can have noise added and has built in functions to compute decay. Standardly these objects represent "distal stimuli" relative to an organism.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SmellSource.DecayFunction Decay Functions.

Constructor Summary

Constructors

Constructor and Description
SmellSource() Default constructor.
SmellSource(double[] distalstim) Construct a smell source from a specified stimulus vector, using defaults otherwise.
SmellSource(double[] distalstim, SmellSource.DecayFunction decay, double[] location) Construct smell source from specified parameters.
SmellSource(double[] distalstim, SmellSource.DecayFunction decay, double disp, boolean addNoise, double noiseLevel) Construct smell source from specified parameters.
SmellSource(double[] distalstim, SmellSource.DecayFunction decay, double dispersion, double[] location) Construct smell source from specified parameters.
SmellSource(int numDimensions) Construct a smell source with a specified number of dimensions, randomly initialized.

Method Summary

Modifier and Type	Method and Description
SmellSource.DecayFunction	getDecayFunction()
double	getDispersion() Return the dispersion.
double[]	getLocation()
void	getLocation(double[] location) Return location of this smell source.
double	getNoiseLevel() Return the noise level.
double	getPeak()
double[]	getStimulus(double distance) Calculate what impact the object will have on the creature's receptors (input nodes) based on its distance from this object and its features (whether it is a "noisy object", and how the stimulus decays).
double	getStimulus(int dimension, double distance) Calculate what impact the object will have on the creature's receptors (input nodes) based on its distance from this object and its features (whether it is a "noisy object", and how the stimulus decays).
int	getStimulusDimension() Return the number of dimensions in the stimulus vector.
java.lang.String	getStimulusString() Return the stimulus string.
double[]	getStimulusVector() Return the stimulus vector.
ComboBoxWrapper	getTheDecayFunction()
boolean	isAddNoise() Return add noise.
void	randomize() Randomize values.
void	setAddNoise(boolean b) Sets the add noise.
void	setDecayFunction(SmellSource.DecayFunction decayFunction)
void	setDispersion(double d) Sets the dispersion.
void	setLocation(double[] location) Set the location of this smell source.
void	setNoiseLevel(double d) Sets the noise level.
void	setPeak(double peak)
void	setStimulusS(java.lang.String vectorString) Sets the stimulus string.
void	setStimulusVector(double[] newStim) Sets the stimulus vector.
void	setTheDecayFunction(ComboBoxWrapper decayFunctionBox)
void	update() Update the source.

Methods inherited from class java.lang.Object

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

Constructor Detail

SmellSource

public SmellSource(double[] distalstim,
                   SmellSource.DecayFunction decay,
                   double disp,
                   boolean addNoise,
                   double noiseLevel)

Construct smell source from specified parameters.

Parameters:

distalstim - Distal stimulus

decay - Decay rate

disp - Dispersion

addNoise - Add noise

noiseLevel - Level of noise

SmellSource

public SmellSource(double[] distalstim,
                   SmellSource.DecayFunction decay,
                   double dispersion,
                   double[] location)

Construct smell source from specified parameters.

Parameters:

distalstim - stimulus vector

decay - decay function

dispersion - level of dispersion

location - location of smell source

SmellSource

public SmellSource(double[] distalstim,
                   SmellSource.DecayFunction decay,
                   double[] location)

Construct smell source from specified parameters.

Parameters:

distalstim - stimulus vector

decay - decay function

location - location of smell source

SmellSource

public SmellSource(double[] distalstim)

Construct a smell source from a specified stimulus vector, using defaults otherwise.

Parameters:

distalstim - the stimulus vector

SmellSource

public SmellSource(int numDimensions)

Construct a smell source with a specified number of dimensions, randomly initialized.

Parameters:

numDimensions - number of dimensions of the stimulus vector.

SmellSource

public SmellSource()

Default constructor.

Method Detail

randomize

public void randomize()

Randomize values.

getStimulusDimension

public int getStimulusDimension()

Return the number of dimensions in the stimulus vector.

Returns:

the dimension of the stimulus

setStimulusVector

public void setStimulusVector(double[] newStim)

Sets the stimulus vector.

Parameters:

newStim - New stimulus

getStimulusVector

public double[] getStimulusVector()

Return the stimulus vector.

Returns:

the stimulus vector

isAddNoise

public boolean isAddNoise()

Return add noise.

Returns:

add noise

getStimulusString

public java.lang.String getStimulusString()

Return the stimulus string.

Returns:

the stimulus string

setStimulusS

public void setStimulusS(java.lang.String vectorString)

Sets the stimulus string.

Parameters:

vectorString - Stimulus string

getNoiseLevel

public double getNoiseLevel()

Return the noise level.

Returns:

the noise level

setAddNoise

public void setAddNoise(boolean b)

Sets the add noise.

Parameters:

b - the add noise

setNoiseLevel

public void setNoiseLevel(double d)

Sets the noise level.

Parameters:

d - Noise level

setDispersion

public void setDispersion(double d)

Sets the dispersion.

Parameters:

d - Dispersion

getDispersion

public double getDispersion()

Return the dispersion.

Returns:

the dispersion

getStimulus

public double[] getStimulus(double distance)

Calculate what impact the object will have on the creature's receptors (input nodes) based on its distance from this object and its features (whether it is a "noisy object", and how the stimulus decays). That is, calculate the proximal stimulus this distal stimulus gives rise to.

Parameters:

distance - distance of creature from object

Returns:

proximal stimulus to creature caused by this object

update

public void update()

Update the source.

getStimulus

public double getStimulus(int dimension,
                          double distance)

Calculate what impact the object will have on the creature's receptors (input nodes) based on its distance from this object and its features (whether it is a "noisy object", and how the stimulus decays). That is, calculate the proximal stimulus this distal stimulus gives rise to.

Parameters:

dimension -

distance - distance of creature from object

Returns:

proximal stimulus to creature caused by this object

getPeak

public double getPeak()

Returns:

Returns the peak.

setPeak

public void setPeak(double peak)

Parameters:

peak - The peak to set.

getDecayFunction

public SmellSource.DecayFunction getDecayFunction()

Returns:

the decayFunction

setDecayFunction

public void setDecayFunction(SmellSource.DecayFunction decayFunction)

Parameters:

decayFunction - the decayFunction to set

getLocation

public double[] getLocation()

Returns:

the location

getLocation

public void getLocation(double[] location)

Return location of this smell source.

Parameters:

location - the location to set

setLocation

public void setLocation(double[] location)

Set the location of this smell source.

Parameters:

location -

getTheDecayFunction

public ComboBoxWrapper getTheDecayFunction()

Returns:

the imageBox

setTheDecayFunction

public void setTheDecayFunction(ComboBoxWrapper decayFunctionBox)

Parameters:

decayFunctionBox -