Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DeltaFunctionGenerator

A Delta function generator. Generates random spikes in otherwise flat data. Generated data is between 0 and 1.

To create a new instance of Delta function generator use createDeltaFunctionGenerator factory.

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

generate

  • Generate new instance of DataHost with unique data. Data is added to the DataHost asynchronously.

    Returns DataHost<Point>

    A new DataHost.

setMaxAmplitude

  • Returns a new Data generator with the new maxAmplitude.

    Parameters

    • maxAmplitude: number

      The maximum spike height.

    Returns DeltaFunctionGenerator

setMaxGap

  • Returns a new Data generator with the new maxGap.

    Parameters

    • maxGap: number

      How many points there can be between spikes.

    Returns DeltaFunctionGenerator

setMinAmplitude

  • Returns a new Data generator with the new minAmplitude.

    Parameters

    • minAmplitude: number

      The minium spike height.

    Returns DeltaFunctionGenerator

setMinGap

  • Returns a new Data generator with the new minGap.

    Parameters

    • minGap: number

      How many points there has to be between spikes.

    Returns DeltaFunctionGenerator

setNumberOfPoints

  • Returns a new Data generator with the new numberOfPoints.

    Parameters

    • numberOfPoints: number

      How many points of data to generate.

    Returns DeltaFunctionGenerator

setProbability

  • Returns a new Data generator with the new probability.

    Parameters

    • probability: number

      The probability of a spike to generate on each step.

    Returns DeltaFunctionGenerator