ca.nengo.model.impl
Class NoiseFactory.NoiseImplPDF

java.lang.Object
  extended by ca.nengo.model.impl.NoiseFactory.NoiseImplPDF
All Implemented Interfaces:
Noise, Resettable, java.io.Serializable, java.lang.Cloneable
Enclosing class:
NoiseFactory

public static class NoiseFactory.NoiseImplPDF
extends java.lang.Object
implements Noise

Note: setters are private, because Origins typically make copies for each output dimension, which would then not be updated with changes to the original. So to change noise properties the Noise object must be replaced.

Author:
Bryan Tripp
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface ca.nengo.model.Noise
Noise.Noisy
 
Field Summary
 
Fields inherited from interface ca.nengo.model.Noise
DIMENSION_PROPERTY
 
Constructor Summary
NoiseFactory.NoiseImplPDF(float frequency, PDF pdf, DynamicalSystem dynamics, Integrator integrator)
           
 
Method Summary
 Noise clone()
           
 DynamicalSystem getDynamics()
           
 float getFrequency()
           
 Integrator getIntegrator()
           
 PDF getPDF()
           
 float getValue(float startTime, float endTime, float input)
           
 void reset(boolean randomize)
           
 void setFrequency(float frequency)
           
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NoiseFactory.NoiseImplPDF

public NoiseFactory.NoiseImplPDF(float frequency,
                                 PDF pdf,
                                 DynamicalSystem dynamics,
                                 Integrator integrator)
Parameters:
frequency - Frequency (in simulation time) with which new noise values are drawn from the PDF
pdf - PDF from which new noise values are drawn. The dimension of the space over which the PDF is defined must equal the input dimension of the dynamics.
dynamics - Dynamics through which raw noise values pass before they are combined with non-noise. The input dimension must match the PDF and the output dimension must equal one. Can be null in which case the PDF must be one-dimensional.
integrator - Integrator used to solve dynamics. Can be null if dynamics is null.
Method Detail

getFrequency

public float getFrequency()
Returns:
Frequency (in simulation time) with which new noise values are drawn from the PDF

setFrequency

public void setFrequency(float frequency)
Parameters:
frequency - Frequency (in simulation time) with which new noise values are drawn from the PDF

getPDF

public PDF getPDF()
Returns:
PDF from which new noise values are drawn. The dimension of the space over which the PDF is defined must equal the input dimension of the dynamics.

getDynamics

public DynamicalSystem getDynamics()
Returns:
Dynamics through which raw noise values pass before they are combined with non-noise. The input dimension must match the PDF and the output dimension must equal one. Can be null in which case the PDF must be one-dimensional.

getIntegrator

public Integrator getIntegrator()
Returns:
Integrator used to solve dynamics. Can be null if dynamics is null.

getValue

public float getValue(float startTime,
                      float endTime,
                      float input)
Specified by:
getValue in interface Noise
Parameters:
startTime - Simulation time at which step starts
endTime - Simulation time at which step ends
input - Value which is to be corrupted by noise
Returns:
The noisy values (inputs corrupted by noise)
See Also:
Noise.getValue(float, float, float)

clone

public Noise clone()
Specified by:
clone in interface Noise
Overrides:
clone in class java.lang.Object

reset

public void reset(boolean randomize)
Specified by:
reset in interface Resettable
Parameters:
randomize - True indicates that the object should be reset to a randomly selected initial state (the object must be aware of the distribution from which to draw from). False indicates that the object should be reset to a fixed initial state (which it must also know). Some objects may not support randomization of the initial state, in which case a fixed state will be used in either case.
See Also:
Resettable.reset(boolean)