Home Support NI Product Manuals LabVIEW NXG 5.1 Manual

Table Of Contents

Noise Generator (Gamma) (G Dataflow)

Download Manual | Offline Viewer Required
Version:
Last Modified: June 25, 2019

Generates a pseudorandom pattern of values which are the waiting times to a specific event number of a unit mean Poisson process.

connector_pane_image
datatype_icon

reset

A Boolean that controls the reseeding of the noise sample generator after the first call of the node.

True Accepts a new state or new seed value and begins producing noise samples based on the new state or new seed value.
False Maintains the initial internal seed state and resumes producing noise samples as a continuation of the previous noise sequence.

Default: False

datatype_icon

order

Event number of the unit mean Poisson process.

order must be greater than 0.

Default: 1

datatype_icon

state in

Initial internal seed state of the noise generator.

This input must be passed from the state out output of another call to this node.

This node uses state in as the initial internal seed state of the noise generator if reset is True or if this is the first call of the node. If state in is unwired or contains invalid values, this nodes uses seed as the initial internal seed state of the noise generator.

datatype_icon

x seed

Internal x seed. x seed must be greater than 0.

datatype_icon

y seed

Internal y seed. y seed must be greater than 0.

datatype_icon

z seed

Internal z seed. z seed must be greater than 0.

datatype_icon

seed

Number that this node uses to initialize the noise generator.

This node initializes the noise generator using seed when this node meets both of the following conditions:

  • This is the first call of this node or reset is True.
  • state in is unwired or contains invalid values.
seed is greater than 0 Generates noise samples based on the seed value.
seed is less than or equal to 0 For the first call, this node generates a random seed value and produces noise samples based on that seed value. For subsequent calls to the node, if seed remains less than or equal to 0, the node maintains the initial internal seed state and produces noise samples as a continuation of the initial noise sequence.

Default: -1

datatype_icon

error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Default: No error

datatype_icon

sample rate

Sample rate in samples per second.

This input is available only if you configure this node to return a waveform.

Default: 1000

datatype_icon

samples

Number of samples in the signal.

samples must be greater than 0. Otherwise, this node returns an error.

This input is available when you configure this node to return a waveform or an array of double-precision, floating-point numbers.

Default: 1000

datatype_icon

t0

Timestamp of the output signal. If this input is unwired, this node uses the current time as the timestamp of the output signal.

This input is available only if you configure this node to return a waveform.

datatype_icon

gamma noise

Gamma-distributed, pseudorandom pattern.

This output can return the following data types:

  • Waveform
  • Double-precision, floating-point number
  • 1D array of double-precision, floating-point numbers
datatype_icon

state out

Final internal seed state of the noise generator.

datatype_icon

x seed

Internal x seed.

datatype_icon

y seed

Internal y seed.

datatype_icon

z seed

Internal z seed.

datatype_icon

error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Algorithm for Generating the Gamma Noise

The following equation defines the Gamma function:

Γ ( r ) = ∫ 0 ∞ x r − 1 e − x d x ⁢           ( r > 0 )

The probability density function, f(x), of the gamma noise this node generates is as follows:

f ( x ) = { 1 Γ ( r ) x r − 1 e − x ,       x ≥ 0 0 ,       x < 0

where r is order.

The following equations define the mean value, μ , and the standard deviation value, σ , of the pseudorandom sequence:

μ = E { x } = r
σ = [ E { ( x − μ ) 2 } ] 1 / 2 = r

Where This Node Can Run:

Desktop OS: Windows

FPGA: Not supported

Web Server: Not supported in VIs that run in a web application

Recently Viewed Topics