You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Doc_BoxAlgorithm_NoiseGenerator.dox-part 2.4KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. /**
  2. * \page BoxAlgorithm_NoiseGenerator Noise generator
  3. __________________________________________________________________
  4. Detailed description
  5. __________________________________________________________________
  6. * |OVP_DocBegin_BoxAlgorithm_NoiseGenerator_Description|
  7. * The Noise Generator outputs random signals with a configurable number of channels. The sampling frequency and epoch size can be configured as well. The data is sampled from a pseudorandom distribution.
  8. * |OVP_DocEnd_BoxAlgorithm_NoiseGenerator_Description|
  9. __________________________________________________________________
  10. Outputs description
  11. __________________________________________________________________
  12. * |OVP_DocBegin_BoxAlgorithm_NoiseGenerator_Outputs|
  13. * |OVP_DocEnd_BoxAlgorithm_NoiseGenerator_Outputs|
  14. * |OVP_DocBegin_BoxAlgorithm_NoiseGenerator_Output1|
  15. * Random signal generated.
  16. * |OVP_DocEnd_BoxAlgorithm_NoiseGenerator_Output1|
  17. __________________________________________________________________
  18. Settings description
  19. __________________________________________________________________
  20. * |OVP_DocBegin_BoxAlgorithm_NoiseGenerator_Settings|
  21. * |OVP_DocEnd_BoxAlgorithm_NoiseGenerator_Settings|
  22. * |OVP_DocBegin_BoxAlgorithm_NoiseGenerator_Setting1|
  23. * Number of channels generated.
  24. * |OVP_DocEnd_BoxAlgorithm_NoiseGenerator_Setting1|
  25. * |OVP_DocBegin_BoxAlgorithm_NoiseGenerator_Setting2|
  26. * Sampling frequency of generated signals.
  27. * |OVP_DocEnd_BoxAlgorithm_NoiseGenerator_Setting2|
  28. * |OVP_DocBegin_BoxAlgorithm_NoiseGenerator_Setting3|
  29. * Number of samples per epoch
  30. * |OVP_DocEnd_BoxAlgorithm_NoiseGenerator_Setting3|
  31. * |OVP_DocBegin_BoxAlgorithm_NoiseGenerator_Setting4|
  32. * Noise type (used distribution)
  33. * |OVP_DocEnd_BoxAlgorithm_NoiseGenerator_Setting4|
  34. __________________________________________________________________
  35. Miscellaneous description
  36. __________________________________________________________________
  37. * |OVP_DocBegin_BoxAlgorithm_NoiseGenerator_Miscellaneous|
  38. * Uniform noise is drawn from the range \f$ ( 0,1 ( \f$. Gaussian noise has parameters
  39. * mean = 0, variance = 1.0. You can effectively change these parameters by using
  40. * the Simple DSP box on the resulting stream. For example, the mean and variance of
  41. * the resulting \f$ x \f$ from the Gaussian generator can be changed
  42. * by a formula like \f$ x*\sqrt{v} + m \f$ for new variance and mean, respectively.
  43. * |OVP_DocEnd_BoxAlgorithm_NoiseGenerator_Miscellaneous|
  44. */