FigureOfMeritSatisfaction

class ansys.stk.core.stkobjects.FigureOfMeritSatisfaction

Satisfaction properties for a Figure of Merit.

Overview

Properties

enable_satisfaction	Specify whether to apply the graphical properties of the figure of merit only when a chosen satisfaction criterion is met.
satisfaction_type	Get or set the relationship to the specified threshold that must be achieved to satisfy the Figure of Merit.
satisfaction_threshold	Get or set the threshold for satisfying the Figure of Merit.
invalid_data_indicator	A value to indicate when contouring is invalid.
use_value_range_check	Enable FOM Values Limits for computing Statistics.
minimum_value_range	Get or set the Min Value in the range.
maximum_value_range	Get or set the Max Value in the range.
exclude_value_range	Exclude Value Range.

Import detail

from ansys.stk.core.stkobjects import FigureOfMeritSatisfaction

Property detail

property FigureOfMeritSatisfaction.enable_satisfaction: bool

Specify whether to apply the graphical properties of the figure of merit only when a chosen satisfaction criterion is met.

property FigureOfMeritSatisfaction.satisfaction_type: FigureOfMeritSatisfactionType

Get or set the relationship to the specified threshold that must be achieved to satisfy the Figure of Merit.

property FigureOfMeritSatisfaction.satisfaction_threshold: Any

Get or set the threshold for satisfying the Figure of Merit.

property FigureOfMeritSatisfaction.invalid_data_indicator: Any

A value to indicate when contouring is invalid.

property FigureOfMeritSatisfaction.use_value_range_check: bool

Enable FOM Values Limits for computing Statistics.

property FigureOfMeritSatisfaction.minimum_value_range: Any

Get or set the Min Value in the range.

property FigureOfMeritSatisfaction.maximum_value_range: Any

Get or set the Max Value in the range.

property FigureOfMeritSatisfaction.exclude_value_range: bool

Exclude Value Range.