get_region_index🔗
Short description🔗
get_region_index — Index of all regions containing a given pixel.
Signature🔗
get_region_index( region Regions, point.y Row, point.x Column, out integer Index )
Description🔗
The operator get_region_index returns the index
of all regions in Regions (range of values: 1 to n)
containing the test pixel (Row,Column), i.e.:
The returned indices can be used, e.g., in select_obj to
select the regions containing the test pixel.
Attention🔗
If the regions overlap more than one region might contain the pixel. In this case all these regions are returned. If no region contains the indicated pixel the empty tuple (= no region) is returned.
Execution information🔗
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🔗
Regions (input_object) region-array → object
Regions to be examined.
Row (input_control) point.y → (integer)
Line index of the test pixel.
Default: 100
Value range: Row (lin)
Column (input_control) point.x → (integer)
Column index of the test pixel.
Default: 100
Value range: Column (lin)
Index (output_control) integer(-array) → (integer)
Index of the regions containing the test pixel.
Complexity🔗
If \(F\) is the area of the region and \(N\) is the number of regions the mean runtime complexity is \(O(ln(\sqrt{F}) * N)\).
Result🔗
The operator get_region_index returns the value 2 (H_MSG_TRUE)
if the parameters are correct.
The behavior in case of empty input (no input regions available) is
set via the operator set_system('no_object_result',<Result>).
If necessary an exception is raised.
Combinations with other operators🔗
Module🔗
Foundation