Class WhiteNoiseGenerator

A white noise data generator. Generates white noise.

To create a new instance of white noise data generator use createWhiteNoiseGenerator factory.

Hierarchy

DataGenerator<Point, WhiteNoiseGeneratorOptions>
- WhiteNoiseGenerator

Index

Constructors

constructor

Methods

Constructors

constructor

new WhiteNoiseGenerator(args: WhiteNoiseGeneratorOptions): WhiteNoiseGenerator

Overrides DataGenerator.constructor
- Defined in generators/whiteNoise.ts:30
Parameters
- args: WhiteNoiseGeneratorOptions
Returns WhiteNoiseGenerator

Methods

generate

generate(): DataHost<Point>

Inherited from DataGenerator.generate
- Defined in dataGenerator.ts:47
Generate new instance of DataHost with unique data. Data is added to the DataHost asynchronously.

Returns DataHost<Point>

A new DataHost.

setNumberOfPoints

setNumberOfPoints(numberOfPoints: number): WhiteNoiseGenerator

- Defined in generators/whiteNoise.ts:43
Returns a new Data generator with the new numberOfPoints.

Parameters
- numberOfPoints: number
  
  How many points of data to generate
Returns WhiteNoiseGenerator