move_regionmove_regionMoveRegionMoveRegionmove_region (Operator)

Name

move_regionmove_regionMoveRegionMoveRegionmove_region — Translate a region.

Signature

move_region(Region : RegionMoved : Row, Column : )

Description

move_regionmove_regionMoveRegionMoveRegionmove_region translates the input regions by the vector given by (RowRowRowrowrow, ColumnColumnColumncolumncolumn). If necessary, the resulting regions are clipped with the current image format.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Automatically parallelized on tuple level.

Parameters

RegionRegionRegionregionregion (input_object) region(-array) → object

Region(s) to be moved.

RegionMovedRegionMovedRegionMovedregionMovedregion_moved (output_object) region(-array) → object

Translated region(s).

Number of elements: RegionMoved == Region

RowRowRowrowrow (input_control) point.y → (integer)

Row coordinate of the vector by which the region is to be moved.

Default: 30

Suggested values: -128, -64, -32, -16, -10, -8, -4, -2, -1, 0, 1, 2, 4, 5, 8, 10, 16, 32, 64, 128

Value range: -512 ≤ Row Row Row row row ≤ 512 (lin)

Minimum increment: 1

Recommended increment: 10

ColumnColumnColumncolumncolumn (input_control) point.x → (integer)

Row coordinate of the vector by which the region is to be moved.

Default: 30

Suggested values: -128, -64, -32, -16, -10, -8, -4, -2, -1, 0, 1, 2, 4, 5, 8, 10, 16, 32, 64, 128

Value range: -512 ≤ Column Column Column column column ≤ 512 (lin)

Minimum increment: 1

Recommended increment: 10

Complexity

Let F be the area of the input region. Then the runtime complexity is O(F).

Result

move_regionmove_regionMoveRegionMoveRegionmove_region always returns the value 2 ( H_MSG_TRUE) . The behavior in case of empty input (no regions given) can be set via set_system('no_object_result',<Result>)set_system("no_object_result",<Result>)SetSystem("no_object_result",<Result>)SetSystem("no_object_result",<Result>)set_system("no_object_result",<Result>), the behavior in case of an empty input region via set_system('empty_region_result',<Result>)set_system("empty_region_result",<Result>)SetSystem("empty_region_result",<Result>)SetSystem("empty_region_result",<Result>)set_system("empty_region_result",<Result>), and the behavior in case of an empty result region via set_system('store_empty_region',<'true'/'false'>)set_system("store_empty_region",<"true"/"false">)SetSystem("store_empty_region",<"true"/"false">)SetSystem("store_empty_region",<"true"/"false">)set_system("store_empty_region",<"true"/"false">). If necessary, an exception is raised.

Possible Predecessors

thresholdthresholdThresholdThresholdthreshold, connectionconnectionConnectionConnectionconnection, regiongrowingregiongrowingRegiongrowingRegiongrowingregiongrowing, pouringpouringPouringPouringpouring

Possible Successors

select_shapeselect_shapeSelectShapeSelectShapeselect_shape, disp_regiondisp_regionDispRegionDispRegiondisp_region

Module

Foundation

Operators