CoverageDefinition

class ansys.stk.core.stkobjects.CoverageDefinition

Bases: ISTKObject, ILifetimeInformation

The CoverageDefinition class.

Overview

Methods

compute_accesses	Compute accesses between the grid points and the assigned assets.
clear_accesses	Remove access information currently maintained in association with each grid point in the coverage area.
reload_accesses	Reload access data that was previously saved with a coverage definition object.
export_accesses_as_text	Export all computed accesses to an ASCII text file.

Properties

grid	Definition of the coverage grid.
point_definition	Location of points on the coverage grid.
asset_list	List of assets to use in coverage computations.
advanced	Advanced properties of the coverage definition.
interval	Coverage interval.
graphics	2D Graphics properties of the coverage definition.
graphics_3d	3D Graphics properties of the coverage definition.
grid_inspector	Get the grid inspector tool.

Examples

Compute Coverage

# CoverageDefinition coverage: Coverage object
coverage.compute_accesses()

Set Advanced Settings for Coverage

# CoverageDefinition coverage: Coverage object
advanced = coverage.advanced
advanced.recompute_automatically = False
advanced.data_retention = CoverageDataRetention.ALL_DATA
advanced.save_mode = DataSaveMode.SAVE_ACCESSES

Set the Coverage Interval to an object’s availability Analysis interval

# Satellite satellite: Satellite object
# CoverageDefinition coverage: Coverage object
satVGT = satellite.analysis_workbench_components
AvailTimeSpan = satVGT.time_intervals.item("AvailabilityTimeSpan")
IntResult = AvailTimeSpan.find_interval()
coverage.interval.analysis_interval.set_start_and_stop_times(IntResult.interval.start, IntResult.interval.stop)

Create a New Coverage Definition (on the current scenario central body)

# Scenario scenario: Scenario object
# Create new Coverage Definition and set the Bounds to an area target
coverage = scenario.children.new(STKObjectType.COVERAGE_DEFINITION, "MyCoverage")
coverage.grid.bounds_type = CoverageBounds.CUSTOM_REGIONS
covGrid = coverage.grid
bounds = covGrid.bounds
bounds.area_targets.add("AreaTarget/MyAreaTarget")
# Define the Grid Resolution
Res = covGrid.resolution
Res.latitude_longitude = 0.5  # deg
# Set the satellite as the Asset
coverage.asset_list.add("Satellite/MySatellite")

# Turn off Show Grid Points
coverage.graphics.static.show_points = False

Import detail

from ansys.stk.core.stkobjects import CoverageDefinition

Property detail

property CoverageDefinition.grid: CoverageGrid

Definition of the coverage grid.

property CoverageDefinition.point_definition: CoveragePointDefinition

Location of points on the coverage grid.

property CoverageDefinition.asset_list: CoverageAssetListCollection

List of assets to use in coverage computations.

property CoverageDefinition.advanced: CoverageAdvancedSettings

Advanced properties of the coverage definition.

property CoverageDefinition.interval: CoverageInterval

Coverage interval.

property CoverageDefinition.graphics: CoverageGraphics

2D Graphics properties of the coverage definition.

property CoverageDefinition.graphics_3d: CoverageGraphics3D

3D Graphics properties of the coverage definition.

property CoverageDefinition.grid_inspector: CoverageGridInspector

Get the grid inspector tool.

Method detail

CoverageDefinition.compute_accesses(self) → None

Compute accesses between the grid points and the assigned assets.

Returns:

None

CoverageDefinition.clear_accesses(self) → None

Remove access information currently maintained in association with each grid point in the coverage area.

Returns:

None

CoverageDefinition.reload_accesses(self) → None

Reload access data that was previously saved with a coverage definition object.

Returns:

None

CoverageDefinition.export_accesses_as_text(self, filename: str) → None

Export all computed accesses to an ASCII text file.

Parameters:

filename : str

Returns:

None