types

class StatsFilterOperator(*values)

Bases: Enum

LESS_THAN = 1

LESS_THAN_OR_EQUAL = 2

GREATER_THAN = 3

GREATER_THAN_OR_EQUAL = 4

RANGE = 5

class StatsFilterSecondaryOperator(*values)

Bases: Enum

AND = 6

OR = 7

UNUSED = 8

class ConvergenceCriterion(*values)

Bases: Enum

FOS_MEAN = 9

FOS_STD_DEV = 10

FOS_MINIMUM = 11

PF_MEAN = 12

class StatisticsContext(stage: int = 0, method_index: int = -1)

Bases: object

Omit stage/method_index to use the session active values (set via InterpretData.setActiveStage / setActiveAnalysisMethod).

getStage() → int

setStage(value: int) → None

getMethodIndex() → int

setMethodIndex(value: int) → None

class StatsFilter(enabled: bool = False, filter_variable_index: int = 2, operator: StatsFilterOperator = StatsFilterOperator.RANGE, value: float = 0.0, value_max: float = 1.0, combine_operator: StatsFilterSecondaryOperator = StatsFilterSecondaryOperator.AND, filter_variable_index_2: int = 3, operator_2: StatsFilterOperator = StatsFilterOperator.LESS_THAN, value_2: float = 2.0, value_max_2: float = 2.0)

Bases: object

getEnabled() → bool

setEnabled(value: bool) → None

getFilterVariableIndex() → int

setFilterVariableIndex(value: int) → None

getOperator() → StatsFilterOperator

setOperator(value: StatsFilterOperator) → None

getValue() → float

setValue(value: float) → None

getValueMax() → float

setValueMax(value: float) → None

getCombineOperator() → StatsFilterSecondaryOperator

setCombineOperator(value: StatsFilterSecondaryOperator) → None

getFilterVariableIndex2() → int

setFilterVariableIndex2(value: int) → None

getOperator2() → StatsFilterOperator

setOperator2(value: StatsFilterOperator) → None

getValue2() → float

setValue2(value: float) → None

getValueMax2() → float

setValueMax2(value: float) → None

class StatisticsVariableInfo(index: int, name: str)

Bases: object

getIndex() → int

getName() → str

class GraphPoint(x: float, y: float)

Bases: object

getX() → float

getY() → float

class PlotSeries(series_name: str, points: list[GraphPoint])

Bases: object

getSeriesName() → str

getPoints() → list[GraphPoint]

class StatisticsPlotResult(series: list[PlotSeries], x_axis_title: str = '', y_axis_title: str = '')

Bases: object

getSeries() → list[PlotSeries]

getXAxisTitle() → str

getYAxisTitle() → str

class HistogramPlotOptions(data_to_plot_index: int, num_bins: int = 30, filter: StatsFilter | None = None)

Bases: object

getDataToPlotIndex() → int

setDataToPlotIndex(value: int) → None

getNumBins() → int

setNumBins(value: int) → None

getFilter() → StatsFilter

setFilter(value: StatsFilter) → None

class CumulativePlotOptions(data_to_plot_index: int, num_bins: int = 30)

Bases: object

getDataToPlotIndex() → int

setDataToPlotIndex(value: int) → None

getNumBins() → int

setNumBins(value: int) → None

class ScatterPlotOptions(horizontal_axis_variable_index: int, vertical_axis_variable_index: int, hyd_query_indices: list[int] | None = None, filter: StatsFilter | None = None)

Bases: object

getHorizontalAxisVariableIndex() → int

setHorizontalAxisVariableIndex(value: int) → None

getVerticalAxisVariableIndex() → int

setVerticalAxisVariableIndex(value: int) → None

getHydQueryIndices() → list[int]

setHydQueryIndices(value: list[int]) → None

getFilter() → StatsFilter

setFilter(value: StatsFilter) → None

class SensitivityPlotOptions(sensitivity_variable_indices: list[int], analysis_method_index: int = -1)

Bases: object

getSensitivityVariableIndices() → list[int]

setSensitivityVariableIndices(value: list[int]) → None

getAnalysisMethodIndex() → int

setAnalysisMethodIndex(value: int) → None

class ConvergencePlotOptions(data_to_plot_index: int, criterion: ConvergenceCriterion = ConvergenceCriterion.FOS_MEAN)

Bases: object

getDataToPlotIndex() → int

setDataToPlotIndex(value: int) → None

getCriterion() → ConvergenceCriterion

setCriterion(value: ConvergenceCriterion) → None

class StatisticsExportColumn(header: str, values: list[float])

Bases: object

getHeader() → str

getValues() → list[float]

class StatisticsExportData(header_row_1: list[str], header_row_2: list[str], columns: list[StatisticsExportColumn])

Bases: object

getHeaderRow1() → list[str]

getHeaderRow2() → list[str]

getColumns() → list[StatisticsExportColumn]