Spacecraft.FOVTimes(Variable, Sensor) Method

Top 

Description

Returns the entry and exit times when celestialBodyToView enters and leaves the Spacecraft's field of view as well as the azimuth and elevation of the argument in sensorToUse's coordinate frame.

 

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.FOVTimes(

Variable celestialBodyToView,


Sensor sensorToUse)

 

 

Arguments

celestialBodyToView


Description:

The numerical indentifier of the celestial body to use in the field of view calculation. 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.

 

 

 

sensorToUse


Description:

Sensor to use for the field of view calculation.

 

 

 

Return Value

Type:

string

 

 

Returns the entry and exit times when the argument Spacecraft, GroundStation, Star, or celestial body enters and leaves the Spacecraft's field of view as well as the azimuth and elevation of the argument in the Spacecraft Sensor's coordinate frame. If the Spacecraft has no active Sensors, the azimuth and elevation are reported in the Spacecraft's body coordinate frame.

 

The FF_Preferences.IntervalEventReportingBehavior property controls whether the start and end of propagation are reported as events. By default, if contact starts before the beginning of the propagation span, FreeFlyer will label the start of the propagation as the start of contact. If contact extends past the end of the propagation span, FreeFlyer labels the end of propagation as the end of contact.

 

Syntax

myString1 = mySpacecraft1.FOVTimes(myVariable1, mySensor1);

 

 

See also

Spacecraft Object

Spacecraft.FOVTimes

Spacecraft Propagation Guide

Coverage and Contact Analysis Guide