CoverageGridInspector#

class ansys.stk.core.stkobjects.CoverageGridInspector#

CoverageGridInspector class provides methods to use the grid inspector tool for coverage definition.

Overview#

select_point

Lat param uses Latitude Dimension. Lon param uses Longitude Dimension.

select_region

Select a region.

clear_selection

Clear the selected point or region.

get_grid_point_selection

Return a collection of grid points that allows the user to select points into the grid inspector.

point_coverage

Access for the point selected in the graphics window.

point_daily_coverage

Access times for the point selected in the graphics window.

point_probability_of_coverage

Get the probability of coverage for the point selected in the graphics window being achieved as a function of the time past a request for coverage.

region_coverage

Summary of coverage for the region selected in the graphics window.

region_full_coverage

Summary of the coverage intervals for the selected region, including access start and end times, duration of each interval and the percentage of the region covered during each pass.

region_pass_coverage

Detailed information about the intervals of time when each asset can provide coverage to the selected region.

message

Retrieve the message when a point or region is selected.

Import detail#

from ansys.stk.core.stkobjects import CoverageGridInspector

Property detail#

property CoverageGridInspector.point_coverage: IDataProviderInfo#

Access for the point selected in the graphics window.

property CoverageGridInspector.point_daily_coverage: IDataProviderInfo#

Access times for the point selected in the graphics window.

property CoverageGridInspector.point_probability_of_coverage: IDataProviderInfo#

Get the probability of coverage for the point selected in the graphics window being achieved as a function of the time past a request for coverage.

property CoverageGridInspector.region_coverage: IDataProviderInfo#

Summary of coverage for the region selected in the graphics window.

property CoverageGridInspector.region_full_coverage: IDataProviderInfo#

Summary of the coverage intervals for the selected region, including access start and end times, duration of each interval and the percentage of the region covered during each pass.

property CoverageGridInspector.region_pass_coverage: IDataProviderInfo#

Detailed information about the intervals of time when each asset can provide coverage to the selected region.

property CoverageGridInspector.message: str#

Retrieve the message when a point or region is selected.

Method detail#

CoverageGridInspector.select_point(self, lat: Any, lon: Any) None#

Lat param uses Latitude Dimension. Lon param uses Longitude Dimension.

Parameters:

lat : Any

lon : Any

Returns:

None

CoverageGridInspector.select_region(self, region_name: str) None#

Select a region.

Parameters:

region_name : str

Returns:

None

CoverageGridInspector.clear_selection(self) None#

Clear the selected point or region.

Returns:

None

CoverageGridInspector.get_grid_point_selection(self) CoverageGridPointSelection#

Return a collection of grid points that allows the user to select points into the grid inspector.

Returns:

CoverageGridPointSelection