Swath

class ansys.stk.core.stkobjects.Swath

Class defining Swath properties.

Overview

Methods

add_time_interval	Add an interval to the list of valid swath intervals. Start/Stop Times use DateFormat Dimension.
modify_time_interval	Modify an interval given an index. Start/Stop Times use DateFormat Dimension.
get_time_interval_index	Retrieve an index given a start and stop time. Start/Stop Times use DateFormat Dimension.
remove_time_interval	Remove the interval given the start and stop times. Start/Stop Times use DateFormat Dimension.
remove_time_interval_index	Remove an interval given an index.
remove_all_intervals	Remove all intervals.
to_array	Return an array of all time intervals.

Properties

enable	Enable swath.
color	Get or set the color in which swath graphics are displayed in the 2D Graphics window.
line_style	Get or set the style of the line defining the boundaries of the swath display in the 2D Graphics window. A member of the LineStyle enumeration.
line_width	Get or set the width of the line defining the boundaries of the swath display in the 2D Graphics window. A member of the LineWidth enumeration.
time_interval_count	Number of Time Intervals.
minimum_step	Get or set the minimum step size for the adaptive step size of swath computation.
maximum_step	Get or set the maximum step size for the adaptive step size of swath computation.
use_maximum_cone	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.
scattering_tolerance	Determine the angle with respect to the swath line within which candidate points are considered for possible connection to it.
curvature_tolerance	Control the adaptive step size of swath computation and ensures that neighboring samples adequately capture the curvature of the swath line.
computational_method	Select the Analytical or Numerical Computaional Method for generating swaths.

Import detail

from ansys.stk.core.stkobjects import Swath

Property detail

property Swath.enable: bool

Enable swath.

property Swath.color: Color

Get or set the color in which swath graphics are displayed in the 2D Graphics window.

property Swath.line_style: LineStyle

Get or set the style of the line defining the boundaries of the swath display in the 2D Graphics window. A member of the LineStyle enumeration.

property Swath.line_width: LineWidth

Get or set the width of the line defining the boundaries of the swath display in the 2D Graphics window. A member of the LineWidth enumeration.

property Swath.time_interval_count: int

Number of Time Intervals.

property Swath.minimum_step: float

Get or set the minimum step size for the adaptive step size of swath computation.

property Swath.maximum_step: float

Get or set the maximum step size for the adaptive step size of swath computation.

property Swath.use_maximum_cone: bool

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.

property Swath.scattering_tolerance: float

Determine the angle with respect to the swath line within which candidate points are considered for possible connection to it.

property Swath.curvature_tolerance: float

Control the adaptive step size of swath computation and ensures that neighboring samples adequately capture the curvature of the swath line.

property Swath.computational_method: SwathComputationalMethod

Select the Analytical or Numerical Computaional Method for generating swaths.

Method detail

Swath.add_time_interval(self, start_time: Any, stop_time: Any) → None

Add an interval to the list of valid swath intervals. Start/Stop Times use DateFormat Dimension.

Parameters:

start_time : Any

stop_time : Any

Returns:

None

Swath.modify_time_interval(self, index: int, start: Any, stop: Any) → None

Modify an interval given an index. Start/Stop Times use DateFormat Dimension.

Parameters:

index : int

start : Any

stop : Any

Returns:

None

Swath.get_time_interval_index(self, start: Any, stop: Any) → int

Retrieve an index given a start and stop time. Start/Stop Times use DateFormat Dimension.

Parameters:

start : Any

stop : Any

Returns:

int

Swath.remove_time_interval(self, start: Any, stop: Any) → None

Remove the interval given the start and stop times. Start/Stop Times use DateFormat Dimension.

Parameters:

start : Any

stop : Any

Returns:

None

Swath.remove_time_interval_index(self, index: int) → None

Remove an interval given an index.

Parameters:

index : int

Returns:

None

Swath.remove_all_intervals(self) → None

Remove all intervals.

Returns:

None

Swath.to_array(self, index: int, length: int) → list

Return an array of all time intervals.

Parameters:

index : int

length : int

Returns:

list