Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in / Register
Toggle navigation
O
opencv
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Packages
Packages
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
submodule
opencv
Commits
dcae7698
Commit
dcae7698
authored
Nov 19, 2014
by
Maksim Shabunin
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Doxygen documentation for: highgui, video, imgcodecs and videoio
parent
1f43999f
Expand all
Hide whitespace changes
Inline
Side-by-side
Showing
12 changed files
with
199 additions
and
0 deletions
+199
-0
highgui.hpp
modules/highgui/include/opencv2/highgui.hpp
+0
-0
highgui_c.h
modules/highgui/include/opencv2/highgui/highgui_c.h
+6
-0
imgcodecs.hpp
modules/imgcodecs/include/opencv2/imgcodecs.hpp
+158
-0
imgcodecs_c.h
modules/imgcodecs/include/opencv2/imgcodecs/imgcodecs_c.h
+5
-0
ios.h
modules/imgcodecs/include/opencv2/imgcodecs/ios.h
+5
-0
video.hpp
modules/video/include/opencv2/video.hpp
+9
-0
background_segm.hpp
modules/video/include/opencv2/video/background_segm.hpp
+0
-0
tracking.hpp
modules/video/include/opencv2/video/tracking.hpp
+0
-0
tracking_c.h
modules/video/include/opencv2/video/tracking_c.h
+5
-0
videoio.hpp
modules/videoio/include/opencv2/videoio.hpp
+0
-0
cap_ios.h
modules/videoio/include/opencv2/videoio/cap_ios.h
+6
-0
videoio_c.h
modules/videoio/include/opencv2/videoio/videoio_c.h
+5
-0
No files found.
modules/highgui/include/opencv2/highgui.hpp
View file @
dcae7698
This diff is collapsed.
Click to expand it.
modules/highgui/include/opencv2/highgui/highgui_c.h
View file @
dcae7698
...
...
@@ -51,6 +51,10 @@
extern
"C"
{
#endif
/* __cplusplus */
/** @addtogroup highgui_c
@{
*/
/****************************************************************************************\
* Basic GUI functions *
\****************************************************************************************/
...
...
@@ -237,6 +241,8 @@ CVAPI(void) cvSetPostprocessFuncWin32_(const void* callback);
#endif
/** @} highgui_c */
#ifdef __cplusplus
}
#endif
...
...
modules/imgcodecs/include/opencv2/imgcodecs.hpp
View file @
dcae7698
...
...
@@ -45,10 +45,21 @@
#include "opencv2/core.hpp"
/**
@defgroup imgcodecs Image file reading and writing
@{
@defgroup imgcodecs_c C API
@defgroup imgcodecs_ios iOS glue
@}
*/
//////////////////////////////// image codec ////////////////////////////////
namespace
cv
{
//! @addtogroup imgcodecs
//! @{
enum
{
IMREAD_UNCHANGED
=
-
1
,
// 8bit, color or not
IMREAD_GRAYSCALE
=
0
,
// 8bit, gray
IMREAD_COLOR
=
1
,
// ?, color
...
...
@@ -77,19 +88,166 @@ enum { IMWRITE_PNG_STRATEGY_DEFAULT = 0,
IMWRITE_PNG_STRATEGY_FIXED
=
4
};
/** @brief Loads an image from a file.
@param filename Name of file to be loaded.
@param flags Flags specifying the color type of a loaded image:
- CV\_LOAD\_IMAGE\_ANYDEPTH - If set, return 16-bit/32-bit image when the input has the
corresponding depth, otherwise convert it to 8-bit.
- CV\_LOAD\_IMAGE\_COLOR - If set, always convert image to the color one
- CV\_LOAD\_IMAGE\_GRAYSCALE - If set, always convert image to the grayscale one
- **\>0** Return a 3-channel color image.
@note In the current implementation the alpha channel, if any, is stripped from the output image.
Use negative value if you need the alpha channel.
- **=0** Return a grayscale image.
- **\<0** Return the loaded image as is (with alpha channel).
The function imread loads an image from the specified file and returns it. If the image cannot be
read (because of missing file, improper permissions, unsupported or invalid format), the function
returns an empty matrix ( Mat::data==NULL ). Currently, the following file formats are supported:
- Windows bitmaps - \*.bmp, \*.dib (always supported)
- JPEG files - \*.jpeg, \*.jpg, \*.jpe (see the *Notes* section)
- JPEG 2000 files - \*.jp2 (see the *Notes* section)
- Portable Network Graphics - \*.png (see the *Notes* section)
- WebP - \*.webp (see the *Notes* section)
- Portable image format - \*.pbm, \*.pgm, \*.ppm (always supported)
- Sun rasters - \*.sr, \*.ras (always supported)
- TIFF files - \*.tiff, \*.tif (see the *Notes* section)
@note
- The function determines the type of an image by the content, not by the file extension.
- On Microsoft Windows\* OS and MacOSX\*, the codecs shipped with an OpenCV image (libjpeg,
libpng, libtiff, and libjasper) are used by default. So, OpenCV can always read JPEGs, PNGs,
and TIFFs. On MacOSX, there is also an option to use native MacOSX image readers. But beware
that currently these native image loaders give images with different pixel values because of
the color management embedded into MacOSX.
- On Linux\*, BSD flavors and other Unix-like open-source operating systems, OpenCV looks for
codecs supplied with an OS image. Install the relevant packages (do not forget the development
files, for example, "libjpeg-dev", in Debian\* and Ubuntu\*) to get the codec support or turn
on the OPENCV\_BUILD\_3RDPARTY\_LIBS flag in CMake.
@note In the case of color images, the decoded images will have the channels stored in B G R order.
*/
CV_EXPORTS_W
Mat
imread
(
const
String
&
filename
,
int
flags
=
IMREAD_COLOR
);
/** @brief Saves an image to a specified file.
@param filename Name of the file.
@param img Image to be saved.
@param params Format-specific save parameters encoded as pairs
paramId\_1, paramValue\_1, paramId\_2, paramValue\_2, ... . The following parameters are currently
supported:
- For JPEG, it can be a quality ( CV\_IMWRITE\_JPEG\_QUALITY ) from 0 to 100 (the higher is
the better). Default value is 95.
- For WEBP, it can be a quality ( CV\_IMWRITE\_WEBP\_QUALITY ) from 1 to 100 (the higher is
the better). By default (without any parameter) and for quality above 100 the lossless
compression is used.
- For PNG, it can be the compression level ( CV\_IMWRITE\_PNG\_COMPRESSION ) from 0 to 9. A
higher value means a smaller size and longer compression time. Default value is 3.
- For PPM, PGM, or PBM, it can be a binary format flag ( CV\_IMWRITE\_PXM\_BINARY ), 0 or 1.
Default value is 1.
The function imwrite saves the image to the specified file. The image format is chosen based on the
filename extension (see imread for the list of extensions). Only 8-bit (or 16-bit unsigned (CV\_16U)
in case of PNG, JPEG 2000, and TIFF) single-channel or 3-channel (with 'BGR' channel order) images
can be saved using this function. If the format, depth or channel order is different, use
Mat::convertTo , and cvtColor to convert it before saving. Or, use the universal FileStorage I/O
functions to save the image to XML or YAML format.
It is possible to store PNG images with an alpha channel 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. The sample below
shows how to create such a BGRA image and store to PNG file. It also demonstrates how to set custom
compression parameters :
@code
#include <vector>
#include <stdio.h>
#include <opencv2/opencv.hpp>
using namespace cv;
using namespace std;
void createAlphaMat(Mat &mat)
{
for (int i = 0; i < mat.rows; ++i) {
for (int j = 0; j < mat.cols; ++j) {
Vec4b& rgba = mat.at<Vec4b>(i, j);
rgba[0] = UCHAR_MAX;
rgba[1] = saturate_cast<uchar>((float (mat.cols - j)) / ((float)mat.cols) * UCHAR_MAX);
rgba[2] = saturate_cast<uchar>((float (mat.rows - i)) / ((float)mat.rows) * UCHAR_MAX);
rgba[3] = saturate_cast<uchar>(0.5 * (rgba[1] + rgba[2]));
}
}
}
int main(int argv, char **argc)
{
// Create mat with alpha channel
Mat mat(480, 640, CV_8UC4);
createAlphaMat(mat);
vector<int> compression_params;
compression_params.push_back(CV_IMWRITE_PNG_COMPRESSION);
compression_params.push_back(9);
try {
imwrite("alpha.png", mat, compression_params);
}
catch (runtime_error& ex) {
fprintf(stderr, "Exception converting image to PNG format: %s\n", ex.what());
return 1;
}
fprintf(stdout, "Saved PNG file with alpha data.\n");
return 0;
}
@endcode
*/
CV_EXPORTS_W
bool
imwrite
(
const
String
&
filename
,
InputArray
img
,
const
std
::
vector
<
int
>&
params
=
std
::
vector
<
int
>
());
/** @overload */
CV_EXPORTS_W
Mat
imdecode
(
InputArray
buf
,
int
flags
);
/** @brief Reads an image from a buffer in memory.
@param buf Input array or vector of bytes.
@param flags The same flags as in imread .
@param dst The optional output placeholder for the decoded matrix. It can save the image
reallocations when the function is called repeatedly for images of the same size.
The function reads an image from the specified buffer in the memory. If the buffer is too short or
contains invalid data, the empty matrix/image is returned.
See 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.
*/
CV_EXPORTS
Mat
imdecode
(
InputArray
buf
,
int
flags
,
Mat
*
dst
);
/** @brief Encodes an image into a memory buffer.
@param ext File extension that defines the output format.
@param img Image to be written.
@param buf Output buffer resized to fit the compressed image.
@param params Format-specific parameters. See imwrite .
The function compresses the image and stores it in the memory buffer that is resized to fit the
result. See imwrite for the list of supported formats and flags description.
@note cvEncodeImage returns single-row matrix of type CV\_8UC1 that contains encoded image as array
of bytes.
*/
CV_EXPORTS_W
bool
imencode
(
const
String
&
ext
,
InputArray
img
,
CV_OUT
std
::
vector
<
uchar
>&
buf
,
const
std
::
vector
<
int
>&
params
=
std
::
vector
<
int
>
());
//! @} imgcodecs
}
// cv
#endif //__OPENCV_IMGCODECS_HPP__
modules/imgcodecs/include/opencv2/imgcodecs/imgcodecs_c.h
View file @
dcae7698
...
...
@@ -48,6 +48,10 @@
extern
"C"
{
#endif
/* __cplusplus */
/** @addtogroup imgcodecs_c
@{
*/
enum
{
/* 8bit, color or not */
...
...
@@ -124,6 +128,7 @@ CVAPI(int) cvHaveImageWriter(const char* filename);
#define cvvSaveImage cvSaveImage
#define cvvConvertImage cvConvertImage
/** @} imgcodecs_c */
#ifdef __cplusplus
}
...
...
modules/imgcodecs/include/opencv2/imgcodecs/ios.h
View file @
dcae7698
...
...
@@ -47,6 +47,11 @@
#import <ImageIO/ImageIO.h>
#include "opencv2/core/core.hpp"
//! @addtogroup imgcodecs_ios
//! @{
UIImage
*
MatToUIImage
(
const
cv
::
Mat
&
image
);
void
UIImageToMat
(
const
UIImage
*
image
,
cv
::
Mat
&
m
,
bool
alphaExist
=
false
);
//! @}
modules/video/include/opencv2/video.hpp
View file @
dcae7698
...
...
@@ -44,6 +44,15 @@
#ifndef __OPENCV_VIDEO_HPP__
#define __OPENCV_VIDEO_HPP__
/**
@defgroup video Video Analysis
@{
@defgroup video_motion Motion Analysis
@defgroup video_track Object Tracking
@defgroup video_c C API
@}
*/
#include "opencv2/video/tracking.hpp"
#include "opencv2/video/background_segm.hpp"
...
...
modules/video/include/opencv2/video/background_segm.hpp
View file @
dcae7698
This diff is collapsed.
Click to expand it.
modules/video/include/opencv2/video/tracking.hpp
View file @
dcae7698
This diff is collapsed.
Click to expand it.
modules/video/include/opencv2/video/tracking_c.h
View file @
dcae7698
...
...
@@ -50,6 +50,10 @@
extern
"C"
{
#endif
/** @addtogroup video_c
@{
*/
/****************************************************************************************\
* Motion Analysis *
\****************************************************************************************/
...
...
@@ -218,6 +222,7 @@ CVAPI(const CvMat*) cvKalmanCorrect( CvKalman* kalman, const CvMat* measurement
#define cvKalmanUpdateByTime cvKalmanPredict
#define cvKalmanUpdateByMeasurement cvKalmanCorrect
/** @} video_c */
#ifdef __cplusplus
}
// extern "C"
...
...
modules/videoio/include/opencv2/videoio.hpp
View file @
dcae7698
This diff is collapsed.
Click to expand it.
modules/videoio/include/opencv2/videoio/cap_ios.h
View file @
dcae7698
...
...
@@ -32,6 +32,9 @@
#import <ImageIO/ImageIO.h>
#include "opencv2/core.hpp"
//! @addtogroup videoio_ios
//! @{
/////////////////////////////////////// CvAbstractCamera /////////////////////////////////////
@class
CvAbstractCamera
;
...
...
@@ -167,3 +170,6 @@
-
(
void
)
takePicture
;
@end
//! @} videoio_ios
modules/videoio/include/opencv2/videoio/videoio_c.h
View file @
dcae7698
...
...
@@ -48,6 +48,10 @@
extern
"C"
{
#endif
/* __cplusplus */
/**
@addtogroup videoio_c
@{
*/
/****************************************************************************************\
* Working with Video Files and Cameras *
...
...
@@ -416,6 +420,7 @@ CVAPI(void) cvReleaseVideoWriter( CvVideoWriter** writer );
#define cvCreateAVIWriter cvCreateVideoWriter
#define cvWriteToAVI cvWriteFrame
/** @} videoio_c */
#ifdef __cplusplus
}
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment