py_monitoring_gui

Enums

ApproximatingCOPMatrixIndicesType
TotalEffects
MainEffects
Interactions
ApproximationHistoryMode
Responses
Criteria
CoIVisualPolynomBasisTypes
Automatic
Linear
LinearMixed
Quadratic
QuadraticMixed
CoPMatrixClassicIndicesType
TotalEffects
MainEffects
Interactions
CoPMatrixClassicObjectTextOrientation
Automatic
Horizontal
Vertical
CoPMatrixIndicesType
TotalEffects
MainEffects
Interactions
CoPMatrixObjectTextOrientation
Automatic
Horizontal
Vertical
ExtendedCorrelationMatrixViewTypes
All_Correlations
Correlations_vs_Anthills
Anthills_vs_Correlations
All_Anthills
PathBasedVisualTypes
Files
Processes
RegressionType
NoRegression
LinearRegression
QuadraticRegression
ResponseSurfacePaletteData
Values
CoP
RMSE
Error
AbsError
SPDensity
StatisticAnalysisBoxType
None
Probability
MeanStddev
StatisticAnalysisLimitsType
None
Lines
StackedBar
StatisticAnalysisScalingType
None
MinMax
MeanStddev
StatisticAnalysisWhiskerType
None
Probability
MeanStddev

Classes

Anthill

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

Methods

get_actual_dimensions

get_actual_dimensions() -> DimensionVector


Return the actual visible dimensions as vector.

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_palette_preset_names

get_palette_preset_names() -> list


Get a list of available palette preset names.

get_regression_coefficients

get_regression_coefficients() -> list


Return the coefficients of a chosen Regression as list.
Dependent to chosen Regression type linear or quadratic, the list is 2 or 3 entries long.
For a + b*x you get [a,b], for a + b*x + c*x*x yout get [a,b,c].
In case of non valid regression you get an empty list.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

has_legend

has_legend() -> bool



reset_palette_limits

reset_palette_limits() -> None


ReSet the minimum and maximum values of palette to default.

reset_palette_maximum

reset_palette_maximum() -> None


Reset the maximum value of palette.

reset_palette_minimum

reset_palette_minimum() -> None


Reset the minimum value of palette.

set_abscissa

set_abscissa( (Dimension)arg2) -> None


deprecated - use set_dimension_at_index(0, ... ) instead.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_dimension_for_color

set_dimension_for_color( (Dimension)color) -> None


Set the additional dimension to be shown as color.

set_dimension_for_size

set_dimension_for_size( (Dimension)size) -> None


Set the additional dimension to be shown as symbol_size.

set_dimensions

set_dimensions( (Dimension)x_axis_dimension, (Dimension)y_axis_dimension) -> None


Set the dimensions to be shown in visual.

set_legend_font_size

set_legend_font_size( (int)font_size) -> None


Set the font_size used in legend.

set_legend_position

set_legend_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_size

set_legend_size( (float)width, (float)height [, (bool)relative=False]) -> None


Set the size of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_visible

set_legend_visible( (bool)enabled) -> None


Set legend visibilty to True or False.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_log_x_axis

set_log_x_axis( (bool)enabled) -> None


Set the x-axis to show values logarithmic. Will be ignored if data range contains values <=0.

set_log_y_axis

set_log_y_axis( (bool)enabled) -> None


Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0

set_ordinate

set_ordinate( (Dimension)arg2) -> None


deprecated - use set_dimension_at_index(1, ... ) instead.

set_palette_limits

set_palette_limits( (float)minimum, (float)maximum) -> None


Set the minimum and maximum values of palette.

set_palette_maximum

set_palette_maximum( (float)maximum) -> None


Set the maximum value of palette.

set_palette_minimum

set_palette_minimum( (float)minimum) -> None


Set the minimum value of palette.

set_palette_preset

set_palette_preset( (str)name) -> None


Set palette preset with given name.

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_regression

set_regression( (RegressionType)arg2) -> None


Set regression

set_symbol_size

set_symbol_size( (float)symbol_size) -> None


Set the symbol size at the visual.

set_x_axis_format

set_x_axis_format( (str)x_axis_format) -> None


Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_format

set_y_axis_format( (str)y_axis_format) -> None


Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

SetAbscissa

SetDimensionForColor

SetDimensionForSize

SetDimensions

SetOrdinate

unset_dimension_for_color

unset_dimension_for_color() -> None


Unset the color dimension.

unset_dimension_for_size

unset_dimension_for_size() -> None


Unset the color dimension.

UnsetDimensionForColor

UnsetDimensionForSize

update_plot

update_plot() -> None


Trigger an additional update on visual.

ApproxDesignTable

Member class of: Visuals

Inherits from: Visual

Methods

ApproximationHistory

Member class of: Visuals

Inherits from: OSLMVisual

Methods

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

has_legend

has_legend() -> bool



set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_legend_font_size

set_legend_font_size( (int)font_size) -> None


Set the font_size used in legend.

set_legend_position

set_legend_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_size

set_legend_size( (float)width, (float)height [, (bool)relative=False]) -> None


Set the size of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_visible

set_legend_visible( (bool)enabled) -> None


Set legend visibilty to True or False.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_log_y_axis

set_log_y_axis( (bool)enabled) -> None


Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0

set_mode

set_mode( (ApproximationHistoryMode)arg2) -> None


Toggle the view between responses and criteria

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_show_all_results

set_show_all_results( (bool)arg2) -> None


Set true to show all results

set_show_minimal_local_cop_values

set_show_minimal_local_cop_values( (bool)arg2) -> None


Set true to additionally show minimum local cop values

set_symbol_size

set_symbol_size( (float)symbol_size) -> None


Set the symbol size at the visual.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_format

set_y_axis_format( (str)y_axis_format) -> None


Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

update_plot

update_plot() -> None


Trigger an additional update on visual.

ApproxModelInfo

Member class of: Visuals

Inherits from: Visual

Constructors

Methods

export

export( (Path)file_path [, (bool)transparent [, (int)_quality]]) -> None


Export the visual as picture to file position given as path.
Transparency produces plot with transparent background which is available when having picture types supporting this, like png.
Quality is available for jpg, determining the quality of the output in percent [0:100].

----

export( (str)file_path [, (bool)transparent [, (int)_quality]]) -> None


Export the visual as picture to file position given as string.
Transparency produces plot with transparent background which is available when having picture types supporting this, like png.
Quality is available for jpg, determining the quality of the output in percent [0:100].

export_data

export_data( (Path)file_path [, (str)format_string]) -> None


Export the visual as ascii with given format_string to file position given as path.
If format_string is left empty, "%g" is been taken.

----

export_data( (str)file_path [, (str)format_string]) -> None


Export the visual as ascii with given format_string to file position given as string.
If format_string is left empty, "%g" is been taken.

set_font_size

set_font_size( (int)arg2) -> None


Set the font size at the visual.

BoxWhisker

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

Methods

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

has_legend

has_legend() -> bool



set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_box_probability_content

set_box_probability_content( (float)box_probability_content) -> None


Set the probability content for the box. Box goes from median-content*0.5 to median+content*0.5.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_group

set_group( (str)group_name) -> None


Set the group to be shown

set_legend_font_size

set_legend_font_size( (int)font_size) -> None


Set the font_size used in legend.

set_legend_position

set_legend_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_size

set_legend_size( (float)width, (float)height [, (bool)relative=False]) -> None


Set the size of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_visible

set_legend_visible( (bool)enabled) -> None


Set legend visibilty to True or False.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_scale

set_scale( (bool)scale) -> None


Scale to min/max.

set_show_box

set_show_box( (bool)show) -> None


Show box.

set_show_limits

set_show_limits( (bool)show) -> None


Show limits.

set_show_samples

set_show_samples( (bool)show_samples) -> None


Show sample points.

set_show_whisker

set_show_whisker( (bool)show) -> None


Show whisker.

set_symbol_size

set_symbol_size( (float)symbol_size) -> None


Set the symbol size at the visual.

set_whisker_probability_content

set_whisker_probability_content( (float)whisker_probability_content) -> None


Set the probability content for the whisker. Whisker goes from median-content*0.5 to median+content*0.5.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_format

set_y_axis_format( (str)y_axis_format) -> None


Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

update_plot

update_plot() -> None


Trigger an additional update on visual.

Cloud

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

Methods

get_actual_dimensions

get_actual_dimensions() -> DimensionVector


Return the actual visible dimensions as vector.

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_palette_preset_names

get_palette_preset_names() -> list


Get a list of available palette preset names.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

get_z_axis_label

get_z_axis_label() -> str


Get the z axis label.

has_legend

has_legend() -> bool



reset_palette_limits

reset_palette_limits() -> None


ReSet the minimum and maximum values of palette to default.

reset_palette_maximum

reset_palette_maximum() -> None


Reset the maximum value of palette.

reset_palette_minimum

reset_palette_minimum() -> None


Reset the minimum value of palette.

set_abscissa

set_abscissa( (Dimension)arg2) -> None


deprecated - use set_dimension_at_index(0, ... ) instead.

set_alpha

set_alpha( (float)alpha_angle) -> None


Set the first angle for an rotation based on Euler angles z-x'-z''.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_beta

set_beta( (float)beta_angle) -> None


Set the second angle for an rotation based on Euler angles z-x'-z''.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_dimension_for_color

set_dimension_for_color( (Dimension)color) -> None


Set the additional dimension to be shown as color.

set_dimension_for_size

set_dimension_for_size( (Dimension)size) -> None


Set the additional dimension to be shown as symbol_size.

set_dimensions

set_dimensions( (Dimension)x_axis_dimension, (Dimension)y_axis_dimension, (Dimension)z_axis_dimension) -> None


Set the dimensions to be shown in visual.

set_gamma

set_gamma( (float)gamma_angle) -> None


Set the third angle for an rotation based on Euler angles z-x'-z''.

set_legend_font_size

set_legend_font_size( (int)font_size) -> None


Set the font_size used in legend.

set_legend_position

set_legend_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_size

set_legend_size( (float)width, (float)height [, (bool)relative=False]) -> None


Set the size of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_visible

set_legend_visible( (bool)enabled) -> None


Set legend visibilty to True or False.

set_lighting_enabled

set_lighting_enabled( (bool)enabled) -> None


Set lighting enabled state to True or False.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_lines_enabled

set_lines_enabled( (bool)enabled) -> None


Set lines enabled state to True or False.

set_log_x_axis

set_log_x_axis( (bool)enabled) -> None


Set the x-axis to show values logarithmic. Will be ignored if data range contains values <=0.

set_log_y_axis

set_log_y_axis( (bool)enabled) -> None


Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0

set_log_z_axis

set_log_z_axis( (bool)enabled) -> None


Set the z-axis to show values logarithmic. Will be ignored if data range contains values <=0

set_ordinate

set_ordinate( (Dimension)arg2) -> None


deprecated - use set_dimension_at_index(1, ... ) instead.

set_palette_limits

set_palette_limits( (float)minimum, (float)maximum) -> None


Set the minimum and maximum values of palette.

set_palette_maximum

set_palette_maximum( (float)maximum) -> None


Set the maximum value of palette.

set_palette_minimum

set_palette_minimum( (float)minimum) -> None


Set the minimum value of palette.

set_palette_position

set_palette_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_preset

set_palette_preset( (str)name) -> None


Set palette preset with given name.

set_palette_size

set_palette_size( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the size of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_visible

set_palette_visible( (bool)enabled) -> None


Set palette visibility to True or False.

set_regression

set_regression( (RegressionType)arg2) -> None


Set regression

set_surfaces_enabled

set_surfaces_enabled( (bool)enabled) -> None


Set surfaces enabled state to True or False.

set_symbol_size

set_symbol_size( (float)symbol_size) -> None


Set the symbol size at the visual.

set_x_axis_format

set_x_axis_format( (str)x_axis_format) -> None


Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_format

set_y_axis_format( (str)y_axis_format) -> None


Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

set_z_axis

set_z_axis( (Dimension)arg2) -> None


deprecated - use set_dimension_at_index(2, ... ) instead.

set_z_axis_format

set_z_axis_format( (str)z_axis_format) -> None


Set the axis format for z axis. Will be ignored if log axis is been chosen for z-axis.

set_z_axis_label

set_z_axis_label( (str)label_z) -> None


Set the z axis label.

SetAbscissa

SetDimensionForColor

SetDimensionForSize

SetDimensions

SetOrdinate

SetZAxis

unset_dimension_for_color

unset_dimension_for_color() -> None


Unset the color dimension.

unset_dimension_for_size

unset_dimension_for_size() -> None


Unset the color dimension.

UnsetDimensionForColor

UnsetDimensionForSize

update_plot

update_plot() -> None


Trigger an additional update on visual.

CoI

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

Methods

get_actual_dimension

get_actual_dimension() -> Dimension


Return the actual visible dimension.

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_palette_preset_names

get_palette_preset_names() -> list


Get a list of available palette preset names.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

ListenToDimensionIndex

reset_palette_limits

reset_palette_limits() -> None


ReSet the minimum and maximum values of palette to default.

reset_palette_maximum

reset_palette_maximum() -> None


Reset the maximum value of palette.

reset_palette_minimum

reset_palette_minimum() -> None


Reset the minimum value of palette.

set_adjusted

set_adjusted( (bool)adjust) -> None


Toggle the view to show adjusted values.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_inverted

set_inverted( (bool)invert) -> None


Toggle the view to show ( value ) or ( CoD - value ).

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_palette_limits

set_palette_limits( (float)minimum, (float)maximum) -> None


Set the minimum and maximum values of palette.

set_palette_maximum

set_palette_maximum( (float)maximum) -> None


Set the maximum value of palette.

set_palette_minimum

set_palette_minimum( (float)minimum) -> None


Set the minimum value of palette.

set_palette_position

set_palette_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_preset

set_palette_preset( (str)name) -> None


Set palette preset with given name.

set_palette_size

set_palette_size( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the size of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_visible

set_palette_visible( (bool)enabled) -> None


Set palette visibility to True or False.

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_type

set_type( (CoIVisualPolynomBasisTypes)coi_type) -> None


Set the type of coi calculation, where CoIVisualPolynomBasisTypes.
Automatic means that the best found model is been taken for calculation.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

SetAdjusted

SetDimension

SetInverted

SetType

update_plot

update_plot() -> None


Trigger an additional update on visual.

ConvenienceGUI

Constructors

CoP

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

Methods

get_actual_dimension

get_actual_dimension() -> Dimension


Return the actual visible dimension.

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_palette_preset_names

get_palette_preset_names() -> list


Get a list of available palette preset names.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

ListenToDimensionIndex

reset_palette_limits

reset_palette_limits() -> None


ReSet the minimum and maximum values of palette to default.

reset_palette_maximum

reset_palette_maximum() -> None


Reset the maximum value of palette.

reset_palette_minimum

reset_palette_minimum() -> None


Reset the minimum value of palette.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_filter_limit

set_filter_limit( (float)filter_value[%]) -> None


Set the limit below which the single CoP values are filtered in percent.

set_filtered

set_filtered( (bool)arg2) -> None



set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_palette_limits

set_palette_limits( (float)minimum, (float)maximum) -> None


Set the minimum and maximum values of palette.

set_palette_maximum

set_palette_maximum( (float)maximum) -> None


Set the maximum value of palette.

set_palette_minimum

set_palette_minimum( (float)minimum) -> None


Set the minimum value of palette.

set_palette_position

set_palette_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_preset

set_palette_preset( (str)name) -> None


Set palette preset with given name.

set_palette_size

set_palette_size( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the size of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_visible

set_palette_visible( (bool)enabled) -> None


Set palette visibility to True or False.

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_show_interactions

set_show_interactions( (bool)show) -> None


Toggle view to see "Main effect" and "Interaction " values additional to "Total effect" values.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

SetDimension

SetFiltered

update_plot

update_plot() -> None


Trigger an additional update on visual.

CoPMatrix

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

Methods

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_palette_preset_names

get_palette_preset_names() -> list


Get a list of available palette preset names.

reset_palette_limits

reset_palette_limits() -> None


ReSet the minimum and maximum values of palette to default.

reset_palette_maximum

reset_palette_maximum() -> None


Reset the maximum value of palette.

reset_palette_minimum

reset_palette_minimum() -> None


Reset the minimum value of palette.

set_approximation_line_width_scale

set_approximation_line_width_scale( (float)line_width_scale) -> None


Set line width scale with which the approximation line is shown.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_axes_rotation_enabled

set_axes_rotation_enabled( (bool)enable) -> None


Set axes rotation enabled.

set_axes_rotation_orthogonal

set_axes_rotation_orthogonal( (bool)enable) -> None


Set rotation angles to 0 degree if enough space for text exist, else to 90.

set_axes_rotation_x_angle

set_axes_rotation_x_angle( (float)angle) -> None


Set the rotation angle for x-axis.

set_axes_rotation_y_angle

set_axes_rotation_y_angle( (float)angle) -> None


Set the rotation angle for x-axis.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_filter_limit

set_filter_limit( (float)filter_limit[%]) -> None


Set the limit below which the values are filtered in percent.

set_filter_total_limit

set_filter_total_limit( (float)total_filter_value[%]) -> None


Set the limit below which the total CoP values ( ModelCoP's ) are filtered in percent.

set_indices_type

set_indices_type( (CoPMatrixIndicesType)indices_type) -> None


Toggle the view to see "Total effects", "Main effects" or "Interactions" in matrix.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_object_text_orientation

set_object_text_orientation( (CoPMatrixObjectTextOrientation)orientation) -> None


Toggle to change orientation of object text on tiles
Automatic : horizontal if enough space, else vertical is tested
Horizontal : ever show text horizontal
Vertical : ever show text vertical.

set_palette_limits

set_palette_limits( (float)minimum, (float)maximum) -> None


Set the minimum and maximum values of palette.

----

set_palette_limits( (float)minimum, (float)maximum) -> None


Set the minimum and maximum values of palette.

set_palette_maximum

set_palette_maximum( (float)maximum) -> None


Set the maximum value of palette.

set_palette_minimum

set_palette_minimum( (float)minimum) -> None


Set the minimum value of palette.

set_palette_position

set_palette_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_preset

set_palette_preset( (str)name) -> None


Set palette preset with given name.

set_palette_size

set_palette_size( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the size of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_visible

set_palette_visible( (bool)enabled) -> None


Set palette visibility to True or False.

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_resolution

set_resolution( (int)resolution) -> None


Set resolution of approximation line..

set_show_additional_points

set_show_additional_points( (bool)show) -> None


Show additional points in tiles.

set_show_approximated_points

set_show_approximated_points( (bool)show) -> None


Show approximated points in tiles.

set_show_approximation

set_show_approximation( (bool)show) -> None


Show approximation line in tiles.

set_show_background_cop

set_show_background_cop( (bool)show) -> None


Show background color in tiles.

set_show_cop

set_show_cop( (bool)show) -> None


Show cop value in tiles.

set_show_deactivated_support_points

set_show_deactivated_support_points( (bool)show) -> None


Show deactivated supports points in tiles.

set_show_extended

set_show_extended( (bool)show) -> None


Show matrix in extended mode with response surface 2d plots in tiles.

set_show_filtered

set_show_filtered( (bool)show) -> None


Show all cop values including these filtered by mop.

set_show_grid

set_show_grid( (bool)show) -> None


Show grid in tiles.

set_show_parameter_line

set_show_parameter_line( (bool)show) -> None


Show parameter line in tiles.

set_show_round_corners

set_show_round_corners( (bool)show) -> None


Show tile with round corners or as squares.

set_show_selection

set_show_selection( (bool)show) -> None


Show selection lines in grid plot.

set_show_support_points

set_show_support_points( (bool)show) -> None


Show support points in tiles.

set_symbol_size

set_symbol_size( (float)symbol_size) -> None


Set the symbol size at the visual.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

update_plot

update_plot() -> None


Trigger an additional update on visual.

CoPMatrixClassic

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

Methods

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_palette_preset_names

get_palette_preset_names() -> list


Get a list of available palette preset names.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

reset_palette_limits

reset_palette_limits() -> None


ReSet the minimum and maximum values of palette to default.

reset_palette_maximum

reset_palette_maximum() -> None


Reset the maximum value of palette.

reset_palette_minimum

reset_palette_minimum() -> None


Reset the minimum value of palette.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_axes_rotation_enabled

set_axes_rotation_enabled( (bool)enable) -> None


Set axes rotation enabled.

set_axes_rotation_orthogonal

set_axes_rotation_orthogonal( (bool)enable) -> None


Set rotation angles to 0 degree if enough space for text exist, else to 90.

set_axes_rotation_x_angle

set_axes_rotation_x_angle( (float)angle) -> None


Set the rotation angle for x-axis.

set_axes_rotation_y_angle

set_axes_rotation_y_angle( (float)angle) -> None


Set the rotation angle for x-axis.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_filter_limit

set_filter_limit( (float)filter_limit[%]) -> None


Set the limit below which the values are filtered in percent.

set_filter_total_limit

set_filter_total_limit( (float)total_filter_value[%]) -> None


Set the limit below which the total CoP values ( ModelCoP's ) are filtered in percent.

set_indices_type

set_indices_type( (CoPMatrixClassicIndicesType)indices_type) -> None


Toggle the view to see "Total effects", "Main effects" or "Interactions" in matrix.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_object_text_orientation

set_object_text_orientation( (CoPMatrixClassicObjectTextOrientation)orientation) -> None


Toggle to change orientation of object text on tiles
Automatic : horizontal if enough space, else vertical is tested
Horizontal : ever show text horizontal
Vertical : ever show text vertical.

set_palette_limits

set_palette_limits( (float)minimum, (float)maximum) -> None


Set the minimum and maximum values of palette.

set_palette_maximum

set_palette_maximum( (float)maximum) -> None


Set the maximum value of palette.

set_palette_minimum

set_palette_minimum( (float)minimum) -> None


Set the minimum value of palette.

set_palette_position

set_palette_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_preset

set_palette_preset( (str)name) -> None


Set palette preset with given name.

set_palette_size

set_palette_size( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the size of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_visible

set_palette_visible( (bool)enabled) -> None


Set palette visibility to True or False.

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

update_plot

update_plot() -> None


Trigger an additional update on visual.

CorrelationCoefficient

Member class of: Visuals

Inherits from: OSLMVisual

Methods

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_palette_preset_names

get_palette_preset_names() -> list


Get a list of available palette preset names.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

ListenToDimensionIndex

reset_palette_limits

reset_palette_limits() -> None


ReSet the minimum and maximum values of palette to default.

reset_palette_maximum

reset_palette_maximum() -> None


Reset the maximum value of palette.

reset_palette_minimum

reset_palette_minimum() -> None


Reset the minimum value of palette.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_palette_limits

set_palette_limits( (float)minimum, (float)maximum) -> None


Set the minimum and maximum values of palette.

set_palette_maximum

set_palette_maximum( (float)maximum) -> None


Set the maximum value of palette.

set_palette_minimum

set_palette_minimum( (float)minimum) -> None


Set the minimum value of palette.

set_palette_position

set_palette_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_preset

set_palette_preset( (str)name) -> None


Set palette preset with given name.

set_palette_size

set_palette_size( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the size of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_visible

set_palette_visible( (bool)enabled) -> None


Set palette visibility to True or False.

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

SetDimension

update_plot

update_plot() -> None


Trigger an additional update on visual.

CriteriaValues

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

Methods

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

update_plot

update_plot() -> None


Trigger an additional update on visual.

CustomData

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

Methods

add_data

add_data( (str)layer_name, (PyOSDesignEntry)data, (StyleList)style_vector, (WStrList)channel_names, (CustomData_Type)Vizualisation_type [, (bool)show_channels_signal_like=True [, (float)palette_minimum_for_grid=nan [, (float)palette_maximum_for_grid=nan]]]) -> bool


Add data as new layer to the Visual.

add_eval_mesh

add_eval_mesh( (str)layer_name, (doubleVec)x vector, (doubleVec)y vector, (doubleVec)color values [, (float)palette minimum=nan [, (float)palette maximum=nan]]) -> bool


Add data as new eval mesh layer to the Visual.

add_grid

add_grid( (str)layer_name, (PyOSDesignEntry)data [, (float)palette_minimum=nan [, (float)palette_maximum=nan]]) -> bool


Add data as new grid layer to the Visual.

add_mesh

add_mesh( (str)layer_name, (doubleVec)x vector, (doubleVec)y vector, (StyleList)style_vector [, (bool)single triangles=True]) -> bool


Add data as new mesh layer to the Visual.
If single_triangles=True, length of vectors has to be multiple size of 3 and equal. Produces single triangles.
If single_triangles=False, then a colored stripe is been produced. Sizes has to be equal or greater equal than 3.

clear_data

clear_data() -> None


Remove all layers.

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_palette_preset_names

get_palette_preset_names() -> list


Get a list of available palette preset names.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

has_legend

has_legend() -> bool



reset_palette_limits

reset_palette_limits() -> None


ReSet the minimum and maximum values of palette to default.

reset_palette_maximum

reset_palette_maximum() -> None


Reset the maximum value of palette.

reset_palette_minimum

reset_palette_minimum() -> None


Reset the minimum value of palette.

set_alt_axis

set_alt_axis( (int)axis, (WStrList)_labels, (doubleVec)ticks [, (float)rotation=nan]) -> None


Set an alternate axis to index (0 == x, 1== y, 2==z).
With labels as string_list, axes_ticks as vector, and an optional rotation_angle

set_axes_enabled

set_axes_enabled( (bool)arg2) -> None



set_background_color

set_background_color( (float)arg2, (float)arg3, (float)arg4, (float)arg5) -> None


Change the background color.

set_bar_width

set_bar_width( (str)layer_name, (float)bar_width) -> None


Set the width for StackedBar and Box (others will be ignored).
Senseful ranges between 1.0 (no space between bars) and 0.0 (bar is only a thin line).
When the value is greater than 1.0 bars overlap.

set_box_show_mean_and_median

set_box_show_mean_and_median( (str)layer_name, (bool)show_mean) -> None


Toggle visibility of 'Mean' point additional to 'Median' line, if enough data_points are given.

set_box_show_whisker

set_box_show_whisker( (str)layer_name, (bool)show_whisker) -> None


Toggle visibility of BoxPlot's outer lines (whisker).

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_iso_line_heights

set_iso_line_heights( (str)layer_name, (str)iso_lines_string) -> None


Set the iso_lines given as string with delimiters space and ',' and ';' . Does only have effect when showing eval_mesh in this layer.

----

set_iso_line_heights( (str)layer_name, (doubleVec)iso_lines) -> None


Set the iso lines as vector for given layer. Does only have effect when showing eval_mesh in this layer.

set_legend_font_size

set_legend_font_size( (int)font_size) -> None


Set the font_size used in legend.

set_legend_position

set_legend_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_size

set_legend_size( (float)width, (float)height [, (bool)relative=False]) -> None


Set the size of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_visible

set_legend_visible( (bool)enabled) -> None


Set legend visibilty to True or False.

set_line_width

set_line_width( (float)arg2) -> None



set_lines_enabled

set_lines_enabled( (bool)arg2) -> None



set_log_x_axis

set_log_x_axis( (bool)arg2) -> None



set_log_y_axis

set_log_y_axis( (bool)arg2) -> None



set_object_text

set_object_text( (str)arg2, (WStrList)arg3, (int)arg4, (int)arg5) -> None


Set the object text (e.g. on bars), from given list, spread to matrix when column is greater than 1 (e.g. multibar).

set_palette_caption

set_palette_caption( (str)layer_name, (str)caption) -> None


Set the caption to the palette for given layer.

set_palette_limits

set_palette_limits( (float)minimum, (float)maximum) -> None


Set the minimum and maximum values of palette.

set_palette_maximum

set_palette_maximum( (float)maximum) -> None


Set the maximum value of palette.

set_palette_minimum

set_palette_minimum( (float)minimum) -> None


Set the minimum value of palette.

set_palette_position

set_palette_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_preset

set_palette_preset( (str)name) -> None


Set palette preset with given name.

set_palette_size

set_palette_size( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the size of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_visible

set_palette_visible( (bool)arg2) -> None



set_ranges_x

set_ranges_x( (float)arg2, (float)arg3) -> None



set_ranges_y

set_ranges_y( (float)arg2, (float)arg3) -> None



set_selection_color

set_selection_color( (str)arg2, (int)arg3, (int)arg4, (int)arg5, (int)arg6) -> None


Set the selection color.

set_selection_text

set_selection_text( (str)arg2, (WStrList)arg3) -> None


Set the selection text (e.g. on points, shown when selected), from given list.

set_surfaces_enabled

set_surfaces_enabled( (bool)arg2) -> None



set_symbol_size

set_symbol_size( (float)arg2) -> None



set_x_axis_format

set_x_axis_format( (str)arg2) -> None



set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_format

set_y_axis_format( (str)arg2) -> None



set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

unset_alt_axis

unset_alt_axis( (int)arg2) -> None


Unset the alternate axis at index (0 == x, 1== y, 2==z) to default float axis

unset_background_color

unset_background_color() -> None


Reset background color to default [0.9,0.9,0.9,1.0].

unset_object_text

unset_object_text( (str)arg2) -> None


Unset the object text.

update_plot

update_plot() -> None


Trigger an additional update on visual.

Design Comparison Plot

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

Methods

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_symbol_size

set_symbol_size( (float)symbol_size) -> None


Set the symbol size at the visual.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

update_plot

update_plot() -> None


Trigger an additional update on visual.

DesignTable

Member class of: Visuals

Inherits from: Visual

Constructors

Methods

DimensionId

Member class of: Visuals

Constructors

Methods

get_dimension_from_index

get_dimension_from_index( (int)ax_index) -> Dimension


Return the dimension set at ax_index, if exist, else return dimension().

get_dimension_id_from_index

get_dimension_id_from_index( (int)ax_index) -> int


Return the dimension_id set at ax_index, if exist, else return -1.

has_dimension_at_index

has_dimension_id_at_index

has_dimension_id_at_index( (int)ax_index) -> bool


Return True when the plot has a dimension_combo_box id set at ax_index.

has_dimension_set_at_index

has_dimension_set_at_index( (int)ax_index) -> bool


Return True when a dimension is set at ax-index of plot.

listen_to_dimension_index

listen_to_dimension_index( (int)arg2) -> None


deprecated - use set_dimension_id_at_index(0, ... ) instead.

reset_user_defined_variable_selection

reset_user_defined_variable_selection() -> None


Reset the previously made changes on dimension id to the predefined values, been saved at the visual on creation.

set_dimension

set_dimension( (Dimension)arg2) -> None


deprecated - use set_dimension_at_index(0, ... ) instead.

set_dimension_at_index

set_dimension_at_index( (int)ax_index, (Dimension)dimension_at_x_i) -> None


Set a dimension at given ax_index to plot.

set_dimension_id_at_index

set_dimension_id_at_index( (int)ax_index, (int)combo_box_id) -> None


Set a combo_box_id at ax_index.
Plot now shows content of belonging combo_box at ax_index.
e.g. SetDimensionToId(1,2) means that the plot now shows the chosen dimension from 3rd combo_box at y-axis.

unset_dimension_at_index

unset_dimension_at_index( (int)ax_index) -> None


Unset the dimension at given ax_index.
Plot now shows the predefined behavior.

unset_dimension_id_at_index

unset_dimension_id_at_index( (int)ax_index) -> None


Unset the dimension_id at given ax_index.
Plot now shows the predefined behavior.

ExtendedCoPMatrix

Member class of: Visuals

Inherits from: Visual

Methods

export

export( (Path)file_path [, (float)scale]) -> None


Export the visual as picture, with given relative scale to file position given as path.
If scale is left empty, 1.0 is been taken.

----

export( (Path)file_path, (int)width, (int)height) -> None


Export the visual as picture, with given absolute sizes to file position given as path.

set_auto_rotate_axis_labels_enabled

set_auto_rotate_axis_labels_enabled( (bool)enable) -> None


Enable/disable axis label auto rotation.

set_fix_projection_to_design

set_fix_projection_to_design( (bool)show) -> None


Enables/disables fix projection to designs.

set_indices_type

set_indices_type( (ApproximatingCOPMatrixIndicesType)indices_type) -> None


Toggle the view to see "Total effects", "Main effects" or "Interactions" in matrix.

set_limit_axis_label_size

set_limit_axis_label_size( (bool)enable) -> None


Limit axis label size.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_show_approximation

set_show_approximation( (bool)show) -> None


Show/hide approximation line.

set_show_background_cop

set_show_background_cop( (bool)show) -> None


Show/hide background COP.

set_show_cop

set_show_cop( (bool)show) -> None


Show/hide COP.

set_show_filtered

set_show_filtered( (bool)show) -> None


Show/hide filtered parameters/responses.

set_show_grid

set_show_grid( (bool)show) -> None


Show/hide grid.

set_show_parameter_line

set_show_parameter_line( (bool)show) -> None


Show/hide parameter line.

set_show_support_points

set_show_support_points( (bool)show) -> None


Show/hide support points.

set_symbol_size

set_symbol_size( (float)symbol_size) -> None


Set the symbol size at the visual.

set_use_rectangular_view

set_use_rectangular_view( (bool)show) -> None


Enables/disables rectangular view.

ExtendedCorrelationMatrix

Member class of: Visuals

Inherits from: Visual

Methods

export

export( (Path)file_path [, (float)scale [, (bool)transparent [, (int)quality]]]) -> None


Export the visual as picture, with given relative scale to file position given as path.
If scale is left empty, 1.0 is been taken.
Transparency produces plot with transparent background which is available when having picture types supporting this, like png.
Quality is available for jpg, determining the quality of the output in percent [0:100].

----

export( (Path)file_path, (int)width, (int)height [, (bool)transparent [, (int)quality]]) -> None


Export the visual as picture, with given absolute sizes to file position given as path.
Transparency produces plot with transparent background which is available when having picture types supporting this, like png.
Quality is available for jpg, determining the quality of the output in percent [0:100].

----

export( (str)file_path [, (float)scale [, (bool)transparent [, (int)quality]]]) -> None


Export the visual as picture, with given relative scale to file position given as string.
If scale is left empty, 1.0 is been taken.
Transparency produces plot with transparent background which is available when having picture types supporting this, like png.
Quality is available for jpg, determining the quality of the output in percent [0:100].

----

export( (str)file_path, (int)width, (int)height [, (bool)transparent [, (int)quality]]) -> None


Export the visual as picture, with given absolute sizes to file position given as string.
Transparency produces plot with transparent background which is available when having picture types supporting this, like png.
Quality is available for jpg, determining the quality of the output in percent [0:100].

export_data

export_data( (Path)file_path [, (str)format_string]) -> None


Export the visual as ascii with given format_string to file position given as path.
If format_string is left empty, "%g" is been taken.

----

export_data( (str)file_path [, (str)format_string]) -> None


Export the visual as ascii with given format_string to file position given as string.
If format_string is left empty, "%g" is been taken.

export_with_given_tile_sizes

export_with_given_tile_sizes( (Path)arg2, (int)arg3, (int)file_path [, (bool)tile_width [, (int)tile_height]]) -> None


Export the visual as picture, with given absolute tile sizes to file position given as path.

----

export_with_given_tile_sizes( (str)arg2, (int)arg3, (int)file_path [, (bool)tile_width [, (int)tile_height]]) -> None


Export the visual as picture, with given absolute tile sizes to file position given as path.

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists.
Be aware that much memory can be allocated, in case of many dimensions.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_palette_preset_names

get_palette_preset_names() -> list


Get a list of available palette preset names.

get_sizes_with_given_tile_sizes

get_sizes_with_given_tile_sizes( (float)tile_width, (float)tile_height) -> list


Return list with size of plot when tiles have to be sized with x_tile_size and y_tile_size. Index 0 : width. index 1 : height.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

reset_palette_limits

reset_palette_limits() -> None


ReSet the minimum and maximum values of palette to default.

reset_palette_maximum

reset_palette_maximum() -> None


Reset the maximum value of palette.

reset_palette_minimum

reset_palette_minimum() -> None


Reset the minimum value of palette.

set_axes_rotation_enabled

set_axes_rotation_enabled( (bool)enable) -> None


Set axes rotation enabled.

set_axes_rotation_orthogonal

set_axes_rotation_orthogonal( (bool)enable) -> None


Set rotation angles to 0 degree if possible, else to 90.

set_axes_rotation_x_angle

set_axes_rotation_x_angle( (float)angle) -> None


Set the rotation angle for x-axis.

set_axes_rotation_y_angle

set_axes_rotation_y_angle( (float)angle) -> None


Set the rotation angle for y-axis.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_font_size

set_font_size( (int)arg2) -> None


Set the font size at the visual.

set_histogram_classes

set_histogram_classes( (int)classes) -> None


Set the number of histogram classes.

set_palette_limits

set_palette_limits( (float)minimum, (float)maximum) -> None


Set the minimum and maximum values of palette.

set_palette_maximum

set_palette_maximum( (float)maximum) -> None


Set the maximum value of palette.

set_palette_minimum

set_palette_minimum( (float)minimum) -> None


Set the minimum value of palette.

set_palette_position

set_palette_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_preset

set_palette_preset( (str)name) -> None


Set palette preset with given name.

set_palette_size

set_palette_size( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the size of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_visible

set_palette_visible( (bool)enabled) -> None


Set palette visibility to True or False.

set_symbol_size

set_symbol_size( (float)symbol_size) -> None


Set the symbol size at the visual.

set_view_type

set_view_type( (ExtendedCorrelationMatrixViewTypes)view_type) -> None


Change the view of the visual to show the entils as :
ExtendedCorrelationMatrixViewTypes.All_Correlations - correlation values in all entils
ExtendedCorrelationMatrixViewTypes.Correlations_vs_Anthills - correlation values in upper left part, histograms on main diagonal and anthills in lower right part.
ExtendedCorrelationMatrixViewTypes.Anthills_vs_Correlations - anthills in upper left part, histograms on main diagonal and correlation values in lower right part.
ExtendedCorrelationMatrixViewTypes.All_Anthills - histograms on main diagonal, elsewhere anthills.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

update_plot

update_plot() -> None


Trigger an additional update on visual.

Histogram

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

Methods

get_actual_dimension

get_actual_dimension() -> Dimension


Return the actual visible dimension.

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_statistical_data

get_statistical_data() -> list


Get statistical data as list of lists.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

has_legend

has_legend() -> bool



ListenToDimensionIndex

set_alpha

set_alpha( (float)alpha_value) -> None


Adjust the result wenn automatic fit is been chosen (actual when rv_types size is greater 1).

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_chi_2

set_chi_2( (bool)chi_flag) -> None


Adjust the result wenn automatic fit is been chosen (actual when rv_types size is greater 1).

set_fit_type

set_fit_type( (RandomVariableType)fit_type) -> None


Set a random variable type for the fit.

set_fit_type_to_automatic

set_fit_type_to_automatic() -> None


Set fit to automatic.

set_fit_type_to_none

set_fit_type_to_none() -> None


Set fit to none.

set_fit_types_for_automatic

set_fit_types_for_automatic( (RandomVariableTypeVec)rv_type) -> None


Set a vector of random variable types to be used for automatic fit.

set_histogram_classes

set_histogram_classes( (int)classes) -> None


Set the number of histogram classes.

set_legend_font_size

set_legend_font_size( (int)font_size) -> None


Set the font_size used in legend.

set_legend_position

set_legend_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_size

set_legend_size( (float)width, (float)height [, (bool)relative=False]) -> None


Set the size of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_visible

set_legend_visible( (bool)enabled) -> None


Set legend visibilty to True or False.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_lines_enabled

set_lines_enabled( (bool)enabled) -> None


Set lines enabled state to True or False.

set_probability_value

set_probability_value( (float)probability_value) -> None


Set probability value.

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_sigma_level

set_sigma_level( (float)sigma_level) -> None


Set sigma level for pdf.

set_surfaces_enabled

set_surfaces_enabled( (bool)enabled) -> None


Set surfaces enabled state to True or False.

set_x_axis_format

set_x_axis_format( (str)x_axis_format) -> None


Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_format

set_y_axis_format( (str)y_axis_format) -> None


Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

SetAlpha

SetChi2

SetDimension

show_as_cdf

show_as_cdf( (bool)show_as_cdf) -> None


Show histogram bars, defined pdf and fitted pdf as cdf.

show_defined_pdf

show_defined_pdf( (bool)show_defined_pdf) -> None


Show defined pdf.

show_limits

show_limits( (bool)sigma_level) -> None


Show limits.

show_probability

show_probability( (bool)show_probability) -> None


Show probability.

show_process_capability

show_process_capability( (bool)show_process_capability) -> None


Show process capability.

unset_fit_types_for_automatic

unset_fit_types_for_automatic() -> None


Unset the vector of random variable types to standard.

update_plot

update_plot() -> None


Trigger an additional update on visual.

History

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

Methods

get_actual_dimension

get_actual_dimension() -> Dimension


Return the actual visible dimension.

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

has_legend

has_legend() -> bool



set_abscissa

set_abscissa( (Dimension)arg2) -> None


deprecated - use set_dimension_at_index(0, ... ) instead.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_legend_font_size

set_legend_font_size( (int)font_size) -> None


Set the font_size used in legend.

set_legend_position

set_legend_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_size

set_legend_size( (float)width, (float)height [, (bool)relative=False]) -> None


Set the size of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_visible

set_legend_visible( (bool)enabled) -> None


Set legend visibilty to True or False.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_log_y_axis

set_log_y_axis( (bool)enabled) -> None


Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_symbol_size

set_symbol_size( (float)symbol_size) -> None


Set the symbol size at the visual.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_format

set_y_axis_format( (str)y_axis_format) -> None


Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

SetAbscissa

update_plot

update_plot() -> None


Trigger an additional update on visual.

MainWindow

iterable has_length

Inherits from: PyControlContainer

The main window holding monitoring visuals.

Constructors

Methods

build_mop

build_mop() -> None


Build an MOP with current settings

build_mop_save_as

build_mop_save_as( (Path)arg2) -> None


Build an MOP with current settings and write it to a new database

close

close( [, (int)arg2]) -> None



flush

flush() -> None


Process any pending events and flush main window to screen.
Use this functionality when changing data or setting to make shure, the changes are actually on-screen.
Particularily usefull when exporting pictures or animating visuals.

maximize

maximize() -> None


Maximize mainwindow.

save

save( (Path)arg2, (bool)arg3, (bool)arg4, (bool)arg5) -> bool


Create and Save an OMDB file with the current monitoring data

show_parameter_settings

show_parameter_settings( (bool)arg2) -> None


Show/Hide parameter settings widget.

show_preferences

show_preferences( (bool)arg2) -> None


Show/Hide preferences widget.

ShowParameterSettings

ShowPreferences

tile_subwindows

tile_subwindows() -> None


Arrange subwindows in a tile pattern.

New_ParallelCoordinatesPlot

Member class of: Visuals

Inherits from: Visual

Methods

export

export( (Path)file_path [, (float)scale [, (bool)transparent [, (int)quality]]]) -> None


Export the visual as picture, with given relative scale to file position given as path.
If scale is left empty, 1.0 is been taken.
Transparency produces plot with transparent background which is available when having picture types supporting this, like png.
Quality is available for jpg, determining the quality of the output in percent [0:100].

----

export( (Path)file_path, (int)width, (int)height [, (bool)transparent [, (int)quality]]) -> None


Export the visual as picture, with given absolute sizes to file position given as path.
Transparency produces plot with transparent background which is available when having picture types supporting this, like png.
Quality is available for jpg, determining the quality of the output in percent [0:100].

----

export( (str)file_path [, (float)scale [, (bool)transparent [, (int)quality]]]) -> None


Export the visual as picture, with given relative scale to file position given as string.
If scale is left empty, 1.0 is been taken.
Transparency produces plot with transparent background which is available when having picture types supporting this, like png.
Quality is available for jpg, determining the quality of the output in percent [0:100].

----

export( (str)file_path, (int)width, (int)height [, (bool)transparent [, (int)quality]]) -> None


Export the visual as picture, with given absolute sizes to file position given as string.
Transparency produces plot with transparent background which is available when having picture types supporting this, like png.
Quality is available for jpg, determining the quality of the output in percent [0:100].

export_data

export_data( (Path)file_path [, (str)format_string]) -> None


Export the visual as ascii with given format_string to file position given as path.
If format_string is left empty, "%g" is been taken.

----

export_data( (str)file_path [, (str)format_string]) -> None


Export the visual as ascii with given format_string to file position given as string.
If format_string is left empty, "%g" is been taken.

get_caption

get_caption() -> str


Get the caption.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_font_size

set_font_size( (int)arg2) -> None


Set the font size at the visual.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_symbol_size

set_symbol_size( (float)symbol_size) -> None


Set the symbol size at the visual.

OptimizationHistory

Member class of: Visuals

Inherits from: OSLMVisual

Methods

get_active_layer_names

get_active_layer_names() -> list


Get actual active layer names.

get_available_layer_names

get_available_layer_names() -> list


Get all possible layer names.

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

has_legend

has_legend() -> bool



set_all_layers_active_state

set_all_layers_active_state( (bool)arg2) -> None


Set active state of all layers.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_layer_active_state

set_layer_active_state( (str)arg2, (bool)arg3) -> None


Set active state of layer with given layer name.

set_layers_active_state

set_layers_active_state( (list)arg2, (bool)arg3) -> None


Set active state of layers with given layer names.

set_legend_font_size

set_legend_font_size( (int)font_size) -> None


Set the font_size used in legend.

set_legend_position

set_legend_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_size

set_legend_size( (float)width, (float)height [, (bool)relative=False]) -> None


Set the size of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_visible

set_legend_visible( (bool)enabled) -> None


Set legend visibilty to True or False.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_log_y_axis

set_log_y_axis( (bool)enabled) -> None


Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_format

set_y_axis_format( (str)y_axis_format) -> None


Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

update_plot

update_plot() -> None


Trigger an additional update on visual.

OSLMVisual

Inherits from: Visual

A visual displaying monitoring data in a certain way.

Constructors

Methods

export

export( (Path)file_path [, (float)scale [, (bool)transparent [, (int)quality [, (bool)watermark]]]]) -> None


Export the visual as picture, with given relative scale to file position given as path.
If scale is left empty, 1.0 is been taken.
Transparency produces plot with transparent background which is available when having picture types supporting this, like png.
Quality is available for jpg, determining the quality of the output in percent [0:100]. Set Watermark to True to export picture with watermark.

----

export( (Path)file_path, (int)width, (int)height [, (bool)transparent [, (int)quality [, (bool)watermark]]]) -> None


Export the visual as picture, with given absolute sizes to file position given as path.
Transparency produces plot with transparent background which is available when having picture types supporting this, like png.
Quality is available for jpg, determining the quality of the output in percent [0:100]. Set Watermark to True to export picture with watermark.

----

export( (str)file_path [, (float)scale [, (bool)transparent [, (int)quality [, (bool)watermark]]]]) -> None


Export the visual as picture, with given relative scale to file position given as string.
If scale is left empty, 1.0 is been taken.
Transparency produces plot with transparent background which is available when having picture types supporting this, like png.
Quality is available for jpg, determining the quality of the output in percent [0:100]. Set Watermark to True to export picture with watermark.

----

export( (str)file_path, (int)width, (int)height [, (bool)transparent [, (int)quality [, (bool)watermark]]]) -> None


Export the visual as picture, with given absolute sizes to file position given as string.
Transparency produces plot with transparent background which is available when having picture types supporting this, like png.
Quality is available for jpg, determining the quality of the output in percent [0:100]. Set Watermark to True to export picture with watermark.

export_data

export_data( (Path)file_path [, (str)format_string]) -> None


Export the visual as ascii with given format_string to file position given as path.
If format_string is left empty, "%g" is been taken.

----

export_data( (str)file_path [, (str)format_string]) -> None


Export the visual as ascii with given format_string to file position given as string.
If format_string is left empty, "%g" is been taken.

set_font_size

set_font_size( (int)arg2) -> None


Set the font size at the visual.

ParallelCoordinatesPlot

Member class of: Visuals

Inherits from: Visual

Methods

export

export( (Path)file_path [, (float)scale [, (bool)transparent [, (int)quality]]]) -> None


Export the visual as picture, with given relative scale to file position given as path.
If scale is left empty, 1.0 is been taken.
Transparency produces plot with transparent background which is available when having picture types supporting this, like png.
Quality is available for jpg, determining the quality of the output in percent [0:100].

----

export( (Path)file_path, (int)width, (int)height [, (bool)transparent [, (int)quality]]) -> None


Export the visual as picture, with given absolute sizes to file position given as path.
Transparency produces plot with transparent background which is available when having picture types supporting this, like png.
Quality is available for jpg, determining the quality of the output in percent [0:100].

----

export( (str)file_path [, (float)scale [, (bool)transparent [, (int)quality]]]) -> None


Export the visual as picture, with given relative scale to file position given as string.
If scale is left empty, 1.0 is been taken.
Transparency produces plot with transparent background which is available when having picture types supporting this, like png.
Quality is available for jpg, determining the quality of the output in percent [0:100].

----

export( (str)file_path, (int)width, (int)height [, (bool)transparent [, (int)quality]]) -> None


Export the visual as picture, with given absolute sizes to file position given as string.
Transparency produces plot with transparent background which is available when having picture types supporting this, like png.
Quality is available for jpg, determining the quality of the output in percent [0:100].

export_data

export_data( (Path)file_path [, (str)format_string]) -> None


Export the visual as ascii with given format_string to file position given as path.
If format_string is left empty, "%g" is been taken.

----

export_data( (str)file_path [, (str)format_string]) -> None


Export the visual as ascii with given format_string to file position given as string.
If format_string is left empty, "%g" is been taken.

get_caption

get_caption() -> str


Get the caption.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_font_size

set_font_size( (int)arg2) -> None


Set the font size at the visual.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_symbol_size

set_symbol_size( (float)symbol_size) -> None


Set the symbol size at the visual.

ParameterValues

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

Methods

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

update_plot

update_plot() -> None


Trigger an additional update on visual.

Parametrization

Member class of: Visuals

Inherits from: Visual

Constructors

Methods

Pareto2D

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

Methods

get_actual_dimensions

get_actual_dimensions() -> DimensionVector


Return the actual visible dimensions as vector.

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

has_legend

has_legend() -> bool



set_abscissa

set_abscissa( (Dimension)arg2) -> None


deprecated - use set_dimension_at_index(0, ... ) instead.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_dimensions

set_dimensions( (Dimension)x_axis_dimension, (Dimension)y_axis_dimension) -> None


Set the dimensions to be shown in visual.

set_legend_font_size

set_legend_font_size( (int)font_size) -> None


Set the font_size used in legend.

set_legend_position

set_legend_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_size

set_legend_size( (float)width, (float)height [, (bool)relative=False]) -> None


Set the size of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_visible

set_legend_visible( (bool)enabled) -> None


Set legend visibilty to True or False.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_log_x_axis

set_log_x_axis( (bool)enabled) -> None


Set the x-axis to show values logarithmic. Will be ignored if data range contains values <=0.

set_log_y_axis

set_log_y_axis( (bool)enabled) -> None


Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0

set_ordinate

set_ordinate( (Dimension)arg2) -> None


deprecated - use set_dimension_at_index(1, ... ) instead.

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_symbol_size

set_symbol_size( (float)symbol_size) -> None


Set the symbol size at the visual.

set_x_axis_format

set_x_axis_format( (str)x_axis_format) -> None


Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_format

set_y_axis_format( (str)y_axis_format) -> None


Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

SetAbscissa

SetDimensions

SetOrdinate

update_plot

update_plot() -> None


Trigger an additional update on visual.

Pareto3D

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

Methods

get_actual_dimensions

get_actual_dimensions() -> DimensionVector


Return the actual visible dimensions as vector.

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

get_z_axis_label

get_z_axis_label() -> str


Get the z axis label.

has_legend

has_legend() -> bool



set_abscissa

set_abscissa( (Dimension)arg2) -> None


deprecated - use set_dimension_at_index(0, ... ) instead.

set_alpha

set_alpha( (float)alpha_angle) -> None


Set the first angle for an rotation based on Euler angles z-x'-z''.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_beta

set_beta( (float)beta_angle) -> None


Set the second angle for an rotation based on Euler angles z-x'-z''.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_dimensions

set_dimensions( (Dimension)x_axis_dimension, (Dimension)y_axis_dimension, (Dimension)z_axis_dimension) -> None


Set the dimensions to be shown in visual.

set_gamma

set_gamma( (float)gamma_angle) -> None


Set the third angle for an rotation based on Euler angles z-x'-z''.

set_legend_font_size

set_legend_font_size( (int)font_size) -> None


Set the font_size used in legend.

set_legend_position

set_legend_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_size

set_legend_size( (float)width, (float)height [, (bool)relative=False]) -> None


Set the size of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_visible

set_legend_visible( (bool)enabled) -> None


Set legend visibilty to True or False.

set_lighting_enabled

set_lighting_enabled( (bool)enabled) -> None


Set lighting enabled state to True or False.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_lines_enabled

set_lines_enabled( (bool)enabled) -> None


Set lines enabled state to True or False.

set_log_x_axis

set_log_x_axis( (bool)enabled) -> None


Set the x-axis to show values logarithmic. Will be ignored if data range contains values <=0.

set_log_y_axis

set_log_y_axis( (bool)enabled) -> None


Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0

set_log_z_axis

set_log_z_axis( (bool)enabled) -> None


Set the z-axis to show values logarithmic. Will be ignored if data range contains values <=0

set_ordinate

set_ordinate( (Dimension)arg2) -> None


deprecated - use set_dimension_at_index(1, ... ) instead.

set_surfaces_enabled

set_surfaces_enabled( (bool)enabled) -> None


Set surfaces enabled state to True or False.

set_symbol_size

set_symbol_size( (float)symbol_size) -> None


Set the symbol size at the visual.

set_x_axis_format

set_x_axis_format( (str)x_axis_format) -> None


Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_format

set_y_axis_format( (str)y_axis_format) -> None


Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

set_z_axis

set_z_axis( (Dimension)arg2) -> None


deprecated - use set_dimension_at_index(2, ... ) instead.

set_z_axis_format

set_z_axis_format( (str)z_axis_format) -> None


Set the axis format for z axis. Will be ignored if log axis is been chosen for z-axis.

set_z_axis_label

set_z_axis_label( (str)label_z) -> None


Set the z axis label.

update_plot

update_plot() -> None


Trigger an additional update on visual.

PathBase

Member class of: Visuals

Inherits from: Visual

Methods

set_arguments

set_arguments( (str)arg2) -> None


Set the argument string, used by a process.

set_auto_insert_placeholders

set_auto_insert_placeholders( (bool)arg2) -> None


If placeholders (e.g. $DESIGN_DIR) should be inserted automatically.

set_path

set_path( (Path)arg2) -> None


Set the path to the image/process executable.

set_path_fixed

set_path_fixed( (bool)arg2) -> None


Set the path to the image/process executable. Contained placeholders will not be resolved.

SetPath

SetPathFixed

PCAData

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

Methods

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_palette_preset_names

get_palette_preset_names() -> list


Get a list of available palette preset names.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

reset_palette_limits

reset_palette_limits() -> None


ReSet the minimum and maximum values of palette to default.

reset_palette_maximum

reset_palette_maximum() -> None


Reset the maximum value of palette.

reset_palette_minimum

reset_palette_minimum() -> None


Reset the minimum value of palette.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_palette_limits

set_palette_limits( (float)minimum, (float)maximum) -> None


Set the minimum and maximum values of palette.

set_palette_maximum

set_palette_maximum( (float)maximum) -> None


Set the maximum value of palette.

set_palette_minimum

set_palette_minimum( (float)minimum) -> None


Set the minimum value of palette.

set_palette_position

set_palette_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_preset

set_palette_preset( (str)name) -> None


Set palette preset with given name.

set_palette_size

set_palette_size( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the size of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_visible

set_palette_visible( (bool)enabled) -> None


Set palette visibility to True or False.

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

update_plot

update_plot() -> None


Trigger an additional update on visual.

Probability

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

Methods

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

ListenToDimensionIndex

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_symbol_size

set_symbol_size( (float)symbol_size) -> None


Set the symbol size at the visual.

set_x_axis_format

set_x_axis_format( (str)x_axis_format) -> None


Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_format

set_y_axis_format( (str)y_axis_format) -> None


Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

update_plot

update_plot() -> None


Trigger an additional update on visual.

ReliAlgoInfo

Member class of: Visuals

Inherits from: Visual

Constructors

Methods

export

export( (Path)file_path [, (bool)transparent [, (int)_quality]]) -> None


Export the visual as picture to file position given as path.
Transparency produces plot with transparent background which is available when having picture types supporting this, like png.
Quality is available for jpg, determining the quality of the output in percent [0:100].

----

export( (str)file_path [, (bool)transparent [, (int)_quality]]) -> None


Export the visual as picture to file position given as string.
Transparency produces plot with transparent background which is available when having picture types supporting this, like png.
Quality is available for jpg, determining the quality of the output in percent [0:100].

export_data

export_data( (Path)file_path [, (str)format_string]) -> None


Export the visual as ascii with given format_string to file position given as path.
If format_string is left empty, "%g" is been taken.

----

export_data( (str)file_path [, (str)format_string]) -> None


Export the visual as ascii with given format_string to file position given as string.
If format_string is left empty, "%g" is been taken.

set_font_size

set_font_size( (int)arg2) -> None


Set the font size at the visual.

ReliAnthill

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

Methods

get_actual_dimensions

get_actual_dimensions() -> DimensionVector


Return the actual visible dimensions as vector.

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

has_legend

has_legend() -> bool



set_abscissa

set_abscissa( (Dimension)arg2) -> None


deprecated - use set_dimension_at_index(0, ... ) instead.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_dimensions

set_dimensions( (Dimension)x_axis_dimension, (Dimension)y_axis_dimension) -> None


Set the dimensions to be shown in visual.

set_legend_font_size

set_legend_font_size( (int)font_size) -> None


Set the font_size used in legend.

set_legend_position

set_legend_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_size

set_legend_size( (float)width, (float)height [, (bool)relative=False]) -> None


Set the size of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_visible

set_legend_visible( (bool)enabled) -> None


Set legend visibilty to True or False.

set_log_x_axis

set_log_x_axis( (bool)enabled) -> None


Set the x-axis to show values logarithmic. Will be ignored if data range contains values <=0.

set_log_y_axis

set_log_y_axis( (bool)enabled) -> None


Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0

set_ordinate

set_ordinate( (Dimension)arg2) -> None


deprecated - use set_dimension_at_index(1, ... ) instead.

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_symbol_size

set_symbol_size( (float)symbol_size) -> None


Set the symbol size at the visual.

set_x_axis_format

set_x_axis_format( (str)x_axis_format) -> None


Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_format

set_y_axis_format( (str)y_axis_format) -> None


Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

SetAbscissa

SetDimensions

SetOrdinate

show_designs_in_standard_gauss

show_designs_in_standard_gauss( (bool)arg2) -> None


Toggle view of designs to standard gauss.
Does not have an effect when original distribution is already standard gauss.

update_plot

update_plot() -> None


Trigger an additional update on visual.

ReliCloud

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

Methods

get_actual_dimensions

get_actual_dimensions() -> DimensionVector


Return the actual visible dimensions as vector.

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

get_z_axis_label

get_z_axis_label() -> str


Get the z axis label.

has_legend

has_legend() -> bool



set_abscissa

set_abscissa( (Dimension)arg2) -> None


deprecated - use set_dimension_at_index(0, ... ) instead.

set_alpha

set_alpha( (float)alpha_angle) -> None


Set the first angle for an rotation based on Euler angles z-x'-z''.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_beta

set_beta( (float)beta_angle) -> None


Set the second angle for an rotation based on Euler angles z-x'-z''.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_dimensions

set_dimensions( (Dimension)x_axis_dimension, (Dimension)y_axis_dimension, (Dimension)z_axis_dimension) -> None


Set the dimensions to be shown in visual.

set_gamma

set_gamma( (float)gamma_angle) -> None


Set the third angle for an rotation based on Euler angles z-x'-z''.

set_legend_font_size

set_legend_font_size( (int)font_size) -> None


Set the font_size used in legend.

set_legend_position

set_legend_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_size

set_legend_size( (float)width, (float)height [, (bool)relative=False]) -> None


Set the size of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_visible

set_legend_visible( (bool)enabled) -> None


Set legend visibilty to True or False.

set_lighting_enabled

set_lighting_enabled( (bool)enabled) -> None


Set lighting enabled state to True or False.

set_log_x_axis

set_log_x_axis( (bool)enabled) -> None


Set the x-axis to show values logarithmic. Will be ignored if data range contains values <=0.

set_log_y_axis

set_log_y_axis( (bool)enabled) -> None


Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0

set_log_z_axis

set_log_z_axis( (bool)enabled) -> None


Set the z-axis to show values logarithmic. Will be ignored if data range contains values <=0

set_ordinate

set_ordinate( (Dimension)arg2) -> None


deprecated - use set_dimension_at_index(1, ... ) instead.

set_symbol_size

set_symbol_size( (float)symbol_size) -> None


Set the symbol size at the visual.

set_x_axis_format

set_x_axis_format( (str)x_axis_format) -> None


Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_format

set_y_axis_format( (str)y_axis_format) -> None


Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

set_z_axis

set_z_axis( (Dimension)arg2) -> None


deprecated - use set_dimension_at_index(2, ... ) instead.

set_z_axis_format

set_z_axis_format( (str)z_axis_format) -> None


Set the axis format for z axis. Will be ignored if log axis is been chosen for z-axis.

set_z_axis_label

set_z_axis_label( (str)label_z) -> None


Set the z axis label.

SetAbscissa

SetDimensions

SetOrdinate

SetZAxis

show_designs_in_standard_gauss

show_designs_in_standard_gauss( (bool)arg2) -> None


Toggle view of designs to standard gauss.
Does not have an effect when original distribution is already standard gauss.

update_plot

update_plot() -> None


Trigger an additional update on visual.

ReliFailureHistory

Member class of: Visuals

Inherits from: OSLMVisual

Methods

get_active_layer_names

get_active_layer_names() -> list


Get actual active layer names.

get_available_layer_names

get_available_layer_names() -> list


Get all possible layer names.

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

has_legend

has_legend() -> bool



set_all_layers_active_state

set_all_layers_active_state( (bool)arg2) -> None


Set active state of all layers.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_layer_active_state

set_layer_active_state( (str)arg2, (bool)arg3) -> None


Set active state of layer with given layer name.

set_layers_active_state

set_layers_active_state( (list)arg2, (bool)arg3) -> None


Set active state of layers with given layer names.

set_legend_font_size

set_legend_font_size( (int)font_size) -> None


Set the font_size used in legend.

set_legend_position

set_legend_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_size

set_legend_size( (float)width, (float)height [, (bool)relative=False]) -> None


Set the size of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_visible

set_legend_visible( (bool)enabled) -> None


Set legend visibilty to True or False.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_log_y_axis

set_log_y_axis( (bool)enabled) -> None


Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_format

set_y_axis_format( (str)y_axis_format) -> None


Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

update_plot

update_plot() -> None


Trigger an additional update on visual.

ReliInputImportance

Member class of: Visuals

Inherits from: OSLMVisual

Methods

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_palette_preset_names

get_palette_preset_names() -> list


Get a list of available palette preset names.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

reset_palette_limits

reset_palette_limits() -> None


ReSet the minimum and maximum values of palette to default.

reset_palette_maximum

reset_palette_maximum() -> None


Reset the maximum value of palette.

reset_palette_minimum

reset_palette_minimum() -> None


Reset the minimum value of palette.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_palette_limits

set_palette_limits( (float)minimum, (float)maximum) -> None


Set the minimum and maximum values of palette.

set_palette_maximum

set_palette_maximum( (float)maximum) -> None


Set the maximum value of palette.

set_palette_minimum

set_palette_minimum( (float)minimum) -> None


Set the minimum value of palette.

set_palette_position

set_palette_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_preset

set_palette_preset( (str)name) -> None


Set palette preset with given name.

set_palette_size

set_palette_size( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the size of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_visible

set_palette_visible( (bool)enabled) -> None


Set palette visibility to True or False.

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

update_plot

update_plot() -> None


Trigger an additional update on visual.

Residual

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

Methods

get_actual_dimension

get_actual_dimension() -> Dimension


Return the actual visible dimension.

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_statistical_data

get_statistical_data() -> list


Get statistical data as list of lists.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

has_legend

has_legend() -> bool



set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_error_relative

set_error_relative( (bool)error_relative) -> None


When show_errors or show_absolute_errors is set, toggle view to show errors relative to range.

set_legend_font_size

set_legend_font_size( (int)font_size) -> None


Set the font_size used in legend.

set_legend_position

set_legend_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_size

set_legend_size( (float)width, (float)height [, (bool)relative=False]) -> None


Set the size of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_visible

set_legend_visible( (bool)enabled) -> None


Set legend visibilty to True or False.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_log_x_axis

set_log_x_axis( (bool)enabled) -> None


Set the x-axis to show values logarithmic. Will be ignored if data range contains values <=0.

set_log_y_axis

set_log_y_axis( (bool)enabled) -> None


Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_sigma_level

set_sigma_level( (float)sigma) -> None


Set the sigma level, which determines the distance the red sigma_lines have, to the black diagonal.
Distance is equal sigma_value times sigma_level.

set_symbol_size

set_symbol_size( (float)symbol_size) -> None


Set the symbol size at the visual.

set_x_axis_format

set_x_axis_format( (str)x_axis_format) -> None


Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_format

set_y_axis_format( (str)y_axis_format) -> None


Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

show_absolute_errors

show_absolute_errors() -> None


Show values in visual as absolute error of dimension_cv_value vs dimension_value over dimension_value.

show_errors

show_errors() -> None


Show values in visual as error of dimension_cv vs dimension_value over dimension_value.

show_maximum_error

show_maximum_error( (bool)arg2) -> None


Show an arrow pointing to the maximum error.
Only visible when show_errors or show_absolute_errors is set.

show_sample_cops

show_sample_cops() -> None


Show values in visual as SampleCoPs over dimension_value.

show_values

show_values() -> None


Show values in visual as dimension_cv_value over dimension_value.

update_plot

update_plot() -> None


Trigger an additional update on visual.

ResponseSurface2D

Member class of: Visuals

Inherits from: OSLMVisual

Methods

get_actual_dimensions

get_actual_dimensions() -> DimensionVector


Return the actual visible dimensions as vector.

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

has_legend

has_legend() -> bool



set_abscissa

set_abscissa( (Dimension)arg2) -> None


deprecated - use set_dimension_at_index(0, ... ) instead.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_dimensions

set_dimensions( (Dimension)x_axis_dimension, (Dimension)y_axis_dimension) -> None


Set the dimensions to be shown in visual.

set_legend_font_size

set_legend_font_size( (int)font_size) -> None


Set the font_size used in legend.

set_legend_position

set_legend_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_size

set_legend_size( (float)width, (float)height [, (bool)relative=False]) -> None


Set the size of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_visible

set_legend_visible( (bool)enabled) -> None


Set legend visibilty to True or False.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_log_x_axis

set_log_x_axis( (bool)enabled) -> None


Set the x-axis to show values logarithmic. Will be ignored if data range contains values <=0.

set_log_y_axis

set_log_y_axis( (bool)enabled) -> None


Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0

set_ordinate

set_ordinate( (Dimension)arg2) -> None


deprecated - use set_dimension_at_index(1, ... ) instead.

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_resolution

set_resolution( (int)resolution) -> None


Sets the resolution with which the response surface line is been plotted.

set_show_additional_points

set_show_additional_points( (bool)show_additional_data) -> None


Show additional data points or not.

set_symbol_size

set_symbol_size( (float)symbol_size) -> None


Set the symbol size at the visual.

set_x_axis_format

set_x_axis_format( (str)x_axis_format) -> None


Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_format

set_y_axis_format( (str)y_axis_format) -> None


Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

SetAbscissa

SetDimensions

SetOrdinate

update_plot

update_plot() -> None


Trigger an additional update on visual.

ResponseSurface3D

Member class of: Visuals

Inherits from: OSLMVisual

Methods

get_actual_dimensions

get_actual_dimensions() -> DimensionVector


Return the actual visible dimensions as vector.

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_palette_preset_names

get_palette_preset_names() -> list


Get a list of available palette preset names.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

get_z_axis_label

get_z_axis_label() -> str


Get the z axis label.

has_legend

has_legend() -> bool



reset_palette_limits

reset_palette_limits() -> None


ReSet the minimum and maximum values of palette to default.

reset_palette_maximum

reset_palette_maximum() -> None


Reset the maximum value of palette.

reset_palette_minimum

reset_palette_minimum() -> None


Reset the minimum value of palette.

set_abscissa

set_abscissa( (Dimension)arg2) -> None


deprecated - use set_dimension_at_index(0, ... ) instead.

set_alpha

set_alpha( (float)alpha_angle) -> None


Set the first angle for an rotation based on Euler angles z-x'-z''.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_beta

set_beta( (float)beta_angle) -> None


Set the second angle for an rotation based on Euler angles z-x'-z''.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_dimensions

set_dimensions( (Dimension)x_axis_dimension, (Dimension)y_axis_dimension, (Dimension)z_axis_dimension) -> None


Set the dimensions to be shown in visual.

set_gamma

set_gamma( (float)gamma_angle) -> None


Set the third angle for an rotation based on Euler angles z-x'-z''.

set_iso_line_heights

set_iso_line_heights( (str)iso_lines_string) -> None


Set the iso_lines given as string with delimiters space and ',' and ';' .

----

set_iso_line_heights( (list)iso_lines) -> None


Set the iso_lines given as python list.

set_legend_font_size

set_legend_font_size( (int)font_size) -> None


Set the font_size used in legend.

set_legend_position

set_legend_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_size

set_legend_size( (float)width, (float)height [, (bool)relative=False]) -> None


Set the size of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_visible

set_legend_visible( (bool)enabled) -> None


Set legend visibilty to True or False.

set_lighting_enabled

set_lighting_enabled( (bool)enabled) -> None


Set lighting enabled state to True or False.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_lines_enabled

set_lines_enabled( (bool)enabled) -> None


Set lines enabled state to True or False.

set_log_x_axis

set_log_x_axis( (bool)enabled) -> None


Set the x-axis to show values logarithmic. Will be ignored if data range contains values <=0.

set_log_y_axis

set_log_y_axis( (bool)enabled) -> None


Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0

set_log_z_axis

set_log_z_axis( (bool)enabled) -> None


Set the z-axis to show values logarithmic. Will be ignored if data range contains values <=0

set_ordinate

set_ordinate( (Dimension)arg2) -> None


deprecated - use set_dimension_at_index(1, ... ) instead.

set_palette_data

set_palette_data( (ResponseSurfacePaletteData)palette_data) -> None


Set the palette_data so that response surface show certain specific values.

set_palette_limits

set_palette_limits( (float)minimum, (float)maximum) -> None


Set the minimum and maximum values of palette.

set_palette_maximum

set_palette_maximum( (float)maximum) -> None


Set the maximum value of palette.

set_palette_minimum

set_palette_minimum( (float)minimum) -> None


Set the minimum value of palette.

set_palette_position

set_palette_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_preset

set_palette_preset( (str)name) -> None


Set palette preset with given name.

set_palette_size

set_palette_size( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the size of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_visible

set_palette_visible( (bool)enabled) -> None


Set palette visibility to True or False.

set_resolution

set_resolution( (int)resolution) -> None


Set the resolution with which the response surface is been plotted.

set_show_additional_points

set_show_additional_points( (bool)show_additional_data) -> None


Show additional data points or not.

set_surfaces_enabled

set_surfaces_enabled( (bool)enabled) -> None


Set surfaces enabled state to True or False.

set_symbol_size

set_symbol_size( (float)symbol_size) -> None


Set the symbol size at the visual.

set_x_axis_format

set_x_axis_format( (str)x_axis_format) -> None


Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_format

set_y_axis_format( (str)y_axis_format) -> None


Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

set_z_axis

set_z_axis( (Dimension)arg2) -> None


deprecated - use set_dimension_at_index(2, ... ) instead.

set_z_axis_format

set_z_axis_format( (str)z_axis_format) -> None


Set the axis format for z axis. Will be ignored if log axis is been chosen for z-axis.

set_z_axis_label

set_z_axis_label( (str)label_z) -> None


Set the z axis label.

SetAbscissa

SetDimensions

SetOrdinate

SetZAxis

update_plot

update_plot() -> None


Trigger an additional update on visual.

ResponseSurfaceTV

Member class of: Visuals

Inherits from: OSLMVisual

Methods

get_actual_dimensions

get_actual_dimensions() -> DimensionVector


Return the actual visible dimensions as vector.

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_palette_preset_names

get_palette_preset_names() -> list


Get a list of available palette preset names.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

has_legend

has_legend() -> bool



reset_palette_limits

reset_palette_limits() -> None


ReSet the minimum and maximum values of palette to default.

reset_palette_maximum

reset_palette_maximum() -> None


Reset the maximum value of palette.

reset_palette_minimum

reset_palette_minimum() -> None


Reset the minimum value of palette.

set_abscissa

set_abscissa( (Dimension)arg2) -> None


deprecated - use set_dimension_at_index(0, ... ) instead.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_dimensions

set_dimensions( (Dimension)x_axis_dimension, (Dimension)y_axis_dimension, (Dimension)z_axis_dimension) -> None


Set the dimensions to be shown in visual.

set_iso_line_heights

set_iso_line_heights( (str)iso_lines_string) -> None


Set the iso_lines given as string with delimiters space and ',' and ';' .

----

set_iso_line_heights( (list)iso_lines) -> None


Set the iso_lines given as python list.

set_legend_font_size

set_legend_font_size( (int)font_size) -> None


Set the font_size used in legend.

set_legend_position

set_legend_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_size

set_legend_size( (float)width, (float)height [, (bool)relative=False]) -> None


Set the size of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_visible

set_legend_visible( (bool)enabled) -> None


Set legend visibilty to True or False.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_lines_enabled

set_lines_enabled( (bool)enabled) -> None


Set lines enabled state to True or False.

set_log_x_axis

set_log_x_axis( (bool)enabled) -> None


Set the x-axis to show values logarithmic. Will be ignored if data range contains values <=0.

set_log_y_axis

set_log_y_axis( (bool)enabled) -> None


Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0

set_ordinate

set_ordinate( (Dimension)arg2) -> None


deprecated - use set_dimension_at_index(1, ... ) instead.

set_palette_data

set_palette_data( (ResponseSurfacePaletteData)palette_data) -> None


Set the palette_data so that response surface show certain specific values.

set_palette_limits

set_palette_limits( (float)minimum, (float)maximum) -> None


Set the minimum and maximum values of palette.

set_palette_maximum

set_palette_maximum( (float)maximum) -> None


Set the maximum value of palette.

set_palette_minimum

set_palette_minimum( (float)minimum) -> None


Set the minimum value of palette.

set_palette_position

set_palette_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_preset

set_palette_preset( (str)name) -> None


Set palette preset with given name.

set_palette_size

set_palette_size( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the size of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_visible

set_palette_visible( (bool)enabled) -> None


Set palette visibility to True or False.

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_resolution

set_resolution( (int)resolution) -> None


Set the resolution with which the response surface is been plotted.

set_show_additional_points

set_show_additional_points( (bool)show_additional_data) -> None


Show additional data points or not.

set_surfaces_enabled

set_surfaces_enabled( (bool)enabled) -> None


Set surfaces enabled state to True or False.

set_symbol_size

set_symbol_size( (float)symbol_size) -> None


Set the symbol size at the visual.

set_x_axis_format

set_x_axis_format( (str)x_axis_format) -> None


Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_format

set_y_axis_format( (str)y_axis_format) -> None


Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

set_z_axis

set_z_axis( (Dimension)arg2) -> None


deprecated - use set_dimension_at_index(2, ... ) instead.

SetAbscissa

SetDimensions

SetOrdinate

SetZAxis

update_plot

update_plot() -> None


Trigger an additional update on visual.

ResponseValues

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

Methods

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

update_plot

update_plot() -> None


Trigger an additional update on visual.

SignalDesignList

iterable

Member class of: Visuals

Constructors

Methods

id_export_list

id_export_list() -> SignalDesignList



IdExportList

push_back

push_back( (HID)arg2) -> None



size

size() -> int



SignalLayer

Member class of: Visuals

Constructors

Methods

set_channel

set_channel( (int)channel) -> None


Set the channel index.

set_channel_name

set_channel_name( (str)channel_name) -> None


Set the channel name (sig_info).

set_data_name

set_data_name( (str)data_name) -> None


Set the data name (sig_info).

set_ids

set_ids( (SignalDesignList)ids) -> None


Set the ids.

set_layer

set_layer( (str)layer_name) -> None


Set the layer name.

set_number_of_data

set_number_of_data( (int)number_of_data) -> None


Set the number of lines to be shown (sig_info).

set_signal

set_signal( (str)signal) -> None


Set the signal dimension.

set_style

set_style( (Style)style) -> None


Set the style.

set_take_all_ids

set_take_all_ids( (bool)take_all_ids) -> None


Take all possible design ids when True. Overrides set_ids.

SetChannel

SetIds

SetLayer

SetSignal

SetStyle

SignalPlot

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

Methods

add_layer

add_layer( (SignalLayer)signal_layer) -> None


Add a layer of type SignalLayer.
In this layer one can set the signal-channel combination he wants, showing the designs wished with a certain style.
Style is been applied to all designs, if wished otherwise more than one layer has to be added.
Design style set in e.g. DesignTable is NOT applied to this layer.

AddLayer

adjust_resolution

adjust_resolution( (bool)arg2) -> None


Modify signals to be shown with given resolution.

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_palette_preset_names

get_palette_preset_names() -> list


Get a list of available palette preset names.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

has_legend

has_legend() -> bool



is_reference_of_type_signal_info

is_reference_of_type_signal_info() -> bool


Get info about reference be signal info type.

is_signal_of_type_signal_info

is_signal_of_type_signal_info() -> bool


Get info about signal be signal info type.

remove_all_layers

remove_all_layers() -> None


Remove all layers, now showing "no valid data". Every previous signal/reference setting is been resetted, to make a clean start possible.

RemoveAllLayers

reset_palette_limits

reset_palette_limits() -> None


ReSet the minimum and maximum values of palette to default.

reset_palette_maximum

reset_palette_maximum() -> None


Reset the maximum value of palette.

reset_palette_minimum

reset_palette_minimum() -> None


Reset the minimum value of palette.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_channel

set_channel( (int)channel_index) -> None


Set the channel index for signal.

set_channel_name

set_channel_name( (str)channel_name) -> None


Set the channel name for signal.

set_data_name

set_data_name( (str)data_name) -> None


Set the data name for signal.

set_interpolation_type

set_interpolation_type( (int)arg2) -> None


Set the interpolation type, for changed resolution to 1 = LINEAR, 2 = QUADRATIC, other values will be ignored.

set_legend_font_size

set_legend_font_size( (int)font_size) -> None


Set the font_size used in legend.

set_legend_position

set_legend_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_size

set_legend_size( (float)width, (float)height [, (bool)relative=False]) -> None


Set the size of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_visible

set_legend_visible( (bool)enabled) -> None


Set legend visibilty to True or False.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_lines_enabled

set_lines_enabled( (bool)enabled) -> None


Set lines enabled state to True or False.

set_log_x_axis

set_log_x_axis( (bool)enabled) -> None


Set the x-axis to show values logarithmic. Will be ignored if data range contains values <=0.

set_log_y_axis

set_log_y_axis( (bool)enabled) -> None


Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0

set_number_of_classes

set_number_of_classes( (int)arg2) -> None


Set the number of classes (parts in y direction) with which the contour plot is been shown.

set_number_of_data

set_number_of_data( (int)number_of_data) -> None


Set the maximum number of lines for signal_info view.

set_palette_limits

set_palette_limits( (float)minimum, (float)maximum) -> None


Set the minimum and maximum values of palette.

set_palette_maximum

set_palette_maximum( (float)maximum) -> None


Set the maximum value of palette.

set_palette_minimum

set_palette_minimum( (float)minimum) -> None


Set the minimum value of palette.

set_palette_position

set_palette_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_preset

set_palette_preset( (str)name) -> None


Set palette preset with given name.

set_palette_size

set_palette_size( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the size of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_visible

set_palette_visible( (bool)enabled) -> None


Set palette visibility to True or False.

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_reference

set_reference( (Dimension)reference) -> None


Set the reference signal.

set_reference_channel

set_reference_channel( (int)reference_channel_index) -> None


Set the reference channel index for signal.

set_reference_channel_name

set_reference_channel_name( (str)channel_name) -> None


Set the channel name for reference.

set_reference_data_name

set_reference_data_name( (str)data_name) -> None


Set the data name for reference.

set_reference_design

set_reference_design( (HID)reference_design_id) -> None


Set the reference design id. For reference signal only one design is shown.

set_reference_number_of_data

set_reference_number_of_data( (int)number_of_data) -> None


Set the maximum number of lines for reference signal_info view.

set_resolution

set_resolution( (int)arg2) -> None


Set the resolution with which the signals are shown, when adjust_resolution is set to True. Minimum 2.

set_sigma_factor

set_sigma_factor( (float)arg2) -> None


Set the factor with which standard deviation is shown. Change plot only when statistical data is shown.

set_signal

set_signal( (Dimension)signal) -> None


Set the signal.

set_surfaces_enabled

set_surfaces_enabled( (bool)enabled) -> None


Set surfaces enabled state to True or False.

set_symbol_size

set_symbol_size( (float)symbol_size) -> None


Set the symbol size at the visual.

set_x_axis_format

set_x_axis_format( (str)x_axis_format) -> None


Set the axis format for x axis. Will be ignored if log axis is been chosen for x-axis.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_format

set_y_axis_format( (str)y_axis_format) -> None


Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

SetChannel

SetReference

SetReferenceChannel

SetReferenceDesign

SetSignal

show_as_contour_plot

show_as_contour_plot( (bool)arg2) -> None


Show signal data as contour plot with given number of classes.

show_statistical_values

show_statistical_values( (bool)arg2) -> None


Show additional to signal, mean and standard deviation for signals with more than one line.

update_plot

update_plot() -> None


Trigger an additional update on visual.

use_textures

use_textures( (bool)toggle_texture_usage) -> None


Modify the plot to show textures or not.
Does only afllict plots with many points.
Setting is to be meant as possibility to deactivate texture usage on certain (graphic) systems, where showing as texture leads to graphical problems.
Not showing as texture means in most cases a reduce in performance.

SpiderPlot

Member class of: Visuals

Inherits from: Visual

Constructors

Methods

export

export( (Path)file_path [, (float)scale [, (bool)transparent [, (int)quality]]]) -> None


Export the visual as picture, with given relative scale to file position given as path.
If scale is left empty, 1.0 is been taken.
Transparency produces plot with transparent background which is available when having picture types supporting this, like png.
Quality is available for jpg, determining the quality of the output in percent [0:100].

----

export( (Path)file_path, (int)width, (int)height [, (bool)transparent [, (int)quality]]) -> None


Export the visual as picture, with given absolute sizes to file position given as path.
Transparency produces plot with transparent background which is available when having picture types supporting this, like png.
Quality is available for jpg, determining the quality of the output in percent [0:100].

----

export( (str)file_path [, (float)scale [, (bool)transparent [, (int)quality]]]) -> None


Export the visual as picture, with given relative scale to file position given as string.
If scale is left empty, 1.0 is been taken.
Transparency produces plot with transparent background which is available when having picture types supporting this, like png.
Quality is available for jpg, determining the quality of the output in percent [0:100].

----

export( (str)file_path, (int)width, (int)height [, (bool)transparent [, (int)quality]]) -> None


Export the visual as picture, with given absolute sizes to file position given as string.
Transparency produces plot with transparent background which is available when having picture types supporting this, like png.
Quality is available for jpg, determining the quality of the output in percent [0:100].

export_data

export_data( (Path)file_path [, (str)format_string]) -> None


Export the visual as ascii with given format_string to file position given as path.
If format_string is left empty, "%g" is been taken.

----

export_data( (str)file_path [, (str)format_string]) -> None


Export the visual as ascii with given format_string to file position given as string.
If format_string is left empty, "%g" is been taken.

get_caption

get_caption() -> str


Get the caption.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_font_size

set_font_size( (int)arg2) -> None


Set the font size at the visual.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_symbol_size

set_symbol_size( (float)symbol_size) -> None


Set the symbol size at the visual.

StatisticAnalysis

Member class of: Visuals

Inherits from: OSLMVisual

Methods

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_box_probability_content

set_box_probability_content( (float)box_probability_content) -> None


Set the probability content for the box. Box goes from median-content*0.5 to median+content*0.5.

set_box_sigma_factor

set_box_sigma_factor( (float)box_sigma_factor) -> None


Set the sigma factor for the box. Box goes from mean-factor to mean+factor.

set_box_type

set_box_type( (StatisticAnalysisBoxType)box_type) -> None


Set the box type.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_group

set_group( (str)group_name) -> None


Set the group to be shown

set_limit_type

set_limit_type( (StatisticAnalysisLimitsType)limit_type) -> None


Set the limit type.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_scaling_type

set_scaling_type( (StatisticAnalysisScalingType)scaling_type) -> None


Set the scaling type.

set_separate_box_and_whisker

set_separate_box_and_whisker( (bool)separate) -> None


Show Box and Whisker on two layers.

set_show_samples

set_show_samples( (bool)show_samples) -> None


Show sample points.

set_symbol_size

set_symbol_size( (float)symbol_size) -> None


Set the symbol size at the visual.

set_whisker_probability_content

set_whisker_probability_content( (float)whisker_probability_content) -> None


Set the probability content for the whisker. Whisker goes from median-content*0.5 to median+content*0.5.

set_whisker_sigma_factor

set_whisker_sigma_factor( (float)whisker_sigma_factor) -> None


Set the sigma factor for the whisker. Whisker goes from mean-factor to mean+factor.

set_whisker_type

set_whisker_type( (StatisticAnalysisWhiskerType)whisker_type) -> None


Set the whisker type.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_format

set_y_axis_format( (str)y_axis_format) -> None


Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

update_plot

update_plot() -> None


Trigger an additional update on visual.

StatisticValues

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

TrafficLightPlot

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

Methods

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

has_legend

has_legend() -> bool



hide_responses

hide_responses( (DimensionList)dimension_list) -> None


Hide given dimensions.

HideResponses

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_axes_rotation_enabled

set_axes_rotation_enabled( (bool)enable) -> None


Set axes rotation enabled.

set_axes_rotation_orthogonal

set_axes_rotation_orthogonal( (bool)enable) -> None


Set rotation angles to 0 degree if enough space for text exist, else to 90.

set_axes_rotation_x_angle

set_axes_rotation_x_angle( (float)angle) -> None


Set the rotation angle for x-axis.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_legend_font_size

set_legend_font_size( (int)font_size) -> None


Set the font_size used in legend.

set_legend_position

set_legend_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_size

set_legend_size( (float)width, (float)height [, (bool)relative=False]) -> None


Set the size of the legend, using absolute or relative coordinates.
(Internally stored as relative.)

set_legend_visible

set_legend_visible( (bool)enabled) -> None


Set legend visibilty to True or False.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_log_y_axis

set_log_y_axis( (bool)enabled) -> None


Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_response_visible

set_response_visible( (Dimension)dimension, (bool)visible) -> None


Toggle the visibility of one single dimension.

set_sigma_factor

set_sigma_factor( (float)sigma) -> None


Change the sigma value used for statistical_values and for whole plot when values_sigma_based is chosen.

set_symbol_size

set_symbol_size( (float)symbol_size) -> None


Set the symbol size at the visual.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_format

set_y_axis_format( (str)y_axis_format) -> None


Set the axis format for y axis. Will be ignored if log axis is been chosen for y-axis.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

SetResponseVisible

SetSigmaFactor

show_all_responses

show_all_responses() -> None


Show all dimensions.

show_responses

show_responses( (DimensionList)dimension_list) -> None


Show given dimensions.

show_statistical_values

show_statistical_values( (bool)visible) -> None


Toggle visibility of statistical values, shown as additional box_plot on top of the bars.

show_values_sigma_based

show_values_sigma_based( (bool)toggle) -> None


Toggle the values view, base on mean and sigma vs. original values.

ShowAllResponses

ShowResponses

ShowStatisticValues

update_plot

update_plot() -> None


Trigger an additional update on visual.

VectorElements

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

Methods

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

update_plot

update_plot() -> None


Trigger an additional update on visual.

Visual

Inherits from: Control

Constructors

Methods

Visuals

Constructors

Enums

CustomData_Type
Custom
Grid
Points
Lines
Bars
HorizontalBars
StackedBars
StackedHorizontalBars
Box
HorizontalBox

WebViewer

Member class of: Visuals

Inherits from: Visual

Constructors

Methods

set_source

set_source( (str)path) -> None


Set path to html file to be viewed

----

set_source( (Path)path) -> None


Set path to html file to be viewed

set_source_data

set_source_data( (str)content) -> None


Set content of html to be viewed

WeightedPCValues

Member class of: Visuals

Inherits from: OSLMVisual

Constructors

Methods

get_caption

get_caption() -> str


Get the caption.

get_data

get_data( (str)layer_name [, (bool)force_as_text]) -> list


Get data from DataTable of layer layer_name as list of lists. When force_as_text is True then data returns as text.

get_header_data

get_header_data( (str)layer_name, (bool)horizontal) -> list


Get header data from DataTable of layer layer_name as list. horizontal = True - get horizontal header, horizontal = False - get vertical header.

get_palette_preset_names

get_palette_preset_names() -> list


Get a list of available palette preset names.

get_x_axis_label

get_x_axis_label() -> str


Get the x axis label.

get_y_axis_label

get_y_axis_label() -> str


Get the y axis label.

reset_palette_limits

reset_palette_limits() -> None


ReSet the minimum and maximum values of palette to default.

reset_palette_maximum

reset_palette_maximum() -> None


Reset the maximum value of palette.

reset_palette_minimum

reset_palette_minimum() -> None


Reset the minimum value of palette.

set_axes_enabled

set_axes_enabled( (bool)enabled) -> None


Set axes enabled state to True or False.

set_caption

set_caption( (str)caption) -> None


Set the caption.

set_line_width

set_line_width( (float)line_width) -> None


Set the line width at the visual.

set_lines_enabled

set_lines_enabled( (bool)enabled) -> None


Set lines enabled state to True or False.

set_log_x_axis

set_log_x_axis( (bool)enabled) -> None


Set the x-axis to show values logarithmic. Will be ignored if data range contains values <=0.

set_log_y_axis

set_log_y_axis( (bool)enabled) -> None


Set the y-axis to show values logarithmic. Will be ignored if data range contains values <=0

set_palette_limits

set_palette_limits( (float)minimum, (float)maximum) -> None


Set the minimum and maximum values of palette.

set_palette_maximum

set_palette_maximum( (float)maximum) -> None


Set the maximum value of palette.

set_palette_minimum

set_palette_minimum( (float)minimum) -> None


Set the minimum value of palette.

set_palette_position

set_palette_position( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the position of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_preset

set_palette_preset( (str)name) -> None


Set palette preset with given name.

set_palette_size

set_palette_size( (float)x_position, (float)y_position [, (bool)relative=False]) -> None


Set the size of the palette, using absolute or relative[%] coordinates.
(Internally stored as relative[%].)

set_palette_visible

set_palette_visible( (bool)enabled) -> None


Set palette visibility to True or False.

set_ranges_x

set_ranges_x( (float)minimum, (float)maximum) -> None


Set the ranges to x-axis, Two inputs : minimum and maximum.

set_ranges_y

set_ranges_y( (float)minimum, (float)maximum) -> None


Set the ranges to y-axis, Two inputs : minimum and maximum.

set_surfaces_enabled

set_surfaces_enabled( (bool)enabled) -> None


Set surfaces enabled state to True or False.

set_symbol_size

set_symbol_size( (float)symbol_size) -> None


Set the symbol size at the visual.

set_x_axis_label

set_x_axis_label( (str)label_x) -> None


Set the x axis label.

set_y_axis_label

set_y_axis_label( (str)label_y) -> None


Set the y axis label.

update_plot

update_plot() -> None


Trigger an additional update on visual.