Skip to content

disp_colordisp_colorDispColorDispColordisp_colorT_disp_color🔗

Short description🔗

disp_colordisp_colorDispColorDispColordisp_colorT_disp_color — Displays a color (RGB) image

Signature🔗

disp_color( image ColorImage, window WindowHandle )disp_color( ColorImage : : WindowHandle : )void DispColor( const HObject& ColorImage, const HTuple& WindowHandle )static void HOperatorSet.DispColor( HObject colorImage, HTuple windowHandle )def disp_color( color_image: HObject, window_handle: HHandle ) -> None

Herror T_disp_color( const Hobject ColorImage, const Htuple WindowHandle )

void HImage::DispColor( const HWindow& WindowHandle ) const

void HWindow::DispColor( const HImage& ColorImage ) const

void HImage.DispColor( HWindow windowHandle )

void HWindow.DispColor( HImage colorImage )

Description🔗

disp_colorDispColor displays the three channels of a color image in the output window. The channels are ordered in the sequence (red,green,blue). disp_colorDispColor can be simulated by disp_channelDispChannel.

Attention🔗

Due to the restricted number of available colors the color appearance is usually different from the original.

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🔗

ColorImagecolorImagecolor_image (input_object) multichannel-image → object (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)object (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)HObject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)HImage (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)HObject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)Hobject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)

Color image to display.

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

Window handle.

Example🔗

(C)

/* disp_color(ColorImage) is identical to: */
Herror my_disp_color(Hobject ColorImage, Htuple *WindowHandle) {
  Htuple  Tupel\;
  create_tuple(&Tupel,3)\;
  set_i(Tupel,1,0)\;
  set_i(Tupel,2,1)\;
  set_i(Tupel,3,2)\;
  T_disp_channel(ColorImage,*WindowHandle,Tupel)\;
  destroy_tuple(Tupel)\;
}

Result🔗

If the used image contains valid values and a correct output mode is set, disp_colorDispColor returns 2 (H_MSG_TRUE). Otherwise an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

open_windowOpenWindow, set_rgbSetRgb, set_lutSetLut, set_hsiSetHsi

Alternatives

disp_channelDispChannel, disp_objDispObj

See also

disp_imageDispImage, open_windowOpenWindow, reset_obj_dbResetObjDb, set_lutSetLut, dump_windowDumpWindow

Module🔗

Foundation