Available Functions

Top  Previous  Next

Timing Precision Mode

This page describes functionality in millisecond timing precision mode.

 

Name

Description

abs

Computes the absolute value of the specified value.

acos

Computes the inverse cosine of the specified value.

acosh

Computes the inverse hyperbolic cosine of the specified value.

asin

Computes the inverse sine of the specified value.

asinh

Computes the inverse hyperbolic sine of the specified value.

atan

Computes the inverse tangent of the specified value.

atan2

Computes the four-quadrant inverse tangent of (y/x) and returns values in the closed interval [-pi,pi].

atanh

Computes the inverse hyperbolic tangent of the specified value.

AttitudeConvert

Converts a vector between different Spacecraft attitude systems, and returns the results as an array.

Average

Calculates the moving window average of a value using the specified number of data points.

ceiling

Computes the ceiling value of the specified value. The ceiling is the smallest integer that is greater than or equal to the specified value.

CheckEphemerisFormat

Returns a string indicating the format of the ephemeris. Valid values are "FFephem", "ephem", "PCephem", and "STKephem". If the format is not recognized a value of "Unknown" is returned.

cos

Computes the cosine of the specified value.

cosh

Computes the hyperbolic cosine of the specified value.

deg

Converts the specified value from radians to degrees.

ElementConvert

Converts the Spacecraft's orbital state from one element set to another, and returns the results in array form. The order of the elements for each element set are listed below (using the Spacecraft properties):

 

- CARTESIAN: X, Y, Z, VX, VY, VZ

- KEPLERIAN: A, E, I, RAAN, W, TA

- NONSINGULAR_KEPLERIAN: NonSingularA, NonSingularE1, NonSingularE2, NonSingularE3, NonSingularE4, NonSingularE5

- EQUINOCTIAL: EquinoctialA, EquinoctialH, EquinoctialK, EquinoctialP, EquinoctialQ, EquinoctialLongitude

- BROUWER_MEAN: BL_A, BL_E, BL_I, BL_RAAN, BL_W, BL_MA

- J2_BROUWER_MEAN: BLJ2A, BLJ2E, BLJ2I, BLJ2RAAN, BLJ2W, BLJ2MA

- SPHERICAL: SphericalRadius, RA, DEC, Vi, SphericalAzimuth, VerticalFPA

- SPHERICAL_LATLONG: LatLongRadius, Latitude, Longitude, LatLongVi, LatLongAzimuth, HorizontalFPA

- NORAD_ELEMENT_TYPE: NoradI, NoradRAAN, NoradE, NoradW, NoradMA, NoradMeanMotion

- MODIFIED_EQUINOCTIAL: ModifiedEquinoctialP, ModifiedEquinoctialF, ModifiedEquinoctialG, ModifiedEquinoctialH, ModifiedEquinoctialK, ModifiedEquinoctialL

 

Note, when used to convert an element set into Norad elements this function is not compatible with the SGP4/SDP4 propagator.

exp

Computes the exponential function value (e^x) of the specified value. The specified value represents the exponent x.

factorial

Computes the factorial expansion of the specified value. Before expansion the value is truncated to an integer.

floor

Computes the floor value of the specified value. The floor is the largest integer that is less than or equal to the specified value.

fmod

Computes the fractional remainder of the division (x/y). This modulo calculation can also be performed using the syntax: x%y. The fmod function requires y to be greater than zero, while the % syntax allows negative values for y.

frexp

Computes the mantissa and exponent of the input argument x for base 2, such that x = mantissa*2^exponent. The output argument y receives the exponent value, while the function itself returns the mantissa. The output values are given in base 10.

GaussianNoise

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.

GetNumberOfNoradStates

Returns the number of Norad states that are in the specified TLE file.

GetNumberOfPRNs

Returns the number of unique PRN codes that are in the specified Rinex Navigation file.

ldexp

Computes the number corresponding to the specified mantissa and exponent for base 2, such that x = mantissa*2^exponent. The mantissa and exponent values should be given in base 10.

ln

Computes the natural logarithm of the specified value.

log

Computes the base-10 logarithm of the specified value.

max

Returns the maximum of the two arguments.

min

Returns the minimum of the two arguments.

modf

Computes the signed integer and fractional portions of the specified value.

NumberOfNoradJobSpecsInFile

Reads an external file and determines the number of Norad job specs it contains.

NutationPrecessionMatrix

Returns the 3x3 Nutation/Precession matrix for the specified epoch.

PositionConvert

Converts a position from one coordinate system to another, and returns the results in array form.

PositionVelocityConvert

Converts a position and velocity from one coordinate system to another, and returns the results in array form.

pow

Computes the power (x^y).

rad

Converts the specified value from degrees to radians.

ReportStatusMessage

Reports a user defined status message through FreeFlyer's message reporting mechanism.

RGB

Returns a FreeFlyer color representing the specified color components.

round

Computes the nearest-integer rounding of the specified value.

SeedNoise

Seeds the random number generator used with GaussianNoise and UniformNoise with the specified seed.

sign

Computes the numeric sign of the specified value.

sin

Computes the sine of the specified value.

sinh

Computes the hyperbolic sine of the specified value.

sqrt

Computes the square root of the specified value.

StringCompare

Compares two stringarguments.

StringConcat

Concatenates a combination of two string objects or literal strings.

StringLength

Returns the numeric length of a defined string.

StringToFloat

Reports the numeric value of a string holding a series of numeric characters.

SubString

Return a substring of a string.

SystemTime

The current date and time of the system in the International Atomic Time (TAI) system represented in the Modified Julian Date format.

 

The SystemTime function's resolution is dependent upon the operating system's timer resolution, which is typically 15.625 ms in Windows (equivalent to a 64 Hz timer frequency).

tan

Computes the tangent of the specified value.

tanh

Computes the hyperbolic tangent of the specified value.

trunc

Computes the integer part of the specified value.

UniformNoise

Returns a random number with the specified mean and width.

 

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.

VelocityConvert

Converts a velocity from one coordinate system to another, and returns the results in array form.

 

Deprecated Functions

 

Name

Description

CrossProduct

Returns the cross product of two three-element arrays.

 

This function has been Deprecated. Please use Array.CrossProduct(Array) instead.

DotProduct

Returns the dot product of two three-element arrays.

 

This function has been Deprecated. Please use Array.DotProduct(Array) instead.

EigenVector

Calculates the eigen vectors of a matrix such that when an eigen vector is multiplied by the matrix, the result is equal to the matrix multiplied by a constant.

 

This function has been Deprecated. Please use Matrix.EigenDecomposition(Matrix,Matrix) instead.

Mult3x3Matrix

Returns the product of two three by three matrices.

 

This function has been Deprecated. Please use the multiplication operator (*) to multiply two matrices.

MultMatrixVector

Returns the product of a three by three matrix and a three element vector.

 

This function has been Deprecated. Please use the multiplication (*) operator to multiply a Matrix with an Array.

NutationPrecession

Returns the 3x3 Nutation/Precession matrix for the specified epoch.

 

This function has been Deprecated. Please use NutationPrecessionMatrix(Variable) instead.

Transpose3x3Matrix

Returns the transpose of a three by three matrix by replacing all elements aij with aji.

 

This function has been Deprecated. Please use Matrix.Transpose() instead.

UnitizeVector

Returns the unit vector by dividing the given vector by its own magnitude.

 

This function has been Deprecated. Please use [Array].Normalized() instead.

VectorMagnitude

Returns the magnitude of a vector. If the array has more than 3 elements, only the first 3 elements of the array are considered.

 

This function has been Deprecated. Please use Array.Norm() or Matrix.Norm() instead.