set_part (Operator)

Name

set_part — Modify the displayed image part.

Synopsis

set_part( : : WindowHandle, Row1, Column1, Row2, Column2 : )

Description

set_part modifies the image part that is displayed in the window. (Row1,Column1) denotes the upper left corner and (Row2,Column2) the lower right corner of the image part to display. The changed values are used by gray value output operators (disp_image, disp_color) as well as region output operators (disp_region)).

If only part of an image is displayed, it will be zoomed to full window size. The zooming interpolation method can be set with set_part_style. get_part returns the values of the image part to display.

Beside setting the image part directly, the following special modes are supported:

Row1 = Column1 = Row2 = Column2 = -1:

The window size is choosen as the image part, i.e. no zooming of the image will be performed.

Row1, Column1 > -1 and Row2 = Column2 = -1:

The size of the last displayed image (in this window) is choosen as the image part, i.e. the image can completely be displayed in the image. For this the image will be zoomed if necessary.

Parameters

WindowHandle (input_control)	window → (integer)
Window_id.

Row1 (input_control)	rectangle.origin.y → (integer)
Row of the upper left corner of the chosen image part.
Default value: 0

Column1 (input_control)	rectangle.origin.x → (integer)
Column of the upper left corner of the chosen image part.
Default value: 0

Row2 (input_control)	rectangle.corner.y → (integer)
Row of the lower right corner of the chosen image part.
Default value: -1
Restriction: (Row2 >= Row1) || (Row2 == -1)

Column2 (input_control)	rectangle.corner.x → (integer)
Column of the lower right corner of the chosen image part.
Default value: -1
Restriction: (Column2 >= Column1) || (Column2 == -1)

Example

get_system('width',Width)
get_system('height',Height)
set_part(WindowHandle,0,0,Height-1,Width-1)
disp_image(Image,WindowHandle)
draw_rectangle1(WindowHandle,Row1,Column1,Row2,Column2)
set_part(WindowHandle,Row1,Column1,Row2,Column2)
disp_image(Image,WindowHandle)

Result

set_part returns 2 (H_MSG_TRUE) if the window is valid. Otherwise an exception is raised.

Parallelization Information

set_part is reentrant and processed without parallelization.

Possible Predecessors

get_part

Possible Successors

set_part_style, disp_image, disp_region

Alternatives

affine_trans_image

See also

get_part, set_part_style, disp_region, disp_image, disp_color

Module

Foundation