Spacecraft.ExclusionZone(Region) Method

 Top 

Description

Returns the start time, end time, and duration of a pass based on a Spacecraft's location over a Region. The ExclusionZone time is based on the Spacecraft's sub-satellite point within a Region.

 

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

Region Region)

 

 

Arguments

Region

Description:

Region to use in the exclusion zone calculation.

 

 

 

Return Value

Type:

string

 

 

Returns the start time, end time, and duration of a pass based on a Spacecraft 's location over a Region. The ExclusionZone time is based on the Spacecraft's sub-satellite point within a Region.

 

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

 

Syntax

myString1 = mySpacecraft1.ExclusionZone(myRegion1);

 

 

Example 1

This example demonstrates how to generate a report of a Spacecraft's passes through a Region exclusion zone.

 

Spacecraft Spacecraft1;

Region Region1;

 

// *** For Millisecond Mode Only ***

While (Spacecraft1.ElapsedDays < 1);

 

 Report Spacecraft1.ExclusionZone(Region1) to "Spacecraft_ExclusionZone.txt";

 Step Spacecraft1;

 

End;

 

Or

 

// *** For Nanosecond Mode Only ***

While (Spacecraft1.ElapsedTime < TIMESPAN(1 days));

 

 Report Spacecraft1.ExclusionZone(Region1) to "Spacecraft_ExclusionZone.txt";

 Step Spacecraft1;

 

End;

 

 

Output:

 

Note: Output generated using nanosecond timing precision mode.

 

ExclusionZone Event           Entry Epoch                      Exit Epoch                       Duration(min)

Region1 --> Spacecraft1       Jan 01 2020 01:32:06.123046875   Jan 01 2020 01:37:37.617187500    5.524902344

Region1 --> Spacecraft1       Jan 01 2020 03:11:02.548828125   Jan 01 2020 03:16:34.042968750    5.524902344

Region1 --> Spacecraft1       Jan 01 2020 12:15:14.575195312   Jan 01 2020 12:20:45.776367187    5.520019531

Region1 --> Spacecraft1       Jan 01 2020 13:54:11.000976562   Jan 01 2020 13:59:42.202148437    5.520019531

Region1 --> Spacecraft1       Jan 01 2020 15:33:07.426757812   Jan 01 2020 15:33:31.962890625    0.408935547

 

 

 

See also

Spacecraft Object

Spacecraft.ExclusionZone

Spacecraft Propagation Guide

Coverage and Contact Analysis Guide