Spacecraft.MagRegion(Variable, Variable) Method

Top 

Description

Represents the current magnetic field region the Spacecraft is in, as defined by the National Space Science Data Center's (NSSDC) Satellite Situation Center. It returns an integer value based on the following legend:

0 none of the below

1 Interplanetary Medium

2 Dayside Magnetosheath

3 Nightside Magnetosheath

4 Dayside Magnetosphere

5 Nightside Magnetosphere

6 Plasma Sheet

7 Tail Lobe

8 High Latitude Boundary Layer

9 Low Latitude Boundary Layer

10 Dayside Plasmasphere

11 Nightside Plasmasphere

 

Timing Precision Mode

This page describes functionality in nanosecond timing precision mode.

 

Note: This method has a state. See the Methods and Properties with State page for more information.

 

Method Signature

Spacecraft.MagRegion(

Variable solarWindPressure,


Variable zComponentOfBField)

 

Arguments

solarWindPressure


Description:

Solar Wind Dynamical Pressure. A default value of 2.1 nPa is typically used.

Units:

nPa

Valid Range:

solarWindPressure ≥ 0

 

zComponentOfBField


Description:

Z-component of the interplanetary magnetic field.

Units:

T

 

 

Return Value

Type:

number

 

returns an integer value based on the following legend: 0 none of the below. 1 Interplanetary Medium. 2 Dayside Magnetosheath. 3 Nightside Magnetosheath. 4 Dayside Magnetosphere. 5 Nightside Magnetosphere. 6 Plasma Sheet. 7 Tail Lobe. 8 High Latitude Boundary Layer. 9 Low Latitude Boundary Layer. 10 Dayside Plasmasphere. 11 Nightside Plasmasphere.

 

Syntax

myVariable1 = mySpacecraft1.MagRegion(myVariable2, myVariable3);

 

See also

Spacecraft Object

Spacecraft Propagation Guide

Coverage and Contact Analysis Guide