Spacecraft.MagneticField Method

 Top 

Description

Returns the Earth's magnetic field vector at the Spacecraft's current position. The user can specify the coordinate system used to express the magnetic field vector via a Variable or a Sensor. If a Variable or Sensor is not specified, the ICRF is used.

 

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.

 

Overload List

Signatures

Return Value

Description

Spacecraft.MagneticField()

Array

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

Spacecraft.MagneticField(Sensor sensor)

Array

Returns the Earth's magnetic field vector at the Spacecraft's current position using the coordinate system of sensor to express the vector.

Spacecraft.MagneticField(Variable coordinateSystem)

Array

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

 

 

See also

Spacecraft Object

Spacecraft Propagation Guide

Coverage and Contact Analysis Guide