DataProviderResultStatistics

class ansys.stk.core.stkobjects.DataProviderResultStatistics

Class used to compute statistics and time varying extremum on data provider result data sets.

Overview

Methods

compute_statistic	Compute the requested statistic for the data set.
compute_time_varying_extremum	Compute the requested time varying extremum for the data set.
is_statistic_available	Is the supplied statistic available for the data?
is_time_varying_extremum_available	Is the supplied time varying extremum available for the data?

Import detail

from ansys.stk.core.stkobjects import DataProviderResultStatistics

Method detail

DataProviderResultStatistics.compute_statistic(self, statistic: StatisticType) → DataProviderResultStatisticResult

Compute the requested statistic for the data set.

Parameters:

statistic : StatisticType

Returns:

DataProviderResultStatisticResult

DataProviderResultStatistics.compute_time_varying_extremum(self, time_var_extremum: TimeVaryingExtremum) → DataProviderResultTimeVaryingExtremumResult

Compute the requested time varying extremum for the data set.

Parameters:

time_var_extremum : TimeVaryingExtremum

Returns:

DataProviderResultTimeVaryingExtremumResult

DataProviderResultStatistics.is_statistic_available(self, statistic: StatisticType) → bool

Is the supplied statistic available for the data?

Parameters:

statistic : StatisticType

Returns:

bool

DataProviderResultStatistics.is_time_varying_extremum_available(self, time_var_extremum: TimeVaryingExtremum) → bool

Is the supplied time varying extremum available for the data?

Parameters:

time_var_extremum : TimeVaryingExtremum

Returns:

bool