Spacecraft.MagneticField(Variable) Method

Top

Description

Returns the Earth's magnetic field vector at the Spacecraft's current position using coordinateSystem to express the vector.

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

Spacecraft.MagneticField(

Variable coordinateSystem)

Arguments

coordinateSystem

Description:

Variable that specifies the coordinate system used to express the magnetic field vector.

Valid Values:

Value	Label
0	ICRF
1	Velocity Normal Binormal (VNB)
2	Local Vertical / Local Horizontal (LVLH)
3	Body Coordinate System (BCS)

Return Value

Type:	Array of number (size = 3)
Units:	nT

Returns the Earth's magnetic field vector at the Spacecraft's current position.

Syntax

myArray1 = mySpacecraft1.MagneticField(myVariable1);