get_region_indexget_region_indexGetRegionIndexGetRegionIndexget_region_index (Operator)


get_region_indexget_region_indexGetRegionIndexGetRegionIndexget_region_index — Index of all regions containing a given pixel.


get_region_index(Regions : : Row, Column : Index)

Herror get_region_index(const Hobject Regions, const Hlong Row, const Hlong Column, Hlong* Index)

Herror T_get_region_index(const Hobject Regions, const Htuple Row, const Htuple Column, Htuple* Index)

void GetRegionIndex(const HObject& Regions, const HTuple& Row, const HTuple& Column, HTuple* Index)

HTuple HRegion::GetRegionIndex(Hlong Row, Hlong Column) const

static void HOperatorSet.GetRegionIndex(HObject regions, HTuple row, HTuple column, out HTuple index)

HTuple HRegion.GetRegionIndex(int row, int column)

def get_region_index(regions: HObject, row: int, column: int) -> Sequence[int]

def get_region_index_s(regions: HObject, row: int, column: int) -> int


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.


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


RegionsRegionsRegionsRegionsregionsregions (input_object)  region-array objectHRegionHObjectHRegionHobject

Regions to be examined.

RowRowRowRowrowrow (input_control)  point.y HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Line index of the test pixel.

Default value: 100

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

ColumnColumnColumnColumncolumncolumn (input_control)  point.x HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Column index of the test pixel.

Default value: 100

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

IndexIndexIndexIndexindexindex (output_control)  integer(-array) HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Index of the regions containing the test pixel.


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).


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



See also

get_mbuttonget_mbuttonGetMbuttonGetMbuttonGetMbuttonget_mbutton, get_mpositionget_mpositionGetMpositionGetMpositionGetMpositionget_mposition, test_region_pointtest_region_pointTestRegionPointTestRegionPointTestRegionPointtest_region_point