Skip to content

disp_ellipsedisp_ellipseDispEllipseDispEllipsedisp_ellipseT_disp_ellipse🔗

Short description🔗

disp_ellipsedisp_ellipseDispEllipseDispEllipsedisp_ellipseT_disp_ellipse — Displays ellipses.

Signature🔗

disp_ellipse( window WindowHandle, ellipse.center.y CenterRow, ellipse.center.x CenterCol, ellipse.angle.rad Phi, ellipse.radius1 Radius1, ellipse.radius2 Radius2 )disp_ellipse( : : WindowHandle, CenterRow, CenterCol, Phi, Radius1, Radius2 : )void DispEllipse( const HTuple& WindowHandle, const HTuple& CenterRow, const HTuple& CenterCol, const HTuple& Phi, const HTuple& Radius1, const HTuple& Radius2 )static void HOperatorSet.DispEllipse( HTuple windowHandle, HTuple centerRow, HTuple centerCol, HTuple phi, HTuple radius1, HTuple radius2 )def disp_ellipse( window_handle: HHandle, center_row: MaybeSequence[int], center_col: MaybeSequence[int], phi: MaybeSequence[Union[int, float]], radius_1: MaybeSequence[Union[int, float]], radius_2: MaybeSequence[Union[int, float]] ) -> None

Herror T_disp_ellipse( const Htuple WindowHandle, const Htuple CenterRow, const Htuple CenterCol, const Htuple Phi, const Htuple Radius1, const Htuple Radius2 )

void HWindow::DispEllipse( const HTuple& CenterRow, const HTuple& CenterCol, const HTuple& Phi, const HTuple& Radius1, const HTuple& Radius2 ) const

void HWindow::DispEllipse( Hlong CenterRow, Hlong CenterCol, double Phi, double Radius1, double Radius2 ) const

void HWindow.DispEllipse( HTuple centerRow, HTuple centerCol, HTuple phi, HTuple radius1, HTuple radius2 )

void HWindow.DispEllipse( int centerRow, int centerCol, double phi, double radius1, double radius2 )

Description🔗

disp_ellipseDispEllipse displays one or several ellipses in the output window. An ellipse is described by the center (CenterRowcenterRowcenter_row, CenterColcenterColcenter_col), the orientation Phiphiphi (in radians) and the radii of the major and the minor axis (Radius1radius1radius_1 and Radius2radius2radius_2).

The operators used to control the display of regions (e.g., set_drawSetDraw, set_graySetGray, set_drawSetDraw) can also be used with ellipses. Several ellipses can be displayed with one call by using tuple parameters. For the use of colors with several ellipses, see set_colorSetColor.

Attention🔗

The center of the ellipse must be within the window.

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🔗

WindowHandlewindowHandlewindow_handle (input_control) window → (handle)(handle)HTuple (HHandle)HWindow, HTuple (IntPtr)HHandleHtuple (handle)

Window handle.

CenterRowcenterRowcenter_row (input_control) ellipse.center.y(-array) → (integer)(integer)HTuple (Hlong)HTuple (int / long)MaybeSequence[int]Htuple (Hlong)

Row index of center.

Default: 6464
Suggested values: 0, 64, 128, 2560, 64, 128, 256
Value range: 0 ≤ CenterRow ≤ 511 (lin)
Minimum increment: 1
Recommended increment: 10

CenterColcenterColcenter_col (input_control) ellipse.center.x(-array) → (integer)(integer)HTuple (Hlong)HTuple (int / long)MaybeSequence[int]Htuple (Hlong)

Column index of center.

Default: 6464
Suggested values: 0, 64, 128, 2560, 64, 128, 256
Value range: 0 ≤ CenterCol ≤ 511 (lin)
Minimum increment: 1
Recommended increment: 10

Phiphiphi (input_control) ellipse.angle.rad(-array) → (real / integer)(real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[int, float]]Htuple (double / Hlong)

Orientation of the ellipse in radians

Default: 0.00.0
Suggested values: 0.0, 0.785398, 1.570796, 3.1415926, 6.2831850.0, 0.785398, 1.570796, 3.1415926, 6.283185
Value range: 0.0 ≤ Phi ≤ 6.283185 (lin)
Minimum increment: 0.01
Recommended increment: 0.1

Radius1radius1radius_1 (input_control) ellipse.radius1(-array) → (real / integer)(real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[int, float]]Htuple (double / Hlong)

Radius of major axis.

Default: 24.024.0
Suggested values: 0.0, 64.0, 128.0, 256.00.0, 64.0, 128.0, 256.0
Value range: 0.0 ≤ Radius1 ≤ 511.0 (lin)
Minimum increment: 1.0
Recommended increment: 10.0

Radius2radius2radius_2 (input_control) ellipse.radius2(-array) → (real / integer)(real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[int, float]]Htuple (double / Hlong)

Radius of minor axis.

Default: 14.014.0
Suggested values: 0.0, 64.0, 128.0, 256.00.0, 64.0, 128.0, 256.0
Value range: 0.0 ≤ Radius2 ≤ 511.0 (lin)
Minimum increment: 1.0
Recommended increment: 10.0

Example🔗

(HDevelop)


set_color(WindowHandle,'red')
draw_region(MyRegion,WindowHandle)
elliptic_axis(MyRegion,Ra,Rb,Phi)
area_center(MyRegion,_,Row,Column)
disp_ellipse(WindowHandle,Row,Column,Phi,Ra,Rb)
(C)
set_color(WindowHandle,"red")\;
T_draw_region(&MyRegion,WindowHandle)\;
elliptic_axis(MyRegion,&Ra,&Rb,&Phi)\;
area_center(MyRegion,NULL,&Row,&Column)\;
T_disp_ellipse(WindowHandle,Row,Column,Phi,Ra,Rb)\;

Result🔗

disp_ellipseDispEllipse returns 2 (H_MSG_TRUE), if the parameters are correct. Otherwise an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

open_windowOpenWindow, set_drawSetDraw, set_colorSetColor, set_coloredSetColored, set_line_widthSetLineWidth, set_rgbSetRgb, set_hsiSetHsi, elliptic_axisEllipticAxis, area_centerAreaCenter

Alternatives

disp_circleDispCircle, disp_regionDispRegion, gen_ellipseGenEllipse, gen_circleGenCircle

See also

open_windowOpenWindow, set_colorSetColor, set_rgbSetRgb, set_hsiSetHsi, set_drawSetDraw, set_line_widthSetLineWidth

Module🔗

Foundation