set_paintT_set_paintSetPaintSetPaint (Operator)

Name

set_paintT_set_paintSetPaintSetPaint — Define the gray value output mode.

Signature

set_paint( : : WindowHandle, Mode : )

Description

set_paintset_paintSetPaintSetPaintSetPaint defines the output mode for gray value display (single- or multichannel) in the window. The mode is used by disp_objdisp_objDispObjDispObjDispObj, disp_imagedisp_imageDispImageDispImageDispImage, and disp_colordisp_colorDispColorDispColorDispColor.

This page describes the different modes that can be used for gray value output. It should be noted that the mode 'default' is the most suitable in almost all cases.

Gray images can also be interpreted as 3D data, depending on the gray value. To view these 3D plots, select the modes '3d_plot'. If your graphics card supports OpenGL, choose this for a high quality plot that is well suited for interactive display (see update_window_poseupdate_window_poseUpdateWindowPoseUpdateWindowPoseUpdateWindowPose on how to make the display interactive).

Three-channel images are interpreted as RGB images.

Vector field images can be viewed as 'vector_field'.

All available painting modes can be queried with query_paintquery_paintQueryPaintQueryPaintQueryPaint.

Parameters for modes that need more than one parameter can be passed the following ways:

Only the name of the mode is passed: The defaults or the most recently used values are used, respectively.

Example: set_paint(WindowHandle,'3d_plot')set_paint(WindowHandle,"3d_plot")SetPaint(WindowHandle,"3d_plot")SetPaint(WindowHandle,"3d_plot")SetPaint(WindowHandle,"3d_plot")
All values are passed: All output characteristics can be set.

Example: set_paint(WindowHandle,['3d_plot','shaded', 8,0.939,-0.052,0.296,-0.165,0.401,0.072,-0.047,-0.073])set_paint(WindowHandle,["3d_plot","shaded", 8,0.939,-0.052,0.296,-0.165,0.401,0.072,-0.047,-0.073])SetPaint(WindowHandle,["3d_plot","shaded", 8,0.939,-0.052,0.296,-0.165,0.401,0.072,-0.047,-0.073])SetPaint(WindowHandle,["3d_plot","shaded", 8,0.939,-0.052,0.296,-0.165,0.401,0.072,-0.047,-0.073])SetPaint(WindowHandle,["3d_plot","shaded", 8,0.939,-0.052,0.296,-0.165,0.401,0.072,-0.047,-0.073])
Only the first n values are passed: Only the passed values are changed.

Example: set_paint(WindowHandle,['3d_plot','texture'])set_paint(WindowHandle,["3d_plot","texture"])SetPaint(WindowHandle,["3d_plot","texture"])SetPaint(WindowHandle,["3d_plot","texture"])SetPaint(WindowHandle,["3d_plot","texture"])
Some of the values are replaced by an asterisk ('*'): The value of the replaced parameters is not changed.

Example: set_paint(WindowHandle,['3d_plot','*',8])set_paint(WindowHandle,["3d_plot","*",8])SetPaint(WindowHandle,["3d_plot","*",8])SetPaint(WindowHandle,["3d_plot","*",8])SetPaint(WindowHandle,["3d_plot","*",8])

If the current mode is 'default', HALCON chooses a suitable algorithm for the output of 2- and 3-channel images. No set_paintset_paintSetPaintSetPaintSetPaint call is necessary in this case.

Apart from set_paintset_paintSetPaintSetPaintSetPaint there are other operators that affect the output of gray values. The most important of them are set_partset_partSetPartSetPartSetPart, set_part_styleset_part_styleSetPartStyleSetPartStyleSetPartStyle and set_lutset_lutSetLutSetLutSetLut. Some output modes display gray values using region output (e.g. 'histogram','contourline','3d_plot_lines', etc.). In these modes, parameters set with set_colorset_colorSetColorSetColorSetColor, set_rgbset_rgbSetRgbSetRgbSetRgb,set_hsiset_hsiSetHsiSetHsiSetHsi, set_shapeset_shapeSetShapeSetShapeSetShape, set_line_widthset_line_widthSetLineWidthSetLineWidthSetLineWidth and set_insertset_insertSetInsertSetInsertSetInsert influence gray value output. This can lead to unexpected results when using set_shape('convex')set_shape("convex")SetShape("convex")SetShape("convex")SetShape("convex") and set_paint(WindowHandle,'histogram')set_paint(WindowHandle,"histogram")SetPaint(WindowHandle,"histogram")SetPaint(WindowHandle,"histogram")SetPaint(WindowHandle,"histogram"). Here, the convex hull of the histogram is displayed.

Modes:

one-channel images:

'default'"default""default""default""default"

optimal display on given hardware

['3d_plot',Mode,Step,qa,qb,qc,qd,Distance,CenterRow,CenterCol, CenterHeight]

'3d_plot'"3d_plot""3d_plot""3d_plot""3d_plot"

Gray values are interpreted as a 3D height field and displayed using OpenGL. The first parameter specifies the way in which the height field is displayed. The following modes are available:

'texture'"texture""texture""texture""texture"

The height field is displayed as a closed surface and colored using texture mapping. The texture is passed as the second channel (for a gray-valued texture) or as the second to fourth channel (for a colored texture) of the image to display.

'shaded'"shaded""shaded""shaded""shaded"

The height field is displayed as a closed surface and colored using the current LUT.

'hidden_lines'"hidden_lines""hidden_lines""hidden_lines""hidden_lines"

The height field is displayed as a hidden line plot and colored using the current LUT.

'contour_lines'"contour_lines""contour_lines""contour_lines""contour_lines"

Similar to 'contourline' height lines are extracted and displayed at their actual height. Again the lines are colored using the current LUT.

The second parameter contains the step width, i.e. at what intervals samples in row and column direction are taken from the image. The smaller this parameter is chosen, the coarser the resulting height field. However, computation time increases while this parameter decreases. In the case of 'contour_lines' this parameter corresponds to the number of intervals the height range is divided into.

The third to sixth parameter are the four values of a unit quaternion, describing the orientation of the height field (see axis_angle_to_quataxis_angle_to_quatAxisAngleToQuatAxisAngleToQuatAxisAngleToQuat for more information on quaternions).

The seventh parameter is the zooming factor. Smaller values implicate higher zooming.

The last three parameters are the row, column, and height position of the actual center of view. This values must be scaled to the interval [-0.5, 0.5].

You can set the third or the seventh parameter in the tuple to 'auto'"auto""auto""auto""auto". Then, the zooming factor and the center of view are determined automatically such that the plot of the height field fills the window as good as possible. It is important that the part of the window is set correctly (using set_partset_partSetPartSetPartSetPart) before set_paintset_paintSetPaintSetPaintSetPaint is called. By setting the third value in the tuple to 'auto'"auto""auto""auto""auto", the previous orientation (or the default one) is kept, by setting the seventh parameter to 'auto'"auto""auto""auto""auto", the provided orientation is used. It is not possible to set any parameters after 'auto'"auto""auto""auto""auto" in the tuple. Furthermore 'auto'"auto""auto""auto""auto" will only work correctly if 'scale_plot'"scale_plot""scale_plot""scale_plot""scale_plot" is set to 'true'"true""true""true""true" using set_window_paramset_window_paramSetWindowParamSetWindowParamSetWindowParam. (Example: ['3d_plot','shaded',4,'auto'])

Depending on the speed of your graphics card, the display of the height field is performed at interactive rates. See the operator update_window_poseupdate_window_poseUpdateWindowPoseUpdateWindowPoseUpdateWindowPose for an intuitive way of modifying the parameters of the 3D plot (e.g., with the mouse).

The colors of the axis are influenced by the colors set using set_rgbset_rgbSetRgbSetRgbSetRgb, set_colorset_colorSetColorSetColorSetColor, and set_coloredset_coloredSetColoredSetColoredSetColored. The first three colors set this way are used as colors for row, column, and height axis (in this order).

Additional parameters concerning the 3D plot can be set using the operator set_window_paramset_window_paramSetWindowParamSetWindowParamSetWindowParam.

If you intend to use '3d_plot'"3d_plot""3d_plot""3d_plot""3d_plot" on a Unix-like system, make sure you have sufficient permissions on your graphics device.

Defaults:

['3d_plot','shaded',8,0.939,-0.052,0.296,-0.165,0.401,0.072, -0.047,-0.073]
Two-channel images:

'default'"default""default""default""default"

output the first channel.
Three-channel images:

'default'"default""default""default""default"

output as RGB image with 'median_cut'.
Vector field images:

['vector_field', Mode, Step, MinLength, ScaleLength, CircleSize]

'vector_field'"vector_field""vector_field""vector_field""vector_field"

output a vector field. It is possible to display vector fields containing relative coordinates or vector fields containing absolute coordinates. This behavior is controlled via the optional parameter Mode. Possible values for Mode are 'auto' (the visualization depends on the semantic type of the vector field), 'absolute', or 'relative'. The default value is 'auto'. In the 'vector_field' mode, a circle with diameter CircleSize is drawn for each vector at the position of the pixel. Furthermore, a line segment is drawn with the current vector. The step size for drawing the vectors, i.e., the distance between the drawn vectors, can be set with the parameter Step. Short vectors can be suppressed with the parameter MinLength. The fourth parameter value scales the vector length. It should be noted that by setting 'vector_field' only the internal parameters Mode, Step, MinLength, ScaleLength, and CircleSize are changed. The current display mode is not changed. Vector field images are always displayed as vector field, no matter which mode is selected with set_paintset_paintSetPaintSetPaintSetPaint.

['vector_field','auto',16,2,3,5]["vector_field","auto",16,2,3,5]["vector_field","auto",16,2,3,5]["vector_field","auto",16,2,3,5]["vector_field","auto",16,2,3,5]

Output of every 16th vector, that is longer than 2 pixel. Each vector is multiplied by 3 for output.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control) window → (handle)

Window handle.

ModeModeModeModemode (input_control) string-array → (string / integer / real)

Output mode. Additional parameters possible.

Default value: 'default' "default" "default" "default" "default"

List of values: '3d_plot'"3d_plot""3d_plot""3d_plot""3d_plot", 'default'"default""default""default""default", 'vector_field'"vector_field""vector_field""vector_field""vector_field"

Result

set_paintset_paintSetPaintSetPaintSetPaint returns 2 (H_MSG_TRUE) if the parameter is correct and the window is valid. Otherwise an exception is raised.