Description | Example | Return Message | Group

SetSwath

Set the properties of a Sensor Swath.

Syntax

SetSwath <SensorObjectPath> {Options}

Description

Use the SetSwath command to set the properties of a Sensor Swath

{Options} Description
ShowSwath {On | Off} Turn on or off the display of the swath.
TimePeriod {TimeInterval} Set the interval for displaying a Sensor's swath.

For valid {TimeInterval} values see Time Options.

RemoveAll Turn off and remove the swath.
Color {Color} Set the color of the swath. For valid {Color} options see Common Options.
LineWidth <LineWidth> Set the line width for the swath. <LineWidth> should be between 1.0 and 10.0
LineStyle {LineStyle} Set the line style for the swath. {LineStyle} can be a name such as Solid, Dashed, Dotted, etc, or a number 0, 1, 2, etc. For all valid {LineStyle} options see Common Options.
ComputationalMethod {Numerical | Analytical} Specify the method for computing the swath.

Numerical Computational Method is not valid if the Sensor uses a Custom Pattern.

Analytical Computational Method is only valid if the parent of the Sensor is a Satellite and the Satellite has a Circular Orbit and the Satellite uses Nadir ECF Attitude and the Sensor is Nadir (Fixed) Pointing.

MinimumStep <Value> Set the minimum step size in Connect time units. <Value> should be greater or equal to 0.001 seconds.

This option is valid only if ComputationalMethod is Numerical

MaximumStep <Value> Set the maximum step size in Connect time units. <Value> should be greater or equal to 0.001 seconds.

This option is valid only if ComputationalMethod is Numerical

UseMaximumCone {On | Off} Specify whether to use the maximum cone.

This option is valid only if ComputationalMethod is Numerical

ScatteringTolerance <Value> Set the scattering tolerance value in degrees. <Value> should be between 0.0 and 180.0 degrees.

This option is valid only if ComputationalMethod is Numerical

CurvatureTolerance <Value> Set the curvature tolerance value in degrees. <Value> should be between 0.0 and 180.0 degrees.

This option is valid only if ComputationalMethod is Numerical

Example

To turn on the swath for Sensor1, and set the width to 2 and the style to dotted:

SetSwath */Satellite/Satellite1/Sensor/Sensor1 ShowSwath On LineWidth 2 LineStyle Dotted

Change the color of the swath for Sensor1 to yellow and set a time interval:

SetSwath */Satellite/Satellite1/Sensor/Sensor1 color yellow TimePeriod "1 Jul 2007 12:30:00.000" "1 Jul 2007 14:30:00.000"

Set additional values for the sensor swath:

SetSwath */Satellite/Satellite1/Sensor/Sensor1 ComputationalMethod Numerical MinimumStep 12.0 MaximumStep 360.0

SetSwath */Satellite/Satellite1/Sensor/Sensor1 UseMaximumCone On ScatteringTolerance 45.0 CurvatureTolerance 6.0

ReturnMessage

If activated, Connect returns an acknowledgement message.

Group Membership

This command belongs to the following group(s):

Sensors

Object Tools

Version

10

STK Programming Interface 11.0.1