Skip to content

disp_crossDispCrossDispCrossdisp_crossT_disp_cross🔗

Short description🔗

disp_crossDispCrossDispCrossdisp_crossT_disp_cross — Displays crosses in a window.

Signature🔗

disp_cross( window WindowHandle, coordinates.y Row, coordinates.x Column, number Size, angle.rad Angle )void DispCross( const HTuple& WindowHandle, const HTuple& Row, const HTuple& Column, const HTuple& Size, const HTuple& Angle )static void HOperatorSet.DispCross( HTuple windowHandle, HTuple row, HTuple column, HTuple size, HTuple angle )def disp_cross( window_handle: HHandle, row: MaybeSequence[float], column: MaybeSequence[float], size: float, angle: float ) -> None

Herror T_disp_cross( const Htuple WindowHandle, const Htuple Row, const Htuple Column, const Htuple Size, const Htuple Angle )

void HWindow::DispCross( const HTuple& Row, const HTuple& Column, double Size, double Angle ) const

void HWindow::DispCross( double Row, double Column, double Size, double Angle ) const

void HWindow.DispCross( HTuple row, HTuple column, double size, double angle )

void HWindow.DispCross( double row, double column, double size, double angle )

Description🔗

disp_crossDispCross displays one or several crosses in the output window. A cross is described by the coordinates of the center point (Rowrowrow,Columncolumncolumn), the length of its bars Sizesizesize and the orientation Angleangleangle. The operators used to control the display of regions (e.g., set_colorSetColor, set_graySetGray, set_drawSetDraw, set_line_widthSetLineWidth) can also be used with crosses. Several crosses can be displayed with one call by using tuple parameters. For the use of colors with several crosses, see set_colorSetColor.

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)HTuple (HHandle)HWindow, HTuple (IntPtr)HHandleHtuple (handle)

Window handle.

Rowrowrow (input_control) coordinates.y(-array) → (real)HTuple (double)HTuple (double)MaybeSequence[float]Htuple (double)

Row coordinate of the center.

Default: 32.032.0
Suggested values: 0.0, 64.0, 128.0, 256.0, 511.00.0, 64.0, 128.0, 256.0, 511.0

Columncolumncolumn (input_control) coordinates.x(-array) → (real)HTuple (double)HTuple (double)MaybeSequence[float]Htuple (double)

Column coordinate of the center.

Default: 32.032.0
Suggested values: 0.0, 64.0, 128.0, 256.0, 511.00.0, 64.0, 128.0, 256.0, 511.0

Sizesizesize (input_control) number → (real)HTuple (double)HTuple (double)floatHtuple (double)

Length of the bars.

Default: 6.06.0
Suggested values: 4.0, 6.0, 8.0, 10.04.0, 6.0, 8.0, 10.0
Value range: 0.0 ≤ Size

Angleangleangle (input_control) angle.rad → (real)HTuple (double)HTuple (double)floatHtuple (double)

Orientation.

Default: 0.00.0
Suggested values: 0.0, 0.785398163397448309615660845819880.0, 0.78539816339744830961566084581988

Result🔗

disp_crossDispCross returns 2 (H_MSG_TRUE).

Combinations with other operators🔗

Combinations

Possible predecessors

open_windowOpenWindow, set_rgbSetRgb, set_lutSetLut, set_hsiSetHsi, set_drawSetDraw, set_colorSetColor, set_coloredSetColored, set_line_widthSetLineWidth

Alternatives

disp_arrowDispArrow, disp_rectangle1DispRectangle1, disp_rectangle2DispRectangle2, disp_circleDispCircle

See also

open_windowOpenWindow, set_colorSetColor, set_rgbSetRgb, set_hsiSetHsi, set_line_widthSetLineWidth

Module🔗

Foundation