get_region_indexget_region_indexGetRegionIndexGetRegionIndexget_region_index (Operator)

Name

get_region_indexget_region_indexGetRegionIndexGetRegionIndexget_region_index — Index of all regions containing a given pixel.

Signature

Description

The operator get_region_indexget_region_indexGetRegionIndexGetRegionIndexGetRegionIndexget_region_index returns the index of all regions in RegionsRegionsRegionsRegionsregionsregions (range of values: 1 to n) containing the test pixel (RowRowRowRowrowrow,ColumnColumnColumnColumncolumncolumn), i.e.: The returned indices can be used, e.g., in select_objselect_objSelectObjSelectObjSelectObjselect_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

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

Parameters

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

Possible Predecessors

thresholdthresholdThresholdThresholdThresholdthreshold, regiongrowingregiongrowingRegiongrowingRegiongrowingRegiongrowingregiongrowing, connectionconnectionConnectionConnectionConnectionconnection

Alternatives

select_region_pointselect_region_pointSelectRegionPointSelectRegionPointSelectRegionPointselect_region_point

See also

get_mbuttonget_mbuttonGetMbuttonGetMbuttonGetMbuttonget_mbutton, get_mpositionget_mpositionGetMpositionGetMpositionGetMpositionget_mposition, test_region_pointtest_region_pointTestRegionPointTestRegionPointTestRegionPointtest_region_point

Module

Foundation