FigureOfMeritGridInspector

class ansys.stk.core.stkobjects.FigureOfMeritGridInspector

FigureOfMeritGridInspector class provides methods to use the grid inspector tool for FOM.

Overview

Methods

select_point	Select point.
clear_selection	Clear the selected point or region.
select_region	Select a region.

Properties

region_figure_of_merit	Retrieve the Region FOM data provider.
region_satisfaction	Retrieve the Region Satisfaction data provider.
point_figure_of_merit	Retrieve the Point FOM data provider.
point_satisfaction	Retrieve the Point Satisfaction data provider.
message	Retrieve the message when a point or region is selected.

Import detail

from ansys.stk.core.stkobjects import FigureOfMeritGridInspector

Property detail

property FigureOfMeritGridInspector.region_figure_of_merit: IDataProviderInfo

Retrieve the Region FOM data provider.

property FigureOfMeritGridInspector.region_satisfaction: IDataProviderInfo

Retrieve the Region Satisfaction data provider.

property FigureOfMeritGridInspector.point_figure_of_merit: IDataProviderInfo

Retrieve the Point FOM data provider.

property FigureOfMeritGridInspector.point_satisfaction: IDataProviderInfo

Retrieve the Point Satisfaction data provider.

property FigureOfMeritGridInspector.message: str

Retrieve the message when a point or region is selected.

Method detail

FigureOfMeritGridInspector.select_point(self, lat: Any, lon: Any) → None

Select point.

Parameters:

lat : Any

lon : Any

Returns:

None

FigureOfMeritGridInspector.clear_selection(self) → None

Clear the selected point or region.

Returns:

None

FigureOfMeritGridInspector.select_region(self, region_name: str) → None

Select a region.

Parameters:

region_name : str

Returns:

None