Spacecraft.FOVInterference(Variable, Spacecraft, Variable, Sensor, TimeSpanArray, Array) Method

Top 

Description

Returns the time of entry into an area of interference, the time of exit from the area of interference, and the duration of interference. Interference is defined to be the period when both an object of interest and an interfering object are within the field-of-view of a Spacecraft sensor, and the interfering object lies within a user-specified cone about the Spacecraft to object-of-interest vector.

 

Timing Precision Mode

This page describes functionality in nanosecond timing precision mode.

Click here to see the documentation for this object in millisecond 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.FOVInterference(

Variable objectOfInterest,


Spacecraft interferenceObject,


Variable coneAngle,


Sensor sensor,


TimeSpanArray EventTime,


Array EventType)

 

 

Arguments

objectOfInterest


Description:

The CelestialObject in which the calling Spacecraft's sensor is interested. The CelestialObject is specified by a numeric ID. Body ID's 1-11 are assigned to the default Solar System objects, as shown below. Custom CelestialObjects will have body ID's starting at 12 and assigned in the order they are created.

Valid Values:

Celestial Object

Value

Mercury

Mercury.BodyID or 1

Venus

Venus.BodyID or 2

Earth

Earth.BodyID or 3

Mars

Mars.BodyID or 4

Jupiter

Jupiter.BodyID or 5

Saturn

Saturn.BodyID or 6

Uranus

Uranus.BodyID or 7

Neptune

Neptune.BodyID or 8

Pluto

Pluto.BodyID or 9

Moon

Moon.BodyID or 10

Sun

Sun.BodyID or 11

<Custom CelestialBody>

<Custom CelestialBody>.BodyID, starting at 12 and assigned in the order the custom CelestialObjects are created.

 

 

 

interferenceObject


Description:

The Spacecraft object that will impose interference on the calling Spacecraft's sensor if it is positioned such that it meets the criteria above.

 

 

coneAngle


Description:

This is the half angle of the cone in degrees for which the interference is determined.

Units:

deg

Valid Range:

-360 ≤ coneAngle ≤ 360

 

 

sensor


Description:

Sensor to consider when evaluating interference.

 

 

EventTime


Description:

The time that the event occurred.

 

The FF_Preferences.IntervalEventReportingBehavior property controls whether the start of propagation is reported as an event. By default, if the interference starts before the beginning of the propagation span, FreeFlyer will label the start of the propagation as the start of the interference.

 

 

EventType


Description:

The type of the event that occurred. Event Type == 1 is entry into Contact. Event Type == 2 is exit from Contact.

 

 

 

Return Value

Type:

number

 

 

Returns the number of elements filled into EventType and EventTime arrays

 

Syntax

myVariable1 = mySpacecraft1.FOVInterference(myVariable2, mySpacecraft2, myVariable3, mySensor1, myTimeSpanArray1, myArray1);

 

 

See also

Spacecraft Object

Spacecraft.FOVInterference

Spacecraft Propagation Guide

Coverage and Contact Analysis Guide