gen_region_linegen_region_lineGenRegionLineGenRegionLinegen_region_line (Operator)

Name

gen_region_linegen_region_lineGenRegionLineGenRegionLinegen_region_line — Store input lines as regions.

Signature

gen_region_line( : RegionLines : BeginRow, BeginCol, EndRow, EndCol : )

Herror gen_region_line(Hobject* RegionLines, const Hlong BeginRow, const Hlong BeginCol, const Hlong EndRow, const Hlong EndCol)

Herror T_gen_region_line(Hobject* RegionLines, const Htuple BeginRow, const Htuple BeginCol, const Htuple EndRow, const Htuple EndCol)

void GenRegionLine(HObject* RegionLines, const HTuple& BeginRow, const HTuple& BeginCol, const HTuple& EndRow, const HTuple& EndCol)

void HRegion::GenRegionLine(const HTuple& BeginRow, const HTuple& BeginCol, const HTuple& EndRow, const HTuple& EndCol)

void HRegion::GenRegionLine(Hlong BeginRow, Hlong BeginCol, Hlong EndRow, Hlong EndCol)

static void HOperatorSet.GenRegionLine(out HObject regionLines, HTuple beginRow, HTuple beginCol, HTuple endRow, HTuple endCol)

void HRegion.GenRegionLine(HTuple beginRow, HTuple beginCol, HTuple endRow, HTuple endCol)

void HRegion.GenRegionLine(int beginRow, int beginCol, int endRow, int endCol)

def gen_region_line(begin_row: MaybeSequence[Union[int, float]], begin_col: MaybeSequence[Union[int, float]], end_row: MaybeSequence[Union[int, float]], end_col: MaybeSequence[Union[int, float]]) -> HObject

Description

The operator gen_region_linegen_region_lineGenRegionLineGenRegionLineGenRegionLinegen_region_line stores the given lines (with starting point [BeginRowBeginRowBeginRowBeginRowbeginRowbegin_row,BeginColBeginColBeginColBeginColbeginColbegin_col] and ending point [EndRowEndRowEndRowEndRowendRowend_row, EndColEndColEndColEndColendColend_col]) as region.

Execution Information

Parameters

RegionLinesRegionLinesRegionLinesRegionLinesregionLinesregion_lines (output_object)  region(-array) objectHRegionHObjectHRegionHobject *

Created regions.

BeginRowBeginRowBeginRowBeginRowbeginRowbegin_row (input_control)  line.begin.y(-array) HTupleMaybeSequence[Union[int, float]]HTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)

Line coordinates of the starting points of the input lines.

Default value: 100

Suggested values: 10, 50, 100, 200, 300, 400

Typical range of values: BeginRow BeginRow BeginRow BeginRow beginRow begin_row (lin)

Minimum increment: 1

Recommended increment: 1

BeginColBeginColBeginColBeginColbeginColbegin_col (input_control)  line.begin.x(-array) HTupleMaybeSequence[Union[int, float]]HTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)

Column coordinates of the starting points of the input lines.

Default value: 50

Suggested values: 10, 50, 100, 200, 300, 400

Typical range of values: BeginCol BeginCol BeginCol BeginCol beginCol begin_col (lin)

Minimum increment: 1

Recommended increment: 1

EndRowEndRowEndRowEndRowendRowend_row (input_control)  line.end.y(-array) HTupleMaybeSequence[Union[int, float]]HTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)

Line coordinates of the ending points of the input lines.

Default value: 150

Suggested values: 50, 100, 200, 300, 400, 500

Typical range of values: EndRow EndRow EndRow EndRow endRow end_row (lin)

Minimum increment: 1

Recommended increment: 1

EndColEndColEndColEndColendColend_col (input_control)  line.end.x(-array) HTupleMaybeSequence[Union[int, float]]HTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)

Column coordinates of the ending points of the input lines.

Default value: 250

Suggested values: 50, 100, 200, 300, 400, 500

Typical range of values: EndCol EndCol EndCol EndCol endCol end_col (lin)

Minimum increment: 1

Recommended increment: 1

Result

The operator gen_region_linegen_region_lineGenRegionLineGenRegionLineGenRegionLinegen_region_line always returns the value 2 (H_MSG_TRUE). The clipping according to the current image format is determined by the operator set_system('clip_region',<'true'/'false'>)set_system("clip_region",<"true"/"false">)SetSystem("clip_region",<"true"/"false">)SetSystem("clip_region",<"true"/"false">)SetSystem("clip_region",<"true"/"false">)set_system("clip_region",<"true"/"false">).

Possible Predecessors

split_skeleton_linessplit_skeleton_linesSplitSkeletonLinesSplitSkeletonLinesSplitSkeletonLinessplit_skeleton_lines

Alternatives

gen_region_hlinegen_region_hlineGenRegionHlineGenRegionHlineGenRegionHlinegen_region_hline

Module

Foundation