Spacecraft.ParticleFluxTimes(Variable, Variable, Variable, Variable, Variable, Variable) Method

 Top 

Description

Determines when the spacecraft crosses into or out of a region with a certain level of flux. The ParticleFluxTimes method uses the NASA AP-8 and AE-8 particle flux maps to calculate the omnidirectional flux of the specified particle type with the energy level specified by minimumEnergy. The AP/AE maps contain collected data of proton and electron fluxes in the Earth's radiation belt with energy ranges from 0.04 MeV to 7 MeV for electrons and from 0.1 MeV to 400 MeV for protons. See the help file for links to more detailed documentation on the AP/AE maps. The user has the option to specify epoch and longitude offsets to include in the flux calculation.

 

 

For more detailed information on the particle flux models, please see the Goddard Space Flight Center's description here: http://ccmc.gsfc.nasa.gov/modelweb/magnetos/aeap.html

 

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.

 

Note: This is an interval method. See the Interval Methods page for more information.

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

 

Method Signature

Spacecraft.ParticleFluxTimes(

Variable fluxThreshold,

Variable minimumEnergy,

Variable particleType,

Variable solarActivity,

Variable igrfEpochOffset,

Variable longitudeOffset)

 

 

Arguments

fluxThreshold

Description:

Flux threshold for which events should be reported.

Units:

particles/(cm2 s)

Valid Range:

fluxThreshold > 0

 

 

minimumEnergy

Description:

Minimum energy of particles contributing to the flux. Energy values for Electrons range from 0.1 to 7.0 MeV; for Protons from 0.1 to 400.0 MeV.

Units:

MeV

Valid Range:

minimumEnergy > 0

 

 

particleType

Description:

The type of particle for which flux will be computed.

Valid Values:

Value

Label

0

electrons

1

protons

 

 

 

solarActivity

Description:

The solar activity level of the flux model. The AP-8/AE-8 flux maps use the 1964 IGRF Magnetic Field model when modeling solar minimum, and the 1970 IGRF Magnetic Field model when modeling solar maximum.

Valid Values:

Value

Label

0

solar minimum

1

solar maximum

 

 

 

igrfEpochOffset

Description:

An offset added to the epoch of the IGRF Magnetic Field model, used to determine the epoch of the magnetic field. Generally this argument should be between 0 and 365, signifying the number of days after the base epoch of the Magnetic Field model.

 

The epoch of the IGRF Magnetic Field model, when modeling solar minimum, is Jan 01 1964 12:00:00.000.

The epoch of the IGRF Magnetic Field model, when modeling solar maximum, is Jan 01 1970 12:00:00.000.

Units:

day

 

 

longitudeOffset

Description:

An offset added to the Longitude of the Spacecraft when computing the local magnetic field strength; the Latitude and Altitude are held constant. A positive offset is applied in the West direction.

Units:

deg

 

 

 

Return Value

Type:

string

 

 

Returns a string containing the entrance or exit time for any flux threshold crossings.

 

The FF_Preferences.IntervalEventReportingBehavior property controls whether the start and end of propagation are reported as events. By default, if entry into high flux starts before the beginning of the propagation span, FreeFlyer will label the start of the propagation as the entry into high flux. If the time in high flux extends past the end of the propagation span, FreeFlyer labels the end of propagation as the exit from high flux.

 

Syntax

myString1 = mySpacecraft1.ParticleFluxTimes(myVariable1, myVariable2, myVariable3, myVariable4, myVariable5, myVariable6);

 

 

See also

Spacecraft Object

Spacecraft.ParticleFluxTimes

Spacecraft Propagation Guide

Coverage and Contact Analysis Guide