set_window_param (Operator)

Name

set_window_param — Set window parameters.

Synopsis

set_window_param( : : WindowHandle, Param, Value : )

Description

The operator set_window_param allows to set different parameters of an open window.

General window parameters:

 - 'background_color'
   possible values: a string containing the color name (e.g. 'black', 'red')
   Sets the background color of the window WindowHandle. The 
   operator clear_window uses this color to clear the window.

 - 'window_title'
   possible values: a string containing up to 1023 characters
   Allows to change the text in the title bar of an already opened HALCON 
   window. 
   

Parameters concerning the '3d_plot' (see set_paint):

 - 'angle_of_view'
   possible values: 'orthogonal' or an angle in radians
   default value: 1.22173 (70 degrees)
   Set the angle of view of the virtual camera used to display the 3D plot.
   The angle must be provided in radians and lie within the interval
   $[0,PI)$. An angle of 0 radians implies orthogonal projection. Another 
   way to choose orthogonal projection is to set 'angle_of_view' 
   to 'orthogonal'.

 - 'axis_captions'
   possible values: A tuple containing three strings. Each string can 
                    contain up to 31 characters.
   default value: [' ',' ',' ']
   The axis captions for row, column, and height can be set by passing a 
   tuple containing the strings for the captions in the specified order row, 
   column, and height axis (e.g. ['row','col','height']). Pass empty strings 
   to display no captions at all.

 - 'interactive_plot'
   possible values: 'true', 'false'
   default value: 'false'
   For the interactive display of a 3D plot it is often required to 
   perform calls to disp_obj using the same image within a loop. 
   If 'interactive_plot' is set to 'true', a large amount
   of calculations is done only in the first call to disp_obj 
   and cached for all subsequent calls.
   It is important to set this parameter to 'false' after finishing the 
   interactive display, in order to free the memory needed for
   the cached data.

 - 'plot_quality'
   possible values: 'low', 'medium', 'good', 'best'
   default value: 'medium'
   Influences the quality of the 3D plot. Depending on the capabilities of
   your graphics card better settings for the quality may reduce the 
   frame rate of the 3D plot significantly.

 - 'save_depth_buffer'
   possible values: 'true', 'false'
   default value: 'false'
   If set to 'true', the depth information generated by the 3D plot is 
   saved after each call to disp_obj. This information is used to
   accelerate the operator unproject_coordinates.

 - 'scale_plot'
   possible values: 'true', 'false'
   default value: 'true'
   If set to 'true' the height values of an image are transformed into 
   the interval [0,255] before display. If set to 'false' the aspect ratio
   between row/column and height is considered. Images of the type byte, 
   cyclic, or direction are not scaled, i.e. in their cases this parameter is 
   ignored. 

 - 'display_grid'
   possible values: 'true', 'false'
   default value: 'true'
   If set to 'true' a grid is displayed at height 0.

 - 'display_axes'
   possible values: 'true', 'false'
   default value: 'true'
   If set to 'true' coordinate axes are displayed.

Parameters

WindowHandle (input_control)	window → (integer)
Window identifier.

Param (input_control)	string → (string)
Name of the parameter.
Default value: 'save_depth_buffer'
List of values: 'save_depth_buffer', 'plot_quality', 'interactive_plot', 'axis_captions', 'scale_plot', 'angle_of_view', 'display_grid', 'display_axes', 'window_title', 'background_color'

Value (input_control)	string-array → (string / real / integer)
Value to be set.
Default value: 'true'
List of values: 'true', 'false', 'low', 'good', 'medium', 'best', 'orthogonal', 'black', 'white', 'red', 'green', 'blue'

Parallelization Information

set_window_param is reentrant, local, and processed without parallelization.

Possible Predecessors

open_window

Possible Successors

disp_image

See also

get_window_param, set_window_attr

Module

Foundation