ca.nengo.model.impl
Class NoiseFactory

java.lang.Object
  extended by ca.nengo.model.impl.NoiseFactory

public class NoiseFactory
extends java.lang.Object

Default additive Noise implementations. TODO: unit tests

Author:
Bryan Tripp

Nested Class Summary
static class NoiseFactory.NoiseImplFunction
          Note: there are no public setters here for the same reason as in NoiseImplPDF.
static class NoiseFactory.NoiseImplNull
           
static class NoiseFactory.NoiseImplPDF
          Note: setters are private, because Origins typically make copies for each output dimension, which would then not be updated with changes to the original.
 
Constructor Summary
NoiseFactory()
           
 
Method Summary
static void main(java.lang.String[] args)
           
static Noise makeExplicitNoise(Function function)
           
static Noise makeNullNoise()
           
static Noise makeRandomNoise(float frequency, PDF pdf)
           
static Noise makeRandomNoise(float frequency, PDF pdf, DynamicalSystem dynamics, Integrator integrator)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NoiseFactory

public NoiseFactory()
Method Detail

makeRandomNoise

public static Noise makeRandomNoise(float frequency,
                                    PDF pdf)
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 must equal the input dimension of the dynamics.

makeRandomNoise

public static Noise makeRandomNoise(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 must equal the input dimension of the dynamics.
dynamics - Dynamics through which raw noise values pass before they are combined with non-noise. The output dimension must equal the dimension of expected input to getValues().
integrator - Integrator used to solve dynamics

makeNullNoise

public static Noise makeNullNoise()
Returns:
Zero additive Noise

makeExplicitNoise

public static Noise makeExplicitNoise(Function function)
Parameters:
function - A function of time
Returns:
Additive Noise where values are given explicit functions of time

main

public static void main(java.lang.String[] args)