Formation.SetRandomStates(Array, Matrix, String) Method

Top 

Description

Populates the Formation with states from a random Gaussian distribution described by the provided covariance matrix. The dimension and order of the covariance matrix is assumed to be consistent with the ProcessAction properties held in the first Spacecraft in the formation. The number of states generated is determined by the size of the provided Formation.

 

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

 

Method Signature

Formation.SetRandomStates(

Array meanState,


Matrix covariance,


String covarianceElementSet)

 

 

Arguments

meanState


Description:

The mean state associated with the covariance matrix. The returned states are referenced from the provided mean.

 

 

covariance


Description:

The covariance matrix that describes the Gaussian distribution from which to draw a state.

 

 

covarianceElementSet


Description:

Element set definition of the provided covariance.

Valid Values:

Value

Label

"Cartesian"

Cartesian Elements

"Equinoctial"

Equinoctial Elements

"SGP4Equinoctial"

SGP4Equinoctial Elements

"NoradEquinoctial"

NoradEquinoctial Elements (deprecated, use SGP4Equinoctial instead)

 

 

 

 

Syntax

myFormation1.SetRandomStates(myArray1, myMatrix1, myString1);

 

 

See also

Formation Object

Formation.SetRandomStates

Formations Guide