disp_channelDispChannelDispChanneldisp_channelT_disp_channel
Short description
disp_channelDispChannelDispChanneldisp_channelT_disp_channel — Displays images with several channels.
Signature
disp_channel( image MultichannelImage, window WindowHandle, integer Channel )void DispChannel( const HObject& MultichannelImage, const HTuple& WindowHandle, const HTuple& Channel )static void HOperatorSet.DispChannel( HObject multichannelImage, HTuple windowHandle, HTuple channel )def disp_channel( multichannel_image: HObject, window_handle: HHandle, channel: MaybeSequence[int] ) -> None
Herror T_disp_channel( const Hobject MultichannelImage, const Htuple WindowHandle, const Htuple Channel )
void HImage::DispChannel( const HWindow& WindowHandle, const HTuple& Channel ) const
void HImage::DispChannel( const HWindow& WindowHandle, Hlong Channel ) const
void HWindow::DispChannel( const HImage& MultichannelImage, const HTuple& Channel ) const
void HWindow::DispChannel( const HImage& MultichannelImage, Hlong Channel ) const
void HImage.DispChannel( HWindow windowHandle, HTuple channel )
void HImage.DispChannel( HWindow windowHandle, int channel )
void HWindow.DispChannel( HImage multichannelImage, HTuple channel )
void HWindow.DispChannel( HImage multichannelImage, int channel )
Description
disp_channelDispChannel displays an image in the output window.
It is possible to display several images with one call. In this case the
images are displayed one after another. If the definition domains of the
images overlap only the last image is visible. The parameter
Channelchannelchannel defines the number of the channel that is displayed.
For RGB-images the three color channels have to be used within a tuple
parameter. For more information see disp_imageDispImage.
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
MultichannelImagemultichannelImagemultichannel_image (input_object) (multichannel-)image(-array) → 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)
Multichannel images to be displayed.
WindowHandlewindowHandlewindow_handle (input_control) window → (handle)HTuple (HHandle)HWindow, HTuple (IntPtr)HHandleHtuple (handle)
Window handle.
Channelchannelchannel (input_control) integer(-array) → (integer)HTuple (Hlong)HTuple (int / long)MaybeSequence[int]Htuple (Hlong)
Number of channel or the numbers of the RGB-channels
Default: 11
Suggested values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 101, 2, 3, 4, 5, 6, 7, 8, 9, 10
Example
(HDevelop)
read_image(Image,'patras')
count_channels (Image, Channels)
for I := 1 to Channels by 1
disp_channel (Image, WindowHandle, I)
endfor
Result
If the used images contain valid values and a correct
output mode is set, disp_channelDispChannel 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_imageDispImage, disp_colorDispColor
See also
open_windowOpenWindow, reset_obj_dbResetObjDb, set_lutSetLut, dump_windowDumpWindow
Module
Foundation