get_region_indexget_region_indexGetRegionIndexGetRegionIndex (Operator)

Name

get_region_indexget_region_indexGetRegionIndexGetRegionIndex — Index of all regions containing a given pixel.

Signature

get_region_index(Regions : : Row, Column : Index)

Description

The operator get_region_indexget_region_indexGetRegionIndexGetRegionIndexGetRegionIndex returns the index of all regions in RegionsRegionsRegionsRegionsregions (range of values: 1 to n) containing the test pixel (RowRowRowRowrow,ColumnColumnColumnColumncolumn), i.e.:

The returned indices can be used, e.g., in select_objselect_objSelectObjSelectObjSelectObj 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

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

Parameters

RegionsRegionsRegionsRegionsregions (input_object) region-array → object

Regions to be examined.

RowRowRowRowrow (input_control) point.y → (integer)

Line index of the test pixel.

Default value: 100

Typical range of values: Row Row Row Row row (lin)

ColumnColumnColumnColumncolumn (input_control) point.x → (integer)

Column index of the test pixel.

Default value: 100

Typical range of values: Column Column Column Column column (lin)

IndexIndexIndexIndexindex (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_indexget_region_indexGetRegionIndexGetRegionIndexGetRegionIndex 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>)set_system("no_object_result",<Result>)SetSystem("no_object_result",<Result>)SetSystem("no_object_result",<Result>)SetSystem("no_object_result",<Result>). If necessary an exception is raised.

Possible Predecessors

thresholdthresholdThresholdThresholdThreshold, regiongrowingregiongrowingRegiongrowingRegiongrowingRegiongrowing, connectionconnectionConnectionConnectionConnection

Alternatives

select_region_pointselect_region_pointSelectRegionPointSelectRegionPointSelectRegionPoint

See also

get_mbuttonget_mbuttonGetMbuttonGetMbuttonGetMbutton, get_mpositionget_mpositionGetMpositionGetMpositionGetMposition, test_region_pointtest_region_pointTestRegionPointTestRegionPointTestRegionPoint

Module

Foundation