ClassesClassesClassesClasses | | | | Operators

get_region_indexget_region_indexGetRegionIndexget_region_indexGetRegionIndexGetRegionIndex (Operator)


get_region_indexget_region_indexGetRegionIndexget_region_indexGetRegionIndexGetRegionIndex — 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)

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

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

HTuple HRegionArray::GetRegionIndex(const HTuple& Row, const HTuple& Column) const

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

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

void HOperatorSetX.GetRegionIndex(
[in] IHUntypedObjectX* Regions, [in] VARIANT Row, [in] VARIANT Column, [out] VARIANT* Index)

VARIANT HRegionX.GetRegionIndex(
[in] Hlong Row, [in] Hlong Column)

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

HTuple HRegion.GetRegionIndex(int row, int column)


The operator get_region_indexget_region_indexGetRegionIndexget_region_indexGetRegionIndexGetRegionIndex returns the index of all regions in RegionsRegionsRegionsRegionsRegionsregions (range of values: 1 to n) containing the test pixel (RowRowRowRowRowrow,ColumnColumnColumnColumnColumncolumn), i.e.:

   |Region[n] intersection {(Row,Column)}| = {(Row,Column)}

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



RegionsRegionsRegionsRegionsRegionsregions (input_object)  region-array objectHRegionHRegionHRegionArrayHRegionXHobject

Regions to be examined.

RowRowRowRowRowrow (input_control)  point.y HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (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 HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (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) HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (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_indexGetRegionIndexget_region_indexGetRegionIndexGetRegionIndex 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>)set_system("no_object_result",<Result>)SetSystem("no_object_result",<Result>)SetSystem("no_object_result",<Result>). If necessary an exception is raised.

Possible Predecessors

thresholdthresholdThresholdthresholdThresholdThreshold, regiongrowingregiongrowingRegiongrowingregiongrowingRegiongrowingRegiongrowing, connectionconnectionConnectionconnectionConnectionConnection



See also

get_mbuttonget_mbuttonGetMbuttonget_mbuttonGetMbuttonGetMbutton, get_mpositionget_mpositionGetMpositionget_mpositionGetMpositionGetMposition, test_region_pointtest_region_pointTestRegionPointtest_region_pointTestRegionPointTestRegionPoint



ClassesClassesClassesClasses | | | | Operators