get_region_runsT_get_region_runsGetRegionRunsGetRegionRunsget_region_runs (Operator)

Name

get_region_runsT_get_region_runsGetRegionRunsGetRegionRunsget_region_runs — Access the runlength coding of a region.

Signature

get_region_runs(Region : : : Row, ColumnBegin, ColumnEnd)

Herror T_get_region_runs(const Hobject Region, Htuple* Row, Htuple* ColumnBegin, Htuple* ColumnEnd)

void GetRegionRuns(const HObject& Region, HTuple* Row, HTuple* ColumnBegin, HTuple* ColumnEnd)

void HRegion::GetRegionRuns(HTuple* Row, HTuple* ColumnBegin, HTuple* ColumnEnd) const

static void HOperatorSet.GetRegionRuns(HObject region, out HTuple row, out HTuple columnBegin, out HTuple columnEnd)

void HRegion.GetRegionRuns(out HTuple row, out HTuple columnBegin, out HTuple columnEnd)

def get_region_runs(region: HObject) -> Tuple[Sequence[int], Sequence[int], Sequence[int]]

Description

The operator get_region_runsget_region_runsGetRegionRunsGetRegionRunsGetRegionRunsget_region_runs returns the region data in the form of chord tuples. The chord representation is caused by examining a region line by line with ascending line number (= from “top” to “bottom”). Every line is passed from left to right (ascending column number); storing all starting and ending points of region segments (= chords). Thus a region can be described by a sequence of chords, a chord being defined by line number, starting and ending points (column number). The operator get_region_runsget_region_runsGetRegionRunsGetRegionRunsGetRegionRunsget_region_runs returns the three components of the chords in the form of tuples. In case of an empty region three empty tuples are returned.

Attention

Only one region may be passed.

Execution Information

Parameters

RegionRegionRegionRegionregionregion (input_object)  region objectHRegionHObjectHRegionHobject

Output region.

RowRowRowRowrowrow (output_control)  chord.y-array HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Line numbers of the chords.

ColumnBeginColumnBeginColumnBeginColumnBegincolumnBegincolumn_begin (output_control)  chord.x1-array HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Column numbers of the starting points of the chords.

Number of elements: ColumnBegin == Row

ColumnEndColumnEndColumnEndColumnEndcolumnEndcolumn_end (output_control)  chord.x2-array HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Column numbers of the ending points of the chords.

Number of elements: ColumnEnd == Row

Result

The operator get_region_runsget_region_runsGetRegionRunsGetRegionRunsGetRegionRunsget_region_runs normally returns the value TRUE. If more than one region is passed an exception is raised. 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>).

Possible Predecessors

thresholdthresholdThresholdThresholdThresholdthreshold, connectionconnectionConnectionConnectionConnectionconnection

Alternatives

get_region_pointsget_region_pointsGetRegionPointsGetRegionPointsGetRegionPointsget_region_points

See also

copy_objcopy_objCopyObjCopyObjCopyObjcopy_obj, gen_region_runsgen_region_runsGenRegionRunsGenRegionRunsGenRegionRunsgen_region_runs

Module

Foundation