Skip to content

Commit

Permalink
add all funcs in supported modules with perl maint/genlists all
Browse files Browse the repository at this point in the history
  • Loading branch information
mohawk2 committed Mar 25, 2023
1 parent 53646ea commit 028cea8
Show file tree
Hide file tree
Showing 11 changed files with 4,414 additions and 0 deletions.
147 changes: 147 additions & 0 deletions Highgui/funclist.pl
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,15 @@
The function destroyWindow destroys the window with the given name.
@param winname Name of the window to be destroyed.',0,'void',['String','winname','',['/C','/Ref']]],
['','destroyAllWindows','@brief Destroys all of the HighGUI windows.
The function destroyAllWindows destroys all of the opened HighGUI windows.',0,'void'],
['','startWindowThread','',0,'int'],
['','waitKeyEx','@brief Similar to #waitKey, but returns full key code.
@note
Key code is implementation specific and depends on used backend: QT/GTK/Win32/etc',0,'int',['int','delay','0',[]]],
['','waitKey','@brief Waits for a pressed key.
The function waitKey waits for a key event infinitely (when \\f$\\texttt{delay}\\leq 0\\f$ ) or for delay
Expand All @@ -46,6 +55,17 @@
active. If there are several HighGUI windows, any of them can be active.
@param delay Delay in milliseconds. 0 is the special value that means "forever".',0,'int',['int','delay','0',[]]],
['','pollKey','@brief Polls for a pressed key.
The function pollKey polls for a key event without waiting. It returns the code of the pressed key
or -1 if no key was pressed since the last invocation. To wait until a key was pressed, use #waitKey.
@note The functions #waitKey and #pollKey are the only methods in HighGUI that can fetch and handle
GUI events, so one of them 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.',0,'int'],
['','imshow','@brief Displays an image in the specified window.
The function imshow displays an image in the specified window. If the window was created with the
Expand Down Expand Up @@ -82,6 +102,49 @@
@param winname Name of the window.
@param mat Image to be shown.',0,'void',['String','winname','',['/C','/Ref']],['Mat','mat','',[]]],
['','resizeWindow','@brief Resizes the window to the specified size
@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.
@param winname Window name.
@param width The new window width.
@param height The new window height.',0,'void',['String','winname','',['/C','/Ref']],['int','width','',[]],['int','height','',[]]],
['','resizeWindow','@overload
@param winname Window name.
@param size The new window size.',0,'void',['String','winname','',['/C','/Ref']],['Size','size','',['/C','/Ref']]],
['','moveWindow','@brief Moves the window to the specified position
@param winname Name of the window.
@param x The new x-coordinate of the window.
@param y The new y-coordinate of the window.',0,'void',['String','winname','',['/C','/Ref']],['int','x','',[]],['int','y','',[]]],
['','setWindowProperty','@brief Changes parameters of a window dynamically.
The function setWindowProperty enables changing properties of a window.
@param winname Name of the window.
@param prop_id Window property to edit. The supported operation flags are: (cv::WindowPropertyFlags)
@param prop_value New value of the window property. The supported flags are: (cv::WindowFlags)',0,'void',['String','winname','',['/C','/Ref']],['int','prop_id','',[]],['double','prop_value','',[]]],
['','setWindowTitle','@brief Updates window title
@param winname Name of the window.
@param title New title.',0,'void',['String','winname','',['/C','/Ref']],['String','title','',['/C','/Ref']]],
['','getWindowProperty','@brief Provides parameters of a window.
The function getWindowProperty returns properties of a window.
@param winname Name of the window.
@param prop_id Window property to retrieve. The following operation flags are available: (cv::WindowPropertyFlags)
@sa setWindowProperty',0,'double',['String','winname','',['/C','/Ref']],['int','prop_id','',[]]],
['','getWindowImageRect','@brief Provides rectangle of image in the window.
The function getWindowImageRect returns the client screen coordinates, width and height of the image rendering area.
@param winname Name of the window.
@sa resizeWindow moveWindow',0,'Rect',['String','winname','',['/C','/Ref']]],
['','selectROI','@brief Allows users to select a ROI on the given image.
The function creates a window and allows users to select a ROI using the mouse.
Expand All @@ -97,6 +160,68 @@
@note The function sets it\'s own mouse callback for specified window using cv::setMouseCallback(windowName, ...).
After finish of work an empty callback will be set for the used window.',0,'Rect',['String','windowName','',['/C','/Ref']],['Mat','img','',[]],['bool','showCrosshair','true',[]],['bool','fromCenter','false',[]]],
['','selectROI','@overload',0,'Rect',['Mat','img','',[]],['bool','showCrosshair','true',[]],['bool','fromCenter','false',[]]],
['','selectROIs','@brief Allows users to select multiple ROIs on the given image.
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,
use `esc` to terminate multiple ROI selection process.
@param windowName name of the window where selection process will be shown.
@param img image to select a ROI.
@param boundingBoxes selected ROIs.
@param showCrosshair if true crosshair of selection rectangle will be shown.
@param fromCenter if true center of selection will match initial mouse position. In opposite case a corner of
selection rectangle will correspont to the initial mouse position.
@note The function sets it\'s own mouse callback for specified window using cv::setMouseCallback(windowName, ...).
After finish of work an empty callback will be set for the used window.',0,'void',['String','windowName','',['/C','/Ref']],['Mat','img','',[]],['vector_Rect','boundingBoxes','',['/O','/Ref']],['bool','showCrosshair','true',[]],['bool','fromCenter','false',[]]],
['','getTrackbarPos','@brief Returns the trackbar position.
The function returns the current position of the specified trackbar.
@note
[__Qt Backend Only__] winname can be empty if the trackbar is attached to the control
panel.
@param trackbarname Name of the trackbar.
@param winname Name of the window that is the parent of the trackbar.',0,'int',['String','trackbarname','',['/C','/Ref']],['String','winname','',['/C','/Ref']]],
['','setTrackbarPos','@brief Sets the trackbar position.
The function sets the position of the specified trackbar in the specified window.
@note
[__Qt Backend Only__] winname can be empty if the trackbar is attached to the control
panel.
@param trackbarname Name of the trackbar.
@param winname Name of the window that is the parent of trackbar.
@param pos New position.',0,'void',['String','trackbarname','',['/C','/Ref']],['String','winname','',['/C','/Ref']],['int','pos','',[]]],
['','setTrackbarMax','@brief Sets the trackbar maximum position.
The function sets the maximum position of the specified trackbar in the specified window.
@note
[__Qt Backend Only__] winname can be empty if the trackbar is attached to the control
panel.
@param trackbarname Name of the trackbar.
@param winname Name of the window that is the parent of trackbar.
@param maxval New maximum position.',0,'void',['String','trackbarname','',['/C','/Ref']],['String','winname','',['/C','/Ref']],['int','maxval','',[]]],
['','setTrackbarMin','@brief Sets the trackbar minimum position.
The function sets the minimum position of the specified trackbar in the specified window.
@note
[__Qt Backend Only__] winname can be empty if the trackbar is attached to the control
panel.
@param trackbarname Name of the trackbar.
@param winname Name of the window that is the parent of trackbar.
@param minval New minimum position.',0,'void',['String','trackbarname','',['/C','/Ref']],['String','winname','',['/C','/Ref']],['int','minval','',[]]],
['','addText','@brief Draws a text on the image.
@param img 8-bit 3-channel image where the text should be drawn.
Expand All @@ -110,4 +235,26 @@
@param weight Font weight. Available operation flags are : cv::QtFontWeights You can also specify a positive integer for better control.
@param style Font style. Available operation flags are : cv::QtFontStyles
@param spacing Spacing between characters. It can be negative or positive.',0,'void',['Mat','img','',['/C','/Ref']],['String','text','',['/C','/Ref']],['Point','org','',[]],['String','nameFont','',['/C','/Ref']],['int','pointSize','-1',[]],['Scalar','color','Scalar::all(0)',[]],['int','weight','QT_FONT_NORMAL',[]],['int','style','QT_STYLE_NORMAL',[]],['int','spacing','0',[]]],
['','displayOverlay','@brief Displays a text on a window image as an overlay for a specified duration.
The function displayOverlay displays useful information/tips on top of the window for a certain
amount of time *delayms*. The function does not modify the image, displayed in the window, that is,
after the specified delay the original content of the window is restored.
@param winname Name of the window.
@param text Overlay text to write on a window image.
@param delayms The period (in milliseconds), during which the overlay text is displayed. If this
function is called before the previous overlay text timed out, the timer is restarted and the text
is updated. If this value is zero, the text never disappears.',0,'void',['String','winname','',['/C','/Ref']],['String','text','',['/C','/Ref']],['int','delayms','0',[]]],
['','displayStatusBar','@brief Displays a text on the window statusbar during the specified period of time.
The function displayStatusBar displays useful information/tips on top of the window for a certain
amount of time *delayms* . This information is displayed on the window statusbar (the window must be
created with the CV_GUI_EXPANDED flags).
@param winname Name of the window.
@param text Text to write on the window statusbar.
@param delayms Duration (in milliseconds) to display the text. If this function is called before
the previous text timed out, the timer is restarted and the text is updated. If this value is
zero, the text never disappears.',0,'void',['String','winname','',['/C','/Ref']],['String','text','',['/C','/Ref']],['int','delayms','0',[]]],
);
66 changes: 66 additions & 0 deletions Imgcodecs/funclist.pl
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,66 @@
@param filename Name of file to be loaded.
@param flags Flag that can take values of cv::ImreadModes',0,'Mat',['String','filename','',['/C','/Ref']],['int','flags','IMREAD_COLOR',[]]],
['','imreadmulti','@brief Loads a multi-page image from a file.
The function imreadmulti loads a multi-page image from the specified file into a vector of Mat objects.
@param filename Name of file to be loaded.
@param flags Flag that can take values of cv::ImreadModes, default with cv::IMREAD_ANYCOLOR.
@param mats A vector of Mat objects holding each page, if more than one.
@sa cv::imread',0,'bool',['String','filename','',['/C','/Ref']],['vector_Mat','mats','',['/O','/Ref']],['int','flags','IMREAD_ANYCOLOR',[]]],
['','imreadmulti','@brief Loads a of images of a multi-page image from a file.
The function imreadmulti loads a specified range from a multi-page image from the specified file into a vector of Mat objects.
@param filename Name of file to be loaded.
@param start Start index of the image to load
@param count Count number of images to load
@param flags Flag that can take values of cv::ImreadModes, default with cv::IMREAD_ANYCOLOR.
@param mats A vector of Mat objects holding each page, if more than one.
@sa cv::imread',0,'bool',['String','filename','',['/C','/Ref']],['vector_Mat','mats','',['/O','/Ref']],['int','start','',[]],['int','count','',[]],['int','flags','IMREAD_ANYCOLOR',[]]],
['','imcount','@brief Returns the number of images inside the give file
The function imcount will return the number of pages in a multi-page image, or 1 for single-page images
@param filename Name of file to be loaded.
@param flags Flag that can take values of cv::ImreadModes, default with cv::IMREAD_ANYCOLOR.',0,'size_t',['String','filename','',['/C','/Ref']],['int','flags','IMREAD_ANYCOLOR',[]]],
['','imwrite','@brief Saves an image to a specified file.
The function imwrite saves the image to the specified file. The image format is chosen based on the
filename extension (see cv::imread for the list of extensions). In general, only 8-bit
single-channel or 3-channel (with \'BGR\' channel order) images
can be saved using this function, with these exceptions:
- 16-bit unsigned (CV_16U) images can be saved in the case of PNG, JPEG 2000, and TIFF formats
- 32-bit float (CV_32F) images can be saved in PFM, TIFF, OpenEXR, and Radiance HDR formats;
3-channel (CV_32FC3) TIFF images will be saved using the LogLuv high dynamic range encoding
(4 bytes per pixel)
- PNG images with an alpha channel can be saved using this function. To do this, create
8-bit (or 16-bit) 4-channel image BGRA, where the alpha channel goes last. Fully transparent pixels
should have alpha set to 0, fully opaque pixels should have alpha set to 255/65535 (see the code sample below).
- Multiple images (vector of Mat) can be saved in TIFF format (see the code sample below).
If the image format is not supported, the image will be converted to 8-bit unsigned (CV_8U) and saved that way.
If the format, depth or channel order is different, use
Mat::convertTo and cv::cvtColor to convert it before saving. Or, use the universal FileStorage I/O
functions to save the image to XML or YAML format.
The sample below shows how to create a BGRA image, how to set custom compression parameters and save it to a PNG file.
It also demonstrates how to save multiple images in a TIFF file:
@include snippets/imgcodecs_imwrite.cpp
@param filename Name of the file.
@param img (Mat or vector of Mat) Image or Images to be saved.
@param params Format-specific parameters encoded as pairs (paramId_1, paramValue_1, paramId_2, paramValue_2, ... .) see cv::ImwriteFlags',0,'bool',['String','filename','',['/C','/Ref']],['Mat','img','',[]],['vector_int','params','std::vector<int>()',['/C','/Ref']]],
['','imwritemulti','',0,'bool',['String','filename','',['/C','/Ref']],['vector_Mat','img','',[]],['vector_int','params','std::vector<int>()',['/C','/Ref']]],
['','imdecode','@brief Reads an image from a buffer in memory.
The function imdecode reads an image from the specified buffer in the memory. If the buffer is too short or
contains invalid data, the function returns an empty matrix ( Mat::data==NULL ).
See cv::imread for the list of supported formats and flags description.
@note In the case of color images, the decoded images will have the channels stored in **B G R** order.
@param buf Input array or vector of bytes.
@param flags The same flags as in cv::imread, see cv::ImreadModes.',0,'Mat',['Mat','buf','',[]],['int','flags','',[]]],
['','imencode','@brief Encodes an image into a memory buffer.
The function imencode compresses the image and stores it in the memory buffer that is resized to fit the
Expand All @@ -58,4 +118,10 @@
@param img Image to be written.
@param buf Output buffer resized to fit the compressed image.
@param params Format-specific parameters. See cv::imwrite and cv::ImwriteFlags.',0,'bool',['String','ext','',['/C','/Ref']],['Mat','img','',[]],['vector_uchar','buf','',['/O','/Ref']],['vector_int','params','std::vector<int>()',['/C','/Ref']]],
['','haveImageReader','@brief Returns true if the specified image can be decoded by OpenCV
@param filename File name of the image',0,'bool',['String','filename','',['/C','/Ref']]],
['','haveImageWriter','@brief Returns true if an image with the specified filename can be encoded by OpenCV
@param filename File name of the image',0,'bool',['String','filename','',['/C','/Ref']]],
);
6 changes: 6 additions & 0 deletions Imgproc/classes.pl
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
(
['GeneralizedHough',['Algorithm'],'@brief finds arbitrary template in the grayscale image using Generalized Hough Transform'],
['GeneralizedHoughBallard',['GeneralizedHough'],'@brief finds arbitrary template in the grayscale image using Generalized Hough Transform
Detects position only without translation and rotation @cite Ballard1981 .',1,'cv::createGeneralizedHoughBallard',[[[],'@brief Creates a smart pointer to a cv::GeneralizedHoughBallard class and initializes it.']]],
['GeneralizedHoughGuil',['GeneralizedHough'],'@brief finds arbitrary template in the grayscale image using Generalized Hough Transform
Detects position, translation and rotation @cite Guil1999 .',1,'cv::createGeneralizedHoughGuil',[[[],'@brief Creates a smart pointer to a cv::GeneralizedHoughGuil class and initializes it.']]],
['CLAHE',['Algorithm'],'@brief Base class for Contrast Limited Adaptive Histogram Equalization.',1,'cv::createCLAHE',[[[['double','clipLimit','40.0',[]],['Size','tileGridSize','Size(8, 8)',[]]],'@brief Creates a smart pointer to a cv::CLAHE class and initializes it.
@param clipLimit Threshold for contrast limiting.
Expand Down

0 comments on commit 028cea8

Please sign in to comment.