AGI STK Objects 11 Send comments on this topic.
IAgSwath Interface





Description

Provides access to the Swath properties.

Public Methods

Public Method AddTimeInterval Adds an interval to the list of valid swath intervals. Start/Stop Times use DateFormat Dimension.
Public Method GetTimeIntervalIndex Retrieves an index given a start and stop time. Start/Stop Times use DateFormat Dimension.
Public Method ModifyTimeInterval Modifies an interval given an index. Start/Stop Times use DateFormat Dimension.
Public Method RemoveAllIntervals Removes all intervals.
Public Method RemoveTimeInterval Removes the interval given the start and stop times. Start/Stop Times use DateFormat Dimension.
Public Method RemoveTimeIntervalIndex Removes an interval given an index.
Public Method ToArray Returns an array of all time intervals.

Public Properties

Public Property Color The color in which swath graphics are displayed in the 2D Graphics window.
Public Property ComputationalMethod Select the Analytical or Numerical Computaional Method for generating swaths.
Public Property CurvatureTolerance Controls the adaptive step size of swath computation and ensures that neighboring samples adequately capture the curvature of the swath line.
Public Property Enable Enables swath.
Public Property LineStyle The style of the line defining the boundaries of the swath display in the 2D Graphics window. A member of the AgELineStyle enumeration.
Public Property LineWidth The width of the line defining the boundaries of the swath display in the 2D Graphics window. A member of the AgELineWidth enumeration.
Public Property MaximumStep The maximum step size for the adaptive step size of swath computation.
Public Property MinimumStep The minimum step size for the adaptive step size of swath computation.
Public Property ScatteringTolerance Determines the angle with respect to the swath line within which candidate points are considered for possible connection to it.
Public Property TimeIntervalCount Number of Time Intervals.
Public Property UseMaximumCone Whether to perform swath computations based on the maximum cone that encompasses the sensor pattern instead of actual pattern. Setting this option may result in a more informative swath with a superior appearance.

Example

Define and compute sensor swath
[C#] Copy Code
// Configure swath display properties 
IAgSwath swath = sensor.Swath; 
swath.Enable = true
swath.Color = Color.Red; // red 
swath.LineStyle =  <a href="STKUtil.chm::/STKUtil~Enumerations~AgELineStyle_EN.html">AgELineStyle</a>.eLMSDash; 
swath.LineWidth = AgELineWidth.e2; 
 
// New swath properties 
swath.UseMaximumCone = true
swath.CurvatureTolerance = 90.0
swath.ScatteringTolerance = 70.0
swath.MinimumStep = 5
swath.MaximumStep = 10
 
swath.AddTimeInterval("1 Jan 2012 12:00:00.000""1 Jan 2012 13:00:00.000"); 
swath.AddTimeInterval("1 Jan 2012 14:00:00.000""1 Jan 2012 15:00:00.000"); 
 

Define and compute sensor swath
[Visual Basic .NET] Copy Code
' Configure swath display properties
Dim swath As IAgSwath = sensor.Swath
swath.Enable = True
swath.Color = Color.Red
' red
swath.LineStyle = AgELineStyle.eLMSDash
swath.LineWidth = AgELineWidth.e2

' New swath properties
swath.UseMaximumCone = True
swath.CurvatureTolerance = 90
swath.ScatteringTolerance = 70
swath.MinimumStep = 5
swath.MaximumStep = 10

swath.AddTimeInterval("1 Jan 2012 12:00:00.000", "1 Jan 2012 13:00:00.000")
swath.AddTimeInterval("1 Jan 2012 14:00:00.000", "1 Jan 2012 15:00:00.000")

© 2016 Analytical Graphics, Inc. All Rights Reserved.

STK Programming Interface 11.0.1