Operator Reference

disp_colorT_disp_colorDispColorDispColordisp_color (Operator)

disp_colorT_disp_colorDispColorDispColordisp_color — Displays a color (RGB) image

Signature

disp_color(ColorImage : : WindowHandle : )

Herror T_disp_color(const Hobject ColorImage, const Htuple WindowHandle)

void DispColor(const HObject& ColorImage, const HTuple& WindowHandle)

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

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

static void HOperatorSet.DispColor(HObject colorImage, HTuple windowHandle)

void HImage.DispColor(HWindow windowHandle)

void HWindow.DispColor(HImage colorImage)

def disp_color(color_image: HObject, window_handle: HHandle) -> None

Description

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

Attention

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

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

ColorImageColorImageColorImagecolorImagecolor_image (input_object)  multichannel-image objectHImageHObjectHObjectHobject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)

Color image to display.

WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control)  window HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (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_colordisp_colorDispColorDispColordisp_color returns 2 ( H_MSG_TRUE) . Otherwise an exception is raised.

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowopen_window, set_rgbset_rgbSetRgbSetRgbset_rgb, set_lutset_lutSetLutSetLutset_lut, set_hsiset_hsiSetHsiSetHsiset_hsi

Alternatives

disp_channeldisp_channelDispChannelDispChanneldisp_channel, disp_objdisp_objDispObjDispObjdisp_obj

See also

disp_imagedisp_imageDispImageDispImagedisp_image, open_windowopen_windowOpenWindowOpenWindowopen_window, reset_obj_dbreset_obj_dbResetObjDbResetObjDbreset_obj_db, set_lutset_lutSetLutSetLutset_lut, dump_windowdump_windowDumpWindowDumpWindowdump_window

Module

Foundation