Skip to content

gen_region_linegen_region_lineGenRegionLineGenRegionLinegen_region_linegen_region_line🔗

Short description🔗

gen_region_linegen_region_lineGenRegionLineGenRegionLinegen_region_linegen_region_line — Store input lines as regions.

Signature🔗

gen_region_line( out region RegionLines, line.begin.y BeginRow, line.begin.x BeginCol, line.end.y EndRow, line.end.x EndCol )gen_region_line( : RegionLines : BeginRow, BeginCol, EndRow, EndCol : )void GenRegionLine( HObject* RegionLines, const HTuple& BeginRow, const HTuple& BeginCol, const HTuple& EndRow, const HTuple& EndCol )static void HOperatorSet.GenRegionLine( out HObject regionLines, HTuple beginRow, HTuple beginCol, HTuple endRow, HTuple 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

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

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

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

Description🔗

The operator gen_region_lineGenRegionLine stores the given lines (with starting point [BeginRowbeginRowbegin_row,BeginColbeginColbegin_col] and ending point [EndRowendRowend_row, EndColendColend_col]) as region.

Execution information🔗

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🔗

RegionLinesregionLinesregion_lines (output_object) region(-array) → objectobjectHObjectHRegionHObjectHobject *

Created regions.

BeginRowbeginRowbegin_row (input_control) line.begin.y(-array) → (integer / real)(integer / real)HTuple (Hlong / double)HTuple (int / long / double)MaybeSequence[Union[int, float]]Htuple (Hlong / double)

Line coordinates of the starting points of the input lines.

Default: 100100
Suggested values: 10, 50, 100, 200, 300, 40010, 50, 100, 200, 300, 400
Value range: BeginRow (lin)
Minimum increment: 1
Recommended increment: 1

BeginColbeginColbegin_col (input_control) line.begin.x(-array) → (integer / real)(integer / real)HTuple (Hlong / double)HTuple (int / long / double)MaybeSequence[Union[int, float]]Htuple (Hlong / double)

Column coordinates of the starting points of the input lines.

Default: 5050
Suggested values: 10, 50, 100, 200, 300, 40010, 50, 100, 200, 300, 400
Value range: BeginCol (lin)
Minimum increment: 1
Recommended increment: 1

EndRowendRowend_row (input_control) line.end.y(-array) → (integer / real)(integer / real)HTuple (Hlong / double)HTuple (int / long / double)MaybeSequence[Union[int, float]]Htuple (Hlong / double)

Line coordinates of the ending points of the input lines.

Default: 150150
Suggested values: 50, 100, 200, 300, 400, 50050, 100, 200, 300, 400, 500
Value range: EndRow (lin)
Minimum increment: 1
Recommended increment: 1

EndColendColend_col (input_control) line.end.x(-array) → (integer / real)(integer / real)HTuple (Hlong / double)HTuple (int / long / double)MaybeSequence[Union[int, float]]Htuple (Hlong / double)

Column coordinates of the ending points of the input lines.

Default: 250250
Suggested values: 50, 100, 200, 300, 400, 50050, 100, 200, 300, 400, 500
Value range: EndCol (lin)
Minimum increment: 1
Recommended increment: 1

Result🔗

The operator gen_region_lineGenRegionLine always returns the value 2 (H_MSG_TRUE). The clipping according to the global image size is determined by the operator set_system('clip_region',<'true'/'false'>).

Combinations with other operators🔗

Combinations

Possible predecessors

split_skeleton_linesSplitSkeletonLines

Alternatives

gen_region_hlineGenRegionHline

Module🔗

Foundation