GaussianNoise(Variable, Variable) Function

Top 

Description

Returns a random number with a Gaussian probability distribution defined by the specified mean and standard deviation.

 

Note that this function shares its seed value with FreeFlyer's internal random number generation. This means that even with a set seed value it is possible for this function to generate inconsistent values across Mission Plan executions based on the sequence of events undergone in the Mission Plan.

 

Timing Precision Mode

This page describes functionality in nanosecond timing precision mode.

 

Function Signature

GaussianNoise(

Variable mean,


Variable standardDeviation)

 

Arguments

mean


Description:

Mean of the Gaussian noise distribution.

 

standardDeviation


Description:

Standard deviation of the Gaussian noise distribution.

Valid Range:

standardDeviation > 0

 

 

Return Value

Type:

number

 

A random number with a Gaussian probability distribution defined by the specified mean and standard deviation.

 

Syntax

myVariable1 = GaussianNoise(myVariable2, myVariable3);

 

Example 1

 

See also

GaussianNoise