update documentation

pull/18675/head
Suleyman TURKMEN 4 years ago
parent 4a0760719e
commit cc7f17f011
  1. 9
      modules/core/include/opencv2/core.hpp
  2. 29
      modules/highgui/include/opencv2/highgui.hpp
  3. 6
      modules/imgcodecs/include/opencv2/imgcodecs.hpp

@ -202,6 +202,9 @@ enum CovarFlags {
COVAR_COLS = 16 COVAR_COLS = 16
}; };
//! @addtogroup core_cluster
//! @{
//! k-Means flags //! k-Means flags
enum KmeansFlags { enum KmeansFlags {
/** Select random initial centers in each attempt.*/ /** Select random initial centers in each attempt.*/
@ -215,6 +218,8 @@ enum KmeansFlags {
KMEANS_USE_INITIAL_LABELS = 1 KMEANS_USE_INITIAL_LABELS = 1
}; };
//! @} core_cluster
//! type of line //! type of line
enum LineTypes { enum LineTypes {
FILLED = -1, FILLED = -1,
@ -236,12 +241,16 @@ enum HersheyFonts {
FONT_ITALIC = 16 //!< flag for italic font FONT_ITALIC = 16 //!< flag for italic font
}; };
//! @addtogroup core_array
//! @{
enum ReduceTypes { REDUCE_SUM = 0, //!< the output is the sum of all rows/columns of the matrix. enum ReduceTypes { REDUCE_SUM = 0, //!< the output is the sum of all rows/columns of the matrix.
REDUCE_AVG = 1, //!< the output is the mean vector of all rows/columns of the matrix. REDUCE_AVG = 1, //!< the output is the mean vector of all rows/columns of the matrix.
REDUCE_MAX = 2, //!< the output is the maximum (column/row-wise) of all rows/columns of the matrix. REDUCE_MAX = 2, //!< the output is the maximum (column/row-wise) of all rows/columns of the matrix.
REDUCE_MIN = 3 //!< the output is the minimum (column/row-wise) of all rows/columns of the matrix. REDUCE_MIN = 3 //!< the output is the minimum (column/row-wise) of all rows/columns of the matrix.
}; };
//! @} core_array
/** @brief Swaps two matrices /** @brief Swaps two matrices
*/ */

@ -66,6 +66,7 @@ It provides easy interface to:
- Add trackbars to the windows, handle simple mouse events as well as keyboard commands. - Add trackbars to the windows, handle simple mouse events as well as keyboard commands.
@{ @{
@defgroup highgui_window_flags Flags related creating and manipulating HighGUI windows and mouse events
@defgroup highgui_opengl OpenGL support @defgroup highgui_opengl OpenGL support
@defgroup highgui_qt Qt New Functions @defgroup highgui_qt Qt New Functions
@ -93,7 +94,7 @@ It provides easy interface to:
namedWindow("main1",WINDOW_NORMAL); namedWindow("main1",WINDOW_NORMAL);
namedWindow("main2",WINDOW_AUTOSIZE | CV_GUI_NORMAL); namedWindow("main2",WINDOW_AUTOSIZE | WINDOW_GUI_NORMAL);
createTrackbar( "track1", "main1", &value, 255, NULL); createTrackbar( "track1", "main1", &value, 255, NULL);
String nameb1 = "button1"; String nameb1 = "button1";
@ -178,6 +179,9 @@ namespace cv
//! @addtogroup highgui //! @addtogroup highgui
//! @{ //! @{
//! @addtogroup highgui_window_flags
//! @{
//! Flags for cv::namedWindow //! Flags for cv::namedWindow
enum WindowFlags { enum WindowFlags {
WINDOW_NORMAL = 0x00000000, //!< the user can resize the window (no constraint) / also use to switch a fullscreen window to a normal size. WINDOW_NORMAL = 0x00000000, //!< the user can resize the window (no constraint) / also use to switch a fullscreen window to a normal size.
@ -227,6 +231,11 @@ enum MouseEventFlags {
EVENT_FLAG_ALTKEY = 32 //!< indicates that ALT Key is pressed. EVENT_FLAG_ALTKEY = 32 //!< indicates that ALT Key is pressed.
}; };
//! @} highgui_window_flags
//! @addtogroup highgui_qt
//! @{
//! Qt font weight //! Qt font weight
enum QtFontWeights { enum QtFontWeights {
QT_FONT_LIGHT = 25, //!< Weight of 25 QT_FONT_LIGHT = 25, //!< Weight of 25
@ -251,6 +260,8 @@ enum QtButtonTypes {
QT_NEW_BUTTONBAR = 1024 //!< Button should create a new buttonbar QT_NEW_BUTTONBAR = 1024 //!< Button should create a new buttonbar
}; };
//! @} highgui_qt
/** @brief Callback function for mouse events. see cv::setMouseCallback /** @brief Callback function for mouse events. see cv::setMouseCallback
@param event one of the cv::MouseEventTypes constants. @param event one of the cv::MouseEventTypes constants.
@param x The x-coordinate of the mouse event. @param x The x-coordinate of the mouse event.
@ -389,7 +400,7 @@ videos, it will display the video frame-by-frame)
*/ */
CV_EXPORTS_W void imshow(const String& winname, InputArray mat); CV_EXPORTS_W void imshow(const String& winname, InputArray mat);
/** @brief Resizes window to the specified size /** @brief Resizes the window to the specified size
@note @note
@ -408,7 +419,7 @@ CV_EXPORTS_W void resizeWindow(const String& winname, int width, int height);
*/ */
CV_EXPORTS_W void resizeWindow(const String& winname, const cv::Size& size); CV_EXPORTS_W void resizeWindow(const String& winname, const cv::Size& size);
/** @brief Moves window to the specified position /** @brief Moves the window to the specified position
@param winname Name of the window. @param winname Name of the window.
@param x The new x-coordinate of the window. @param x The new x-coordinate of the window.
@ -476,8 +487,6 @@ For cv::EVENT_MOUSEWHEEL positive and negative values mean forward and backward
respectively. For cv::EVENT_MOUSEHWHEEL, where available, positive and negative values mean right and respectively. For cv::EVENT_MOUSEHWHEEL, where available, positive and negative values mean right and
left scrolling, respectively. left scrolling, respectively.
With the C API, the macro CV_GET_WHEEL_DELTA(flags) can be used alternatively.
@note @note
Mouse-wheel events are currently supported only on Windows. Mouse-wheel events are currently supported only on Windows.
@ -486,8 +495,9 @@ Mouse-wheel events are currently supported only on Windows.
*/ */
CV_EXPORTS int getMouseWheelDelta(int flags); CV_EXPORTS int getMouseWheelDelta(int flags);
/** @brief Selects ROI on the given image. /** @brief Allows users to select a ROI on the given image.
Function creates a window and allows user to select a ROI using mouse.
The function creates a window and allows users to select a ROI using the mouse.
Controls: use `space` or `enter` to finish selection, use key `c` to cancel selection (function will return the zero cv::Rect). Controls: use `space` or `enter` to finish selection, use key `c` to cancel selection (function will return the zero cv::Rect).
@param windowName name of the window where selection process will be shown. @param windowName name of the window where selection process will be shown.
@ -506,8 +516,9 @@ CV_EXPORTS_W Rect selectROI(const String& windowName, InputArray img, bool showC
*/ */
CV_EXPORTS_W Rect selectROI(InputArray img, bool showCrosshair = true, bool fromCenter = false); CV_EXPORTS_W Rect selectROI(InputArray img, bool showCrosshair = true, bool fromCenter = false);
/** @brief Selects ROIs on the given image. /** @brief Allows users to select multiple ROIs on the given image.
Function creates a window and allows user to select a ROIs using mouse.
The function creates a window and allows users to select multiple ROIs using the mouse.
Controls: use `space` or `enter` to finish current selection and start a new one, Controls: use `space` or `enter` to finish current selection and start a new one,
use `esc` to terminate multiple ROI selection process. use `esc` to terminate multiple ROI selection process.

@ -49,6 +49,7 @@
@defgroup imgcodecs Image file reading and writing @defgroup imgcodecs Image file reading and writing
@{ @{
@defgroup imgcodecs_c C API @defgroup imgcodecs_c C API
@defgroup imgcodecs_flags Flags used for image file reading and writing
@defgroup imgcodecs_ios iOS glue @defgroup imgcodecs_ios iOS glue
@} @}
*/ */
@ -60,6 +61,9 @@ namespace cv
//! @addtogroup imgcodecs //! @addtogroup imgcodecs
//! @{ //! @{
//! @addtogroup imgcodecs_flags
//! @{
//! Imread flags //! Imread flags
enum ImreadModes { enum ImreadModes {
IMREAD_UNCHANGED = -1, //!< If set, return the loaded image as is (with alpha channel, otherwise it gets cropped). Ignore EXIF orientation. IMREAD_UNCHANGED = -1, //!< If set, return the loaded image as is (with alpha channel, otherwise it gets cropped). Ignore EXIF orientation.
@ -130,6 +134,8 @@ enum ImwritePAMFlags {
IMWRITE_PAM_FORMAT_RGB_ALPHA = 5, IMWRITE_PAM_FORMAT_RGB_ALPHA = 5,
}; };
//! @} imgcodecs_flags
/** @brief Loads an image from a file. /** @brief Loads an image from a file.
@anchor imread @anchor imread

Loading…
Cancel
Save