Merge pull request #1263 from abidrahmank:pyCLAHE_24

[profile/ivi/opencv.git] / modules / highgui / doc / user_interface.rst

User Interface
==============

.. highlight:: cpp

createTrackbar
------------------
Creates a trackbar and attaches it to the specified window.

.. ocv:function:: int createTrackbar( const string& trackbarname, const string& winname, int* value, int count, TrackbarCallback onChange=0, void* userdata=0)

.. ocv:cfunction:: int cvCreateTrackbar( const char* trackbar_name, const char* window_name, int* value, int count, CvTrackbarCallback on_change=NULL )

.. ocv:pyoldfunction:: cv.CreateTrackbar(trackbarName, windowName, value, count, onChange) -> None

    :param trackbarname: Name of the created trackbar.

    :param winname: Name of the window that will be used as a parent of the created trackbar.

    :param value: Optional pointer to an integer variable whose value reflects the position of the slider. Upon creation, the slider position is defined by this variable.

    :param count: Maximal position of the slider. The minimal position is always 0.

    :param onChange: Pointer to the function to be called every time the slider changes position. This function should be prototyped as  ``void Foo(int,void*);`` , where the first parameter is the trackbar position and the second parameter is the user data (see the next parameter). If the callback is the NULL pointer, no callbacks are called, but only  ``value``  is updated.

    :param userdata: User data that is passed as is to the callback. It can be used to handle trackbar events without using global variables.

The function ``createTrackbar`` creates a trackbar (a slider or range control) with the specified name and range, assigns a variable ``value`` to be a position synchronized with the trackbar and specifies the callback function ``onChange`` to be called on the trackbar position change. The created trackbar is displayed in the specified window ``winname``.

.. note::

    **[Qt Backend Only]** ``winname`` can be empty (or NULL) if the trackbar should be attached to the control panel.

Clicking the label of each trackbar enables editing the trackbar values manually.

.. note::

   * An example of using the trackbar functionality can be found at opencv_source_code/samples/cpp/connected_components.cpp

getTrackbarPos
------------------
Returns the trackbar position.

.. ocv:function:: int getTrackbarPos( const string& trackbarname, const string& winname )

.. ocv:pyfunction:: cv2.getTrackbarPos(trackbarname, winname) -> retval

.. ocv:cfunction:: int cvGetTrackbarPos( const char* trackbar_name, const char* window_name )

.. ocv:pyoldfunction:: cv.GetTrackbarPos(trackbarName, windowName) -> retval

    :param trackbarname: Name of the trackbar.

    :param winname: Name of the window that is the parent of the trackbar.

The function returns the current position of the specified trackbar.

.. note::

    **[Qt Backend Only]** ``winname`` can be empty (or NULL) if the trackbar is attached to the control panel.

imshow
----------
Displays an image in the specified window.

.. ocv:function:: void imshow( const string& winname, InputArray mat )

.. ocv:pyfunction:: cv2.imshow(winname, mat) -> None

.. ocv:cfunction:: void cvShowImage( const char* name, const CvArr* image )

.. ocv:pyoldfunction:: cv.ShowImage(name, image) -> None

    :param winname: Name of the window.

    :param image: Image to be shown.

The function ``imshow`` displays an image in the specified window. If the window was created with the ``CV_WINDOW_AUTOSIZE`` flag, the image is shown with its original size. Otherwise, the image is scaled to fit the window. The function may scale the image, depending on its depth:

    * If the image is 8-bit unsigned, it is displayed as is.

    * If the image is 16-bit unsigned or 32-bit integer, the pixels are divided by 256. That is, the value range [0,255*256] is mapped to [0,255].

    * If the image is 32-bit floating-point, the pixel values are multiplied by 255. That is, the value range [0,1] is mapped to [0,255].

If window was created with OpenGL support, ``imshow`` also support :ocv:class:`ogl::Buffer` ,  :ocv:class:`ogl::Texture2D` and  :ocv:class:`gpu::GpuMat` as input.

namedWindow
---------------
Creates a window.

.. ocv:function:: void namedWindow( const string& winname, int flags=WINDOW_AUTOSIZE )

.. ocv:pyfunction:: cv2.namedWindow(winname[, flags]) -> None

.. ocv:cfunction:: int cvNamedWindow( const char* name, int flags=CV_WINDOW_AUTOSIZE )

.. ocv:pyoldfunction:: cv.NamedWindow(name, flags=CV_WINDOW_AUTOSIZE)-> None

    :param name: Name of the window in the window caption that may be used as a window identifier.

    :param flags: Flags of the window. The supported flags are:

        * **WINDOW_NORMAL** If this is set, the user can resize the window (no constraint).

        * **WINDOW_AUTOSIZE** If this is set, the window size is automatically adjusted to fit the displayed image (see  :ocv:func:`imshow` ), and you cannot change the window size manually.

        * **WINDOW_OPENGL** If this is set, the window will be created with OpenGL support.

The function ``namedWindow`` creates a window that can be used as a placeholder for images and trackbars. Created windows are referred to by their names.

If a window with the same name already exists, the function does nothing.

You can call :ocv:func:`destroyWindow` or :ocv:func:`destroyAllWindows` to close the window and de-allocate any associated memory usage. For a simple program, you do not really have to call these functions because all the resources and windows of the application are closed automatically by the operating system upon exit.

.. note::

    Qt backend supports additional flags:

        * **CV_WINDOW_NORMAL or CV_WINDOW_AUTOSIZE:**   ``CV_WINDOW_NORMAL``  enables you to resize the window, whereas   ``CV_WINDOW_AUTOSIZE``  adjusts automatically the window size to fit the displayed image (see  :ocv:func:`imshow` ), and you cannot change the window size manually.

        * **CV_WINDOW_FREERATIO or CV_WINDOW_KEEPRATIO:** ``CV_WINDOW_FREERATIO``  adjusts the image with no respect to its ratio, whereas  ``CV_WINDOW_KEEPRATIO``  keeps the image ratio.

        * **CV_GUI_NORMAL or CV_GUI_EXPANDED:**   ``CV_GUI_NORMAL``  is the old way to draw the window without statusbar and toolbar, whereas  ``CV_GUI_EXPANDED``  is a new enhanced GUI.

    By default, ``flags == CV_WINDOW_AUTOSIZE | CV_WINDOW_KEEPRATIO | CV_GUI_EXPANDED``


destroyWindow
-------------
Destroys a window.

.. ocv:function:: void destroyWindow( const string& winname )

.. ocv:pyfunction:: cv2.destroyWindow(winname) -> None

.. ocv:cfunction:: void cvDestroyWindow( const char* name )

.. ocv:pyoldfunction:: cv.DestroyWindow(name)-> None

    :param winname: Name of the window to be destroyed.

The function ``destroyWindow`` destroys the window with the given name.


destroyAllWindows
-----------------
Destroys all of the HighGUI windows.

.. ocv:function:: void destroyAllWindows()

.. ocv:pyfunction:: cv2.destroyAllWindows() -> None

.. ocv:cfunction:: void cvDestroyAllWindows()

.. ocv:pyoldfunction:: cv.DestroyAllWindows()-> None

The function ``destroyAllWindows`` destroys all of the opened HighGUI windows.


MoveWindow
----------
Moves window to the specified position

.. ocv:function:: void moveWindow( const string& winname, int x, int y )

.. ocv:pyfunction:: cv2.moveWindow(winname, x, y) -> None

.. ocv:cfunction:: void cvMoveWindow( const char* name, int x, int y )

.. ocv:pyoldfunction:: cv.MoveWindow(name, x, y)-> None

    :param winname: Window name

    :param x: The new x-coordinate of the window

    :param y: The new y-coordinate of the window


ResizeWindow
------------
Resizes window to the specified size

.. ocv:function:: void resizeWindow( const string& winname, int width, int height )

.. ocv:pyfunction:: cv2.resizeWindow(winname, width, height) -> None

.. ocv:cfunction:: void cvResizeWindow( const char* name, int width, int height )

.. ocv:pyoldfunction:: cv.ResizeWindow(name, width, height)-> None

    :param winname: Window name

    :param width: The new window width

    :param height: The new window height

.. note::

   * The specified window size is for the image area. Toolbars are not counted.

   * Only windows created without CV_WINDOW_AUTOSIZE flag can be resized.


SetMouseCallback
----------------
Sets mouse handler for the specified window

.. ocv:function:: void setMouseCallback( const string& winname, MouseCallback onMouse, void* userdata=0 )

.. ocv:cfunction:: void cvSetMouseCallback( const char* window_name, CvMouseCallback on_mouse, void* param=NULL )

.. ocv:pyoldfunction:: cv.SetMouseCallback(windowName, onMouse, param=None) -> None

    :param winname: Window name

    :param onMouse: Mouse callback. See OpenCV samples, such as  http://code.opencv.org/projects/opencv/repository/revisions/master/entry/samples/cpp/ffilldemo.cpp, on how to specify and use the callback.

    :param userdata: The optional parameter passed to the callback.


setTrackbarPos
------------------
Sets the trackbar position.

.. ocv:function:: void setTrackbarPos( const string& trackbarname, const string& winname, int pos )

.. ocv:pyfunction:: cv2.setTrackbarPos(trackbarname, winname, pos) -> None

.. ocv:cfunction:: void cvSetTrackbarPos( const char* trackbar_name, const char* window_name, int pos )

.. ocv:pyoldfunction:: cv.SetTrackbarPos(trackbarName, windowName, pos)-> None

    :param trackbarname: Name of the trackbar.

    :param winname: Name of the window that is the parent of trackbar.

    :param pos: New position.

The function sets the position of the specified trackbar in the specified window.

.. note::

    **[Qt Backend Only]** ``winname`` can be empty (or NULL) if the trackbar is attached to the control panel.

waitKey
-----------
Waits for a pressed key.

.. ocv:function:: int waitKey(int delay=0)

.. ocv:pyfunction:: cv2.waitKey([delay]) -> retval

.. ocv:cfunction:: int cvWaitKey( int delay=0 )

.. ocv:pyoldfunction:: cv.WaitKey(delay=0)-> int

    :param delay: Delay in milliseconds. 0 is the special value that means "forever".

The function ``waitKey`` waits for a key event infinitely (when
:math:`\texttt{delay}\leq 0` ) or for ``delay`` milliseconds, when it is positive. Since the OS has a minimum time between switching threads, the function will not wait exactly ``delay`` ms, it will wait at least ``delay`` ms, depending on what else is running on your computer at that time. It returns the code of the pressed key or -1 if no key was pressed before the specified time had elapsed.

.. note::

    This function is the only method in HighGUI that can fetch and handle events, so it needs to be called periodically for normal event processing unless HighGUI is used within an environment that takes care of event processing.

.. note::

    The function only works if there is at least one HighGUI window created and the window is active. If there are several HighGUI windows, any of them can be active.

setOpenGlDrawCallback
---------------------
Set OpenGL render handler for the specified window.

.. ocv:function:: void setOpenGlDrawCallback(const string& winname, OpenGlDrawCallback onOpenGlDraw, void* userdata = 0)

    :param winname: Window name

    :param onOpenGlDraw: Draw callback.

    :param userdata: The optional parameter passed to the callback.

setOpenGlContext
----------------
Sets the specified window as current OpenGL context.

.. ocv:function:: void setOpenGlContext(const string& winname)

    :param winname: Window name

updateWindow
------------
Force window to redraw its context and call draw callback ( :ocv:func:`setOpenGlDrawCallback` ).

.. ocv:function:: void updateWindow(const string& winname)

    :param winname: Window name