Operator Reference
gen_region_hline (Operator)
gen_region_hline — Store input lines described in Hesse normal form as regions.
Signature
gen_region_hline( : Regions : Orientation, Distance : )
Description
The operator gen_region_hline stores the lines described in Hesse
normal form as regions. A line is determined by the distance from the line
to the origin (Distance, corresponds to the length of the normal
vector) and the direction of the normal vector (Orientation,
corresponds to the orientation of the line ).
The directions were defined in such a way that
at Orientation = 0 the normal vector lies in the direction of
the X axis, which corresponds to a vertical line.
At Orientation =
the normal vector points in the direction
of the Y axis, i.e. a horizontal line is described.
Attention
The lines are clipped to the current maximum image format.
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
Regions (output_object) region(-array) → object
Created regions (one for every line), clipped to maximum image format.
Number of elements: Regions == Distance
Orientation (input_control) hesseline.angle.rad(-array) → (real / integer)
Orientation of the normal vector in radians.
Number of elements: Orientation == Distance
Default: 0.0
Suggested values: -0.78, 0.0, 0.78, 1.57
Value range:
Orientation
(lin)
Recommended increment: 0.02
Distance (input_control) hesseline.distance(-array) → (real / integer)
Distance from the line to the coordinate origin (0.0).
Default: 200
Suggested values: 10, 50, 100, 200, 300, 400
Value range:
Distance
(lin)
Recommended increment: 1
Result
The operator gen_region_hline always returns the value 2 (
H_MSG_TRUE)
.
Alternatives
See also
Module
Foundation