mirror of https://github.com/opencv/opencv.git
parent
887ff0de7b
commit
f65286d3c6
12 changed files with 1588 additions and 173 deletions
@ -0,0 +1,334 @@ |
||||
Camera Calibration and 3D Reconstruction |
||||
======================================== |
||||
|
||||
.. highlight:: cpp |
||||
|
||||
|
||||
|
||||
ocl::StereoBM_OCL |
||||
--------------------- |
||||
.. ocv:class:: ocl::StereoBM_OCL |
||||
|
||||
Class computing stereo correspondence (disparity map) using the block matching algorithm. :: |
||||
|
||||
class CV_EXPORTS StereoBM_OCL |
||||
{ |
||||
public: |
||||
enum { BASIC_PRESET = 0, PREFILTER_XSOBEL = 1 }; |
||||
|
||||
enum { DEFAULT_NDISP = 64, DEFAULT_WINSZ = 19 }; |
||||
|
||||
//! the default constructor |
||||
StereoBM_OCL(); |
||||
//! the full constructor taking the camera-specific preset, number of disparities and the SAD window size. ndisparities must be multiple of 8. |
||||
StereoBM_OCL(int preset, int ndisparities = DEFAULT_NDISP, int winSize = DEFAULT_WINSZ); |
||||
|
||||
//! the stereo correspondence operator. Finds the disparity for the specified rectified stereo pair |
||||
//! Output disparity has CV_8U type. |
||||
void operator() ( const oclMat &left, const oclMat &right, oclMat &disparity); |
||||
|
||||
//! Some heuristics that tries to estmate |
||||
// if current GPU will be faster then CPU in this algorithm. |
||||
// It queries current active device. |
||||
static bool checkIfGpuCallReasonable(); |
||||
|
||||
int preset; |
||||
int ndisp; |
||||
int winSize; |
||||
|
||||
// If avergeTexThreshold == 0 => post procesing is disabled |
||||
// If avergeTexThreshold != 0 then disparity is set 0 in each point (x,y) where for left image |
||||
// SumOfHorizontalGradiensInWindow(x, y, winSize) < (winSize * winSize) * avergeTexThreshold |
||||
// i.e. input left image is low textured. |
||||
float avergeTexThreshold; |
||||
private: |
||||
/* hidden */ |
||||
}; |
||||
|
||||
|
||||
The class also performs pre- and post-filtering steps: Sobel pre-filtering (if ``PREFILTER_XSOBEL`` flag is set) and low textureness filtering (if ``averageTexThreshols > 0`` ). If ``avergeTexThreshold = 0`` , low textureness filtering is disabled. Otherwise, the disparity is set to 0 in each point ``(x, y)`` , where for the left image |
||||
|
||||
.. math:: |
||||
\sum HorizontalGradiensInWindow(x, y, winSize) < (winSize \cdot winSize) \cdot avergeTexThreshold |
||||
|
||||
This means that the input left image is low textured. |
||||
|
||||
|
||||
ocl::StereoBM_OCL::StereoBM_OCL |
||||
----------------------------------- |
||||
Enables :ocv:class:`ocl::StereoBM_OCL` constructors. |
||||
|
||||
.. ocv:function:: ocl::StereoBM_OCL::StereoBM_OCL() |
||||
|
||||
.. ocv:function:: ocl::StereoBM_OCL::StereoBM_OCL(int preset, int ndisparities = DEFAULT_NDISP, int winSize = DEFAULT_WINSZ) |
||||
|
||||
:param preset: Parameter presetting: |
||||
|
||||
* **BASIC_PRESET** Basic mode without pre-processing. |
||||
|
||||
* **PREFILTER_XSOBEL** Sobel pre-filtering mode. |
||||
|
||||
:param ndisparities: Number of disparities. It must be a multiple of 8 and less or equal to 256. |
||||
|
||||
:param winSize: Block size. |
||||
|
||||
|
||||
|
||||
ocl::StereoBM_OCL::operator () |
||||
---------------------------------- |
||||
Enables the stereo correspondence operator that finds the disparity for the specified rectified stereo pair. |
||||
|
||||
.. ocv:function:: void ocl::StereoBM_OCL::operator ()(const oclMat& left, const oclMat& right, oclMat& disparity) |
||||
|
||||
:param left: Left image. Only ``CV_8UC1`` type is supported. |
||||
|
||||
:param right: Right image with the same size and the same type as the left one. |
||||
|
||||
:param disparity: Output disparity map. It is a ``CV_8UC1`` image with the same size as the input images. |
||||
|
||||
:param stream: Stream for the asynchronous version. |
||||
|
||||
|
||||
ocl::StereoBM_OCL::checkIfGpuCallReasonable |
||||
----------------------------------------------- |
||||
Uses a heuristic method to estimate whether the current GPU is faster than the CPU in this algorithm. It queries the currently active device. |
||||
|
||||
.. ocv:function:: bool ocl::StereoBM_OCL::checkIfGpuCallReasonable() |
||||
|
||||
ocl::StereoBeliefPropagation |
||||
-------------------------------- |
||||
.. ocv:class:: ocl::StereoBeliefPropagation |
||||
|
||||
Class computing stereo correspondence using the belief propagation algorithm. :: |
||||
|
||||
class CV_EXPORTS StereoBeliefPropagation |
||||
{ |
||||
public: |
||||
enum { DEFAULT_NDISP = 64 }; |
||||
enum { DEFAULT_ITERS = 5 }; |
||||
enum { DEFAULT_LEVELS = 5 }; |
||||
static void estimateRecommendedParams(int width, int height, int &ndisp, int &iters, int &levels); |
||||
explicit StereoBeliefPropagation(int ndisp = DEFAULT_NDISP, |
||||
int iters = DEFAULT_ITERS, |
||||
int levels = DEFAULT_LEVELS, |
||||
int msg_type = CV_16S); |
||||
StereoBeliefPropagation(int ndisp, int iters, int levels, |
||||
float max_data_term, float data_weight, |
||||
float max_disc_term, float disc_single_jump, |
||||
int msg_type = CV_32F); |
||||
void operator()(const oclMat &left, const oclMat &right, oclMat &disparity); |
||||
void operator()(const oclMat &data, oclMat &disparity); |
||||
int ndisp; |
||||
int iters; |
||||
int levels; |
||||
float max_data_term; |
||||
float data_weight; |
||||
float max_disc_term; |
||||
float disc_single_jump; |
||||
int msg_type; |
||||
private: |
||||
/* hidden */ |
||||
}; |
||||
|
||||
The class implements algorithm described in [Felzenszwalb2006]_ . It can compute own data cost (using a truncated linear model) or use a user-provided data cost. |
||||
|
||||
.. note:: |
||||
|
||||
``StereoBeliefPropagation`` requires a lot of memory for message storage: |
||||
|
||||
.. math:: |
||||
|
||||
width \_ step \cdot height \cdot ndisp \cdot 4 \cdot (1 + 0.25) |
||||
|
||||
and for data cost storage: |
||||
|
||||
.. math:: |
||||
|
||||
width\_step \cdot height \cdot ndisp \cdot (1 + 0.25 + 0.0625 + \dotsm + \frac{1}{4^{levels}}) |
||||
|
||||
``width_step`` is the number of bytes in a line including padding. |
||||
|
||||
|
||||
|
||||
ocl::StereoBeliefPropagation::StereoBeliefPropagation |
||||
--------------------------------------------------------- |
||||
Enables the :ocv:class:`ocl::StereoBeliefPropagation` constructors. |
||||
|
||||
.. ocv:function:: ocl::StereoBeliefPropagation::StereoBeliefPropagation(int ndisp = DEFAULT_NDISP, int iters = DEFAULT_ITERS, int levels = DEFAULT_LEVELS, int msg_type = CV_16S) |
||||
|
||||
.. ocv:function:: ocl::StereoBeliefPropagation::StereoBeliefPropagation(int ndisp, int iters, int levels, float max_data_term, float data_weight, float max_disc_term, float disc_single_jump, int msg_type = CV_32F) |
||||
|
||||
:param ndisp: Number of disparities. |
||||
|
||||
:param iters: Number of BP iterations on each level. |
||||
|
||||
:param levels: Number of levels. |
||||
|
||||
:param max_data_term: Threshold for data cost truncation. |
||||
|
||||
:param data_weight: Data weight. |
||||
|
||||
:param max_disc_term: Threshold for discontinuity truncation. |
||||
|
||||
:param disc_single_jump: Discontinuity single jump. |
||||
|
||||
:param msg_type: Type for messages. ``CV_16SC1`` and ``CV_32FC1`` types are supported. |
||||
|
||||
``StereoBeliefPropagation`` uses a truncated linear model for the data cost and discontinuity terms: |
||||
|
||||
.. math:: |
||||
|
||||
DataCost = data \_ weight \cdot \min ( \lvert Img_Left(x,y)-Img_Right(x-d,y) \rvert , max \_ data \_ term) |
||||
|
||||
.. math:: |
||||
|
||||
DiscTerm = \min (disc \_ single \_ jump \cdot \lvert f_1-f_2 \rvert , max \_ disc \_ term) |
||||
|
||||
For more details, see [Felzenszwalb2006]_. |
||||
|
||||
By default, :ocv:class:`ocl::StereoBeliefPropagation` uses floating-point arithmetics and the ``CV_32FC1`` type for messages. But it can also use fixed-point arithmetics and the ``CV_16SC1`` message type for better performance. To avoid an overflow in this case, the parameters must satisfy the following requirement: |
||||
|
||||
.. math:: |
||||
|
||||
10 \cdot 2^{levels-1} \cdot max \_ data \_ term < SHRT \_ MAX |
||||
|
||||
|
||||
|
||||
ocl::StereoBeliefPropagation::estimateRecommendedParams |
||||
----------------------------------------------------------- |
||||
Uses a heuristic method to compute the recommended parameters ( ``ndisp``, ``iters`` and ``levels`` ) for the specified image size ( ``width`` and ``height`` ). |
||||
|
||||
.. ocv:function:: void ocl::StereoBeliefPropagation::estimateRecommendedParams(int width, int height, int& ndisp, int& iters, int& levels) |
||||
|
||||
|
||||
|
||||
ocl::StereoBeliefPropagation::operator () |
||||
--------------------------------------------- |
||||
Enables the stereo correspondence operator that finds the disparity for the specified rectified stereo pair or data cost. |
||||
|
||||
.. ocv:function:: void ocl::StereoBeliefPropagation::operator ()(const oclMat& left, const oclMat& right, oclMat& disparity) |
||||
|
||||
.. ocv:function:: void ocl::StereoBeliefPropagation::operator ()(const oclMat& data, oclMat& disparity) |
||||
|
||||
:param left: Left image. ``CV_8UC1`` , ``CV_8UC3`` and ``CV_8UC4`` types are supported. |
||||
|
||||
:param right: Right image with the same size and the same type as the left one. |
||||
|
||||
:param data: User-specified data cost, a matrix of ``msg_type`` type and ``Size(<image columns>*ndisp, <image rows>)`` size. |
||||
|
||||
:param disparity: Output disparity map. If ``disparity`` is empty, the output type is ``CV_16SC1`` . Otherwise, the type is retained. |
||||
|
||||
:param stream: Stream for the asynchronous version. |
||||
|
||||
ocl::StereoConstantSpaceBP |
||||
------------------------------ |
||||
.. ocv:class:: ocl::StereoConstantSpaceBP |
||||
|
||||
Class computing stereo correspondence using the constant space belief propagation algorithm. :: |
||||
|
||||
class CV_EXPORTS StereoConstantSpaceBP |
||||
{ |
||||
public: |
||||
enum { DEFAULT_NDISP = 128 }; |
||||
enum { DEFAULT_ITERS = 8 }; |
||||
enum { DEFAULT_LEVELS = 4 }; |
||||
enum { DEFAULT_NR_PLANE = 4 }; |
||||
static void estimateRecommendedParams(int width, int height, int &ndisp, int &iters, int &levels, int &nr_plane); |
||||
explicit StereoConstantSpaceBP( |
||||
int ndisp = DEFAULT_NDISP, |
||||
int iters = DEFAULT_ITERS, |
||||
int levels = DEFAULT_LEVELS, |
||||
int nr_plane = DEFAULT_NR_PLANE, |
||||
int msg_type = CV_32F); |
||||
StereoConstantSpaceBP(int ndisp, int iters, int levels, int nr_plane, |
||||
float max_data_term, float data_weight, float max_disc_term, float disc_single_jump, |
||||
int min_disp_th = 0, |
||||
int msg_type = CV_32F); |
||||
void operator()(const oclMat &left, const oclMat &right, oclMat &disparity); |
||||
int ndisp; |
||||
int iters; |
||||
int levels; |
||||
int nr_plane; |
||||
float max_data_term; |
||||
float data_weight; |
||||
float max_disc_term; |
||||
float disc_single_jump; |
||||
int min_disp_th; |
||||
int msg_type; |
||||
bool use_local_init_data_cost; |
||||
private: |
||||
/* hidden */ |
||||
}; |
||||
|
||||
The class implements algorithm described in [Yang2010]_. ``StereoConstantSpaceBP`` supports both local minimum and global minimum data cost initialization algorithms. For more details, see the paper mentioned above. By default, a local algorithm is used. To enable a global algorithm, set ``use_local_init_data_cost`` to ``false`` . |
||||
|
||||
|
||||
ocl::StereoConstantSpaceBP::StereoConstantSpaceBP |
||||
----------------------------------------------------- |
||||
Enables the :ocv:class:`ocl::StereoConstantSpaceBP` constructors. |
||||
|
||||
.. ocv:function:: ocl::StereoConstantSpaceBP::StereoConstantSpaceBP(int ndisp = DEFAULT_NDISP, int iters = DEFAULT_ITERS, int levels = DEFAULT_LEVELS, int nr_plane = DEFAULT_NR_PLANE, int msg_type = CV_32F) |
||||
|
||||
.. ocv:function:: ocl::StereoConstantSpaceBP::StereoConstantSpaceBP(int ndisp, int iters, int levels, int nr_plane, float max_data_term, float data_weight, float max_disc_term, float disc_single_jump, int min_disp_th = 0, int msg_type = CV_32F) |
||||
|
||||
:param ndisp: Number of disparities. |
||||
|
||||
:param iters: Number of BP iterations on each level. |
||||
|
||||
:param levels: Number of levels. |
||||
|
||||
:param nr_plane: Number of disparity levels on the first level. |
||||
|
||||
:param max_data_term: Truncation of data cost. |
||||
|
||||
:param data_weight: Data weight. |
||||
|
||||
:param max_disc_term: Truncation of discontinuity. |
||||
|
||||
:param disc_single_jump: Discontinuity single jump. |
||||
|
||||
:param min_disp_th: Minimal disparity threshold. |
||||
|
||||
:param msg_type: Type for messages. ``CV_16SC1`` and ``CV_32FC1`` types are supported. |
||||
|
||||
``StereoConstantSpaceBP`` uses a truncated linear model for the data cost and discontinuity terms: |
||||
|
||||
.. math:: |
||||
|
||||
DataCost = data \_ weight \cdot \min ( \lvert I_2-I_1 \rvert , max \_ data \_ term) |
||||
|
||||
.. math:: |
||||
|
||||
DiscTerm = \min (disc \_ single \_ jump \cdot \lvert f_1-f_2 \rvert , max \_ disc \_ term) |
||||
|
||||
For more details, see [Yang2010]_. |
||||
|
||||
By default, ``StereoConstantSpaceBP`` uses floating-point arithmetics and the ``CV_32FC1`` type for messages. But it can also use fixed-point arithmetics and the ``CV_16SC1`` message type for better performance. To avoid an overflow in this case, the parameters must satisfy the following requirement: |
||||
|
||||
.. math:: |
||||
|
||||
10 \cdot 2^{levels-1} \cdot max \_ data \_ term < SHRT \_ MAX |
||||
|
||||
|
||||
|
||||
ocl::StereoConstantSpaceBP::estimateRecommendedParams |
||||
--------------------------------------------------------- |
||||
Uses a heuristic method to compute parameters (ndisp, iters, levelsand nrplane) for the specified image size (widthand height). |
||||
|
||||
.. ocv:function:: void ocl::StereoConstantSpaceBP::estimateRecommendedParams(int width, int height, int& ndisp, int& iters, int& levels, int& nr_plane) |
||||
|
||||
|
||||
|
||||
ocl::StereoConstantSpaceBP::operator () |
||||
------------------------------------------- |
||||
Enables the stereo correspondence operator that finds the disparity for the specified rectified stereo pair. |
||||
|
||||
.. ocv:function:: void ocl::StereoConstantSpaceBP::operator ()(const oclMat& left, const oclMat& right, oclMat& disparity) |
||||
|
||||
:param left: Left image. ``CV_8UC1`` , ``CV_8UC3`` and ``CV_8UC4`` types are supported. |
||||
|
||||
:param right: Right image with the same size and the same type as the left one. |
||||
|
||||
:param disparity: Output disparity map. If ``disparity`` is empty, the output type is ``CV_16SC1`` . Otherwise, the output type is ``disparity.type()`` . |
||||
|
||||
:param stream: Stream for the asynchronous version. |
After Width: | Height: | Size: 64 KiB |
@ -0,0 +1,88 @@ |
||||
ml.Machine Learning |
||||
============================= |
||||
|
||||
.. highlight:: cpp |
||||
|
||||
ocl::KNearestNeighbour |
||||
-------------------------- |
||||
.. ocv:class:: ocl::KNearestNeighbour |
||||
|
||||
The class implements K-Nearest Neighbors model as described in the beginning of this section. |
||||
|
||||
ocl::KNearestNeighbour |
||||
-------------------------- |
||||
Computes the weighted sum of two arrays. :: |
||||
|
||||
class CV_EXPORTS KNearestNeighbour: public CvKNearest |
||||
{ |
||||
public: |
||||
KNearestNeighbour(); |
||||
~KNearestNeighbour(); |
||||
|
||||
bool train(const Mat& trainData, Mat& labels, Mat& sampleIdx = Mat().setTo(Scalar::all(0)), |
||||
bool isRegression = false, int max_k = 32, bool updateBase = false); |
||||
|
||||
void clear(); |
||||
|
||||
void find_nearest(const oclMat& samples, int k, oclMat& lables); |
||||
|
||||
private: |
||||
/* hidden */ |
||||
}; |
||||
|
||||
ocl::KNearestNeighbour::train |
||||
--------------------------------- |
||||
Trains the model. |
||||
|
||||
.. ocv:function:: bool ocl::KNearestNeighbour::train(const Mat& trainData, Mat& labels, Mat& sampleIdx = Mat().setTo(Scalar::all(0)), bool isRegression = false, int max_k = 32, bool updateBase = false) |
||||
|
||||
:param isRegression: Type of the problem: ``true`` for regression and ``false`` for classification. |
||||
|
||||
:param maxK: Number of maximum neighbors that may be passed to the method :ocv:func:`CvKNearest::find_nearest`. |
||||
|
||||
:param updateBase: Specifies whether the model is trained from scratch (``update_base=false``), or it is updated using the new training data (``update_base=true``). In the latter case, the parameter ``maxK`` must not be larger than the original value. |
||||
|
||||
The method trains the K-Nearest model. It follows the conventions of the generic :ocv:func:`CvStatModel::train` approach with the following limitations: |
||||
|
||||
* Only ``CV_ROW_SAMPLE`` data layout is supported. |
||||
* Input variables are all ordered. |
||||
* Output variables can be either categorical ( ``is_regression=false`` ) or ordered ( ``is_regression=true`` ). |
||||
* Variable subsets (``var_idx``) and missing measurements are not supported. |
||||
|
||||
ocl::KNearestNeighbour::find_nearest |
||||
---------------------------------------- |
||||
Finds the neighbors and predicts responses for input vectors. |
||||
|
||||
.. ocv:function:: void ocl::KNearestNeighbour::find_nearest(const oclMat& samples, int k, oclMat& lables ) |
||||
|
||||
:param samples: Input samples stored by rows. It is a single-precision floating-point matrix of :math:`number\_of\_samples \times number\_of\_features` size. |
||||
|
||||
:param k: Number of used nearest neighbors. It must satisfy constraint: :math:`k \le` :ocv:func:`CvKNearest::get_max_k`. |
||||
|
||||
:param labels: Vector with results of prediction (regression or classification) for each input sample. It is a single-precision floating-point vector with ``number_of_samples`` elements. |
||||
|
||||
ocl::kmeans |
||||
--------------- |
||||
Finds centers of clusters and groups input samples around the clusters. |
||||
|
||||
.. ocv:function:: double ocl::kmeans(const oclMat &src, int K, oclMat &bestLabels, TermCriteria criteria, int attemps, int flags, oclMat ¢ers) |
||||
|
||||
:param src: Floating-point matrix of input samples, one row per sample. |
||||
|
||||
:param K: Number of clusters to split the set by. |
||||
|
||||
:param bestLabels: Input/output integer array that stores the cluster indices for every sample. |
||||
|
||||
:param criteria: The algorithm termination criteria, that is, the maximum number of iterations and/or the desired accuracy. The accuracy is specified as ``criteria.epsilon``. As soon as each of the cluster centers moves by less than ``criteria.epsilon`` on some iteration, the algorithm stops. |
||||
|
||||
:param attempts: Flag to specify the number of times the algorithm is executed using different initial labellings. The algorithm returns the labels that yield the best compactness (see the last function parameter). |
||||
|
||||
:param flags: Flag that can take the following values: |
||||
|
||||
* **KMEANS_RANDOM_CENTERS** Select random initial centers in each attempt. |
||||
|
||||
* **KMEANS_PP_CENTERS** Use ``kmeans++`` center initialization by Arthur and Vassilvitskii [Arthur2007]. |
||||
|
||||
* **KMEANS_USE_INITIAL_LABELS** During the first (and possibly the only) attempt, use the user-supplied labels instead of computing them from the initial centers. For the second and further attempts, use the random or semi-random centers. Use one of ``KMEANS_*_CENTERS`` flag to specify the exact method. |
||||
|
||||
:param centers: Output matrix of the cluster centers, one row per each cluster center. |
@ -0,0 +1,570 @@ |
||||
Video Analysis |
||||
============================= |
||||
|
||||
.. highlight:: cpp |
||||
|
||||
ocl::GoodFeaturesToTrackDetector_OCL |
||||
---------------------------------------- |
||||
.. ocv:class:: ocl::GoodFeaturesToTrackDetector_OCL |
||||
|
||||
Class used for strong corners detection on an image. :: |
||||
|
||||
class GoodFeaturesToTrackDetector_OCL |
||||
{ |
||||
public: |
||||
explicit GoodFeaturesToTrackDetector_OCL(int maxCorners = 1000, double qualityLevel = 0.01, double minDistance = 0.0, |
||||
int blockSize = 3, bool useHarrisDetector = false, double harrisK = 0.04); |
||||
|
||||
//! return 1 rows matrix with CV_32FC2 type |
||||
void operator ()(const oclMat& image, oclMat& corners, const oclMat& mask = oclMat()); |
||||
//! download points of type Point2f to a vector. the vector's content will be erased |
||||
void downloadPoints(const oclMat &points, std::vector<Point2f> &points_v); |
||||
|
||||
int maxCorners; |
||||
double qualityLevel; |
||||
double minDistance; |
||||
|
||||
int blockSize; |
||||
bool useHarrisDetector; |
||||
double harrisK; |
||||
void releaseMemory() |
||||
{ |
||||
Dx_.release(); |
||||
Dy_.release(); |
||||
eig_.release(); |
||||
minMaxbuf_.release(); |
||||
tmpCorners_.release(); |
||||
} |
||||
}; |
||||
|
||||
The class finds the most prominent corners in the image. |
||||
|
||||
.. seealso:: :ocv:func:`goodFeaturesToTrack()` |
||||
|
||||
ocl::GoodFeaturesToTrackDetector_OCL::GoodFeaturesToTrackDetector_OCL |
||||
------------------------------------------------------------------------- |
||||
Constructor. |
||||
|
||||
.. ocv:function:: ocl::GoodFeaturesToTrackDetector_OCL::GoodFeaturesToTrackDetector_OCL(int maxCorners = 1000, double qualityLevel = 0.01, double minDistance = 0.0, int blockSize = 3, bool useHarrisDetector = false, double harrisK = 0.04) |
||||
|
||||
:param maxCorners: Maximum number of corners to return. If there are more corners than are found, the strongest of them is returned. |
||||
|
||||
:param qualityLevel: Parameter characterizing the minimal accepted quality of image corners. The parameter value is multiplied by the best corner quality measure, which is the minimal eigenvalue (see :ocv:func:`ocl::cornerMinEigenVal` ) or the Harris function response (see :ocv:func:`ocl::cornerHarris` ). The corners with the quality measure less than the product are rejected. For example, if the best corner has the quality measure = 1500, and the ``qualityLevel=0.01`` , then all the corners with the quality measure less than 15 are rejected. |
||||
|
||||
:param minDistance: Minimum possible Euclidean distance between the returned corners. |
||||
|
||||
:param blockSize: Size of an average block for computing a derivative covariation matrix over each pixel neighborhood. See :ocv:func:`cornerEigenValsAndVecs` . |
||||
|
||||
:param useHarrisDetector: Parameter indicating whether to use a Harris detector (see :ocv:func:`ocl::cornerHarris`) or :ocv:func:`ocl::cornerMinEigenVal`. |
||||
|
||||
:param harrisK: Free parameter of the Harris detector. |
||||
|
||||
ocl::GoodFeaturesToTrackDetector_OCL::operator () |
||||
------------------------------------------------------- |
||||
Finds the most prominent corners in the image. |
||||
|
||||
.. ocv:function:: void ocl::GoodFeaturesToTrackDetector_OCL::operator ()(const oclMat& image, oclMat& corners, const oclMat& mask = oclMat()) |
||||
|
||||
:param image: Input 8-bit, single-channel image. |
||||
|
||||
:param corners: Output vector of detected corners (it will be one row matrix with CV_32FC2 type). |
||||
|
||||
:param mask: Optional region of interest. If the image is not empty (it needs to have the type ``CV_8UC1`` and the same size as ``image`` ), it specifies the region in which the corners are detected. |
||||
|
||||
.. seealso:: :ocv:func:`goodFeaturesToTrack` |
||||
|
||||
ocl::GoodFeaturesToTrackDetector_OCL::releaseMemory |
||||
-------------------------------------------------------- |
||||
Releases inner buffers memory. |
||||
|
||||
.. ocv:function:: void ocl::GoodFeaturesToTrackDetector_OCL::releaseMemory() |
||||
|
||||
ocl::FarnebackOpticalFlow |
||||
------------------------------- |
||||
.. ocv:class:: ocl::FarnebackOpticalFlow |
||||
|
||||
Class computing a dense optical flow using the Gunnar Farneback's algorithm. :: |
||||
|
||||
class CV_EXPORTS FarnebackOpticalFlow |
||||
{ |
||||
public: |
||||
FarnebackOpticalFlow(); |
||||
|
||||
int numLevels; |
||||
double pyrScale; |
||||
bool fastPyramids; |
||||
int winSize; |
||||
int numIters; |
||||
int polyN; |
||||
double polySigma; |
||||
int flags; |
||||
|
||||
void operator ()(const oclMat &frame0, const oclMat &frame1, oclMat &flowx, oclMat &flowy); |
||||
|
||||
void releaseMemory(); |
||||
|
||||
private: |
||||
/* hidden */ |
||||
}; |
||||
|
||||
ocl::FarnebackOpticalFlow::operator () |
||||
------------------------------------------ |
||||
Computes a dense optical flow using the Gunnar Farneback's algorithm. |
||||
|
||||
.. ocv:function:: void ocl::FarnebackOpticalFlow::operator ()(const oclMat &frame0, const oclMat &frame1, oclMat &flowx, oclMat &flowy) |
||||
|
||||
:param frame0: First 8-bit gray-scale input image |
||||
:param frame1: Second 8-bit gray-scale input image |
||||
:param flowx: Flow horizontal component |
||||
:param flowy: Flow vertical component |
||||
:param s: Stream |
||||
|
||||
.. seealso:: :ocv:func:`calcOpticalFlowFarneback` |
||||
|
||||
ocl::FarnebackOpticalFlow::releaseMemory |
||||
-------------------------------------------- |
||||
Releases unused auxiliary memory buffers. |
||||
|
||||
.. ocv:function:: void ocl::FarnebackOpticalFlow::releaseMemory() |
||||
|
||||
|
||||
ocl::PyrLKOpticalFlow |
||||
------------------------- |
||||
.. ocv:class:: ocl::PyrLKOpticalFlow |
||||
|
||||
Class used for calculating an optical flow. :: |
||||
|
||||
class PyrLKOpticalFlow |
||||
{ |
||||
public: |
||||
PyrLKOpticalFlow(); |
||||
|
||||
void sparse(const oclMat& prevImg, const oclMat& nextImg, const oclMat& prevPts, oclMat& nextPts, |
||||
oclMat& status, oclMat* err = 0); |
||||
|
||||
void dense(const oclMat& prevImg, const oclMat& nextImg, oclMat& u, oclMat& v, oclMat* err = 0); |
||||
|
||||
Size winSize; |
||||
int maxLevel; |
||||
int iters; |
||||
double derivLambda; |
||||
bool useInitialFlow; |
||||
float minEigThreshold; |
||||
bool getMinEigenVals; |
||||
|
||||
void releaseMemory(); |
||||
|
||||
private: |
||||
/* hidden */ |
||||
}; |
||||
|
||||
The class can calculate an optical flow for a sparse feature set or dense optical flow using the iterative Lucas-Kanade method with pyramids. |
||||
|
||||
.. seealso:: :ocv:func:`calcOpticalFlowPyrLK` |
||||
|
||||
ocl::PyrLKOpticalFlow::sparse |
||||
--------------------------------- |
||||
Calculate an optical flow for a sparse feature set. |
||||
|
||||
.. ocv:function:: void ocl::PyrLKOpticalFlow::sparse(const oclMat& prevImg, const oclMat& nextImg, const oclMat& prevPts, oclMat& nextPts, oclMat& status, oclMat* err = 0) |
||||
|
||||
:param prevImg: First 8-bit input image (supports both grayscale and color images). |
||||
|
||||
:param nextImg: Second input image of the same size and the same type as ``prevImg`` . |
||||
|
||||
:param prevPts: Vector of 2D points for which the flow needs to be found. It must be one row matrix with CV_32FC2 type. |
||||
|
||||
:param nextPts: Output vector of 2D points (with single-precision floating-point coordinates) containing the calculated new positions of input features in the second image. When ``useInitialFlow`` is true, the vector must have the same size as in the input. |
||||
|
||||
:param status: Output status vector (CV_8UC1 type). Each element of the vector is set to 1 if the flow for the corresponding features has been found. Otherwise, it is set to 0. |
||||
|
||||
:param err: Output vector (CV_32FC1 type) that contains the difference between patches around the original and moved points or min eigen value if ``getMinEigenVals`` is checked. It can be NULL, if not needed. |
||||
|
||||
.. seealso:: :ocv:func:`calcOpticalFlowPyrLK` |
||||
|
||||
|
||||
ocl::PyrLKOpticalFlow::dense |
||||
--------------------------------- |
||||
Calculate dense optical flow. |
||||
|
||||
.. ocv:function:: void ocl::PyrLKOpticalFlow::dense(const oclMat& prevImg, const oclMat& nextImg, oclMat& u, oclMat& v, oclMat* err = 0) |
||||
|
||||
:param prevImg: First 8-bit grayscale input image. |
||||
|
||||
:param nextImg: Second input image of the same size and the same type as ``prevImg`` . |
||||
|
||||
:param u: Horizontal component of the optical flow of the same size as input images, 32-bit floating-point, single-channel |
||||
|
||||
:param v: Vertical component of the optical flow of the same size as input images, 32-bit floating-point, single-channel |
||||
|
||||
:param err: Output vector (CV_32FC1 type) that contains the difference between patches around the original and moved points or min eigen value if ``getMinEigenVals`` is checked. It can be NULL, if not needed. |
||||
|
||||
|
||||
ocl::PyrLKOpticalFlow::releaseMemory |
||||
---------------------------------------- |
||||
Releases inner buffers memory. |
||||
|
||||
.. ocv:function:: void ocl::PyrLKOpticalFlow::releaseMemory() |
||||
|
||||
ocl::interpolateFrames |
||||
-------------------------- |
||||
Interpolates frames (images) using provided optical flow (displacement field). |
||||
|
||||
.. ocv:function:: void ocl::interpolateFrames(const oclMat& frame0, const oclMat& frame1, const oclMat& fu, const oclMat& fv, const oclMat& bu, const oclMat& bv, float pos, oclMat& newFrame, oclMat& buf) |
||||
|
||||
:param frame0: First frame (32-bit floating point images, single channel). |
||||
|
||||
:param frame1: Second frame. Must have the same type and size as ``frame0`` . |
||||
|
||||
:param fu: Forward horizontal displacement. |
||||
|
||||
:param fv: Forward vertical displacement. |
||||
|
||||
:param bu: Backward horizontal displacement. |
||||
|
||||
:param bv: Backward vertical displacement. |
||||
|
||||
:param pos: New frame position. |
||||
|
||||
:param newFrame: Output image. |
||||
|
||||
:param buf: Temporary buffer, will have width x 6*height size, CV_32FC1 type and contain 6 oclMat: occlusion masks for first frame, occlusion masks for second, interpolated forward horizontal flow, interpolated forward vertical flow, interpolated backward horizontal flow, interpolated backward vertical flow. |
||||
|
||||
:param stream: Stream for the asynchronous version. |
||||
|
||||
ocl::KalmanFilter |
||||
-------------------- |
||||
.. ocv:class:: ocl::KalmanFilter |
||||
|
||||
Kalman filter class. :: |
||||
|
||||
class CV_EXPORTS KalmanFilter |
||||
{ |
||||
public: |
||||
KalmanFilter(); |
||||
//! the full constructor taking the dimensionality of the state, of the measurement and of the control vector |
||||
KalmanFilter(int dynamParams, int measureParams, int controlParams=0, int type=CV_32F); |
||||
//! re-initializes Kalman filter. The previous content is destroyed. |
||||
void init(int dynamParams, int measureParams, int controlParams=0, int type=CV_32F); |
||||
|
||||
const oclMat& predict(const oclMat& control=oclMat()); |
||||
const oclMat& correct(const oclMat& measurement); |
||||
|
||||
oclMat statePre; //!< predicted state (x'(k)): x(k)=A*x(k-1)+B*u(k) |
||||
oclMat statePost; //!< corrected state (x(k)): x(k)=x'(k)+K(k)*(z(k)-H*x'(k)) |
||||
oclMat transitionMatrix; //!< state transition matrix (A) |
||||
oclMat controlMatrix; //!< control matrix (B) (not used if there is no control) |
||||
oclMat measurementMatrix; //!< measurement matrix (H) |
||||
oclMat processNoiseCov; //!< process noise covariance matrix (Q) |
||||
oclMat measurementNoiseCov;//!< measurement noise covariance matrix (R) |
||||
oclMat errorCovPre; //!< priori error estimate covariance matrix (P'(k)): P'(k)=A*P(k-1)*At + Q)*/ |
||||
oclMat gain; //!< Kalman gain matrix (K(k)): K(k)=P'(k)*Ht*inv(H*P'(k)*Ht+R) |
||||
oclMat errorCovPost; //!< posteriori error estimate covariance matrix (P(k)): P(k)=(I-K(k)*H)*P'(k) |
||||
private: |
||||
/* hidden */ |
||||
}; |
||||
|
||||
ocl::KalmanFilter::KalmanFilter |
||||
---------------------------------- |
||||
The constructors. |
||||
|
||||
.. ocv:function:: ocl::KalmanFilter::KalmanFilter() |
||||
|
||||
.. ocv:function:: ocl::KalmanFilter::KalmanFilter(int dynamParams, int measureParams, int controlParams=0, int type=CV_32F) |
||||
|
||||
The full constructor. |
||||
|
||||
:param dynamParams: Dimensionality of the state. |
||||
|
||||
:param measureParams: Dimensionality of the measurement. |
||||
|
||||
:param controlParams: Dimensionality of the control vector. |
||||
|
||||
:param type: Type of the created matrices that should be ``CV_32F`` or ``CV_64F``. |
||||
|
||||
|
||||
ocl::KalmanFilter::init |
||||
--------------------------- |
||||
Re-initializes Kalman filter. The previous content is destroyed. |
||||
|
||||
.. ocv:function:: void ocl::KalmanFilter::init(int dynamParams, int measureParams, int controlParams=0, int type=CV_32F) |
||||
|
||||
:param dynamParams: Dimensionalityensionality of the state. |
||||
|
||||
:param measureParams: Dimensionality of the measurement. |
||||
|
||||
:param controlParams: Dimensionality of the control vector. |
||||
|
||||
:param type: Type of the created matrices that should be ``CV_32F`` or ``CV_64F``. |
||||
|
||||
|
||||
ocl::KalmanFilter::predict |
||||
------------------------------ |
||||
Computes a predicted state. |
||||
|
||||
.. ocv:function:: const oclMat& ocl::KalmanFilter::predict(const oclMat& control=oclMat()) |
||||
|
||||
:param control: The optional input control |
||||
|
||||
|
||||
ocl::KalmanFilter::correct |
||||
----------------------------- |
||||
Updates the predicted state from the measurement. |
||||
|
||||
.. ocv:function:: const oclMat& ocl::KalmanFilter::correct(const oclMat& measurement) |
||||
|
||||
:param measurement: The measured system parameters |
||||
|
||||
|
||||
ocl::BackgroundSubtractor |
||||
---------------------------- |
||||
.. ocv:class:: ocl::BackgroundSubtractor |
||||
|
||||
Base class for background/foreground segmentation. :: |
||||
|
||||
class CV_EXPORTS BackgroundSubtractor |
||||
{ |
||||
public: |
||||
//! the virtual destructor |
||||
virtual ~BackgroundSubtractor(); |
||||
//! the update operator that takes the next video frame and returns the current foreground mask as 8-bit binary image. |
||||
virtual void operator()(const oclMat& image, oclMat& fgmask, float learningRate); |
||||
|
||||
//! computes a background image |
||||
virtual void getBackgroundImage(oclMat& backgroundImage) const = 0; |
||||
}; |
||||
|
||||
|
||||
The class is only used to define the common interface for the whole family of background/foreground segmentation algorithms. |
||||
|
||||
|
||||
ocl::BackgroundSubtractor::operator() |
||||
----------------------------------------- |
||||
Computes a foreground mask. |
||||
|
||||
.. ocv:function:: void ocl::BackgroundSubtractor::operator()(const oclMat& image, oclMat& fgmask, float learningRate) |
||||
|
||||
:param image: Next video frame. |
||||
|
||||
:param fgmask: The output foreground mask as an 8-bit binary image. |
||||
|
||||
|
||||
ocl::BackgroundSubtractor::getBackgroundImage |
||||
------------------------------------------------- |
||||
Computes a background image. |
||||
|
||||
.. ocv:function:: void ocl::BackgroundSubtractor::getBackgroundImage(oclMat& backgroundImage) const |
||||
|
||||
:param backgroundImage: The output background image. |
||||
|
||||
.. note:: Sometimes the background image can be very blurry, as it contain the average background statistics. |
||||
|
||||
ocl::MOG |
||||
------------ |
||||
.. ocv:class:: ocl::MOG |
||||
|
||||
Gaussian Mixture-based Backbround/Foreground Segmentation Algorithm. :: |
||||
|
||||
class CV_EXPORTS MOG: public cv::ocl::BackgroundSubtractor |
||||
{ |
||||
public: |
||||
//! the default constructor |
||||
MOG(int nmixtures = -1); |
||||
|
||||
//! re-initiaization method |
||||
void initialize(Size frameSize, int frameType); |
||||
|
||||
//! the update operator |
||||
void operator()(const oclMat& frame, oclMat& fgmask, float learningRate = 0.f); |
||||
|
||||
//! computes a background image which are the mean of all background gaussians |
||||
void getBackgroundImage(oclMat& backgroundImage) const; |
||||
|
||||
//! releases all inner buffers |
||||
void release(); |
||||
|
||||
int history; |
||||
float varThreshold; |
||||
float backgroundRatio; |
||||
float noiseSigma; |
||||
|
||||
private: |
||||
/* hidden */ |
||||
}; |
||||
|
||||
The class discriminates between foreground and background pixels by building and maintaining a model of the background. Any pixel which does not fit this model is then deemed to be foreground. The class implements algorithm described in [MOG2001]_. |
||||
|
||||
.. seealso:: :ocv:class:`BackgroundSubtractorMOG` |
||||
|
||||
|
||||
ocl::MOG::MOG |
||||
--------------------- |
||||
The constructor. |
||||
|
||||
.. ocv:function:: ocl::MOG::MOG(int nmixtures = -1) |
||||
|
||||
:param nmixtures: Number of Gaussian mixtures. |
||||
|
||||
Default constructor sets all parameters to default values. |
||||
|
||||
|
||||
ocl::MOG::operator() |
||||
------------------------ |
||||
Updates the background model and returns the foreground mask. |
||||
|
||||
.. ocv:function:: void ocl::MOG::operator()(const oclMat& frame, oclMat& fgmask, float learningRate = 0.f) |
||||
|
||||
:param frame: Next video frame. |
||||
|
||||
:param fgmask: The output foreground mask as an 8-bit binary image. |
||||
|
||||
:param stream: Stream for the asynchronous version. |
||||
|
||||
|
||||
ocl::MOG::getBackgroundImage |
||||
-------------------------------- |
||||
Computes a background image. |
||||
|
||||
.. ocv:function:: void ocl::MOG::getBackgroundImage(oclMat& backgroundImage) const |
||||
|
||||
:param backgroundImage: The output background image. |
||||
|
||||
:param stream: Stream for the asynchronous version. |
||||
|
||||
|
||||
ocl::MOG::release |
||||
--------------------- |
||||
Releases all inner buffer's memory. |
||||
|
||||
.. ocv:function:: void ocl::MOG::release() |
||||
|
||||
|
||||
ocl::MOG2 |
||||
------------- |
||||
.. ocv:class:: ocl::MOG2 |
||||
|
||||
Gaussian Mixture-based Background/Foreground Segmentation Algorithm. :: |
||||
|
||||
class CV_EXPORTS MOG2: public cv::ocl::BackgroundSubtractor |
||||
{ |
||||
public: |
||||
//! the default constructor |
||||
MOG2(int nmixtures = -1); |
||||
|
||||
//! re-initiaization method |
||||
void initialize(Size frameSize, int frameType); |
||||
|
||||
//! the update operator |
||||
void operator()(const oclMat& frame, oclMat& fgmask, float learningRate = -1.0f); |
||||
|
||||
//! computes a background image which are the mean of all background gaussians |
||||
void getBackgroundImage(oclMat& backgroundImage) const; |
||||
|
||||
//! releases all inner buffers |
||||
void release(); |
||||
|
||||
int history; |
||||
|
||||
float varThreshold; |
||||
|
||||
float backgroundRatio; |
||||
|
||||
float varThresholdGen; |
||||
|
||||
float fVarInit; |
||||
float fVarMin; |
||||
float fVarMax; |
||||
|
||||
float fCT; |
||||
|
||||
bool bShadowDetection; |
||||
unsigned char nShadowDetection; |
||||
float fTau; |
||||
|
||||
private: |
||||
/* hidden */ |
||||
}; |
||||
|
||||
The class discriminates between foreground and background pixels by building and maintaining a model of the background. Any pixel which does not fit this model is then deemed to be foreground. The class implements algorithm described in [MOG2004]_. |
||||
|
||||
Here are important members of the class that control the algorithm, which you can set after constructing the class instance: |
||||
|
||||
.. ocv:member:: float backgroundRatio |
||||
|
||||
Threshold defining whether the component is significant enough to be included into the background model. ``cf=0.1 => TB=0.9`` is default. For ``alpha=0.001``, it means that the mode should exist for approximately 105 frames before it is considered foreground. |
||||
|
||||
.. ocv:member:: float varThreshold |
||||
|
||||
Threshold for the squared Mahalanobis distance that helps decide when a sample is close to the existing components (corresponds to ``Tg``). If it is not close to any component, a new component is generated. ``3 sigma => Tg=3*3=9`` is default. A smaller ``Tg`` value generates more components. A higher ``Tg`` value may result in a small number of components but they can grow too large. |
||||
|
||||
.. ocv:member:: float fVarInit |
||||
|
||||
Initial variance for the newly generated components. It affects the speed of adaptation. The parameter value is based on your estimate of the typical standard deviation from the images. OpenCV uses 15 as a reasonable value. |
||||
|
||||
.. ocv:member:: float fVarMin |
||||
|
||||
Parameter used to further control the variance. |
||||
|
||||
.. ocv:member:: float fVarMax |
||||
|
||||
Parameter used to further control the variance. |
||||
|
||||
.. ocv:member:: float fCT |
||||
|
||||
Complexity reduction parameter. This parameter defines the number of samples needed to accept to prove the component exists. ``CT=0.05`` is a default value for all the samples. By setting ``CT=0`` you get an algorithm very similar to the standard Stauffer&Grimson algorithm. |
||||
|
||||
.. ocv:member:: uchar nShadowDetection |
||||
|
||||
The value for marking shadow pixels in the output foreground mask. Default value is 127. |
||||
|
||||
.. ocv:member:: float fTau |
||||
|
||||
Shadow threshold. The shadow is detected if the pixel is a darker version of the background. ``Tau`` is a threshold defining how much darker the shadow can be. ``Tau= 0.5`` means that if a pixel is more than twice darker then it is not shadow. See [ShadowDetect2003]_. |
||||
|
||||
.. ocv:member:: bool bShadowDetection |
||||
|
||||
Parameter defining whether shadow detection should be enabled. |
||||
|
||||
.. seealso:: :ocv:class:`BackgroundSubtractorMOG2` |
||||
|
||||
|
||||
ocl::MOG2::MOG2 |
||||
----------------------- |
||||
The constructor. |
||||
|
||||
.. ocv:function:: ocl::MOG2::MOG2(int nmixtures = -1) |
||||
|
||||
:param nmixtures: Number of Gaussian mixtures. |
||||
|
||||
Default constructor sets all parameters to default values. |
||||
|
||||
|
||||
ocl::MOG2::operator() |
||||
------------------------- |
||||
Updates the background model and returns the foreground mask. |
||||
|
||||
.. ocv:function:: void ocl::MOG2::operator()( const oclMat& frame, oclMat& fgmask, float learningRate=-1.0f) |
||||
|
||||
:param frame: Next video frame. |
||||
|
||||
:param fgmask: The output foreground mask as an 8-bit binary image. |
||||
|
||||
:param stream: Stream for the asynchronous version. |
||||
|
||||
|
||||
ocl::MOG2::getBackgroundImage |
||||
--------------------------------- |
||||
Computes a background image. |
||||
|
||||
.. ocv:function:: void ocl::MOG2::getBackgroundImage(oclMat& backgroundImage) const |
||||
|
||||
:param backgroundImage: The output background image. |
||||
|
||||
:param stream: Stream for the asynchronous version. |
||||
|
||||
|
||||
ocl::MOG2::release |
||||
---------------------- |
||||
Releases all inner buffer's memory. |
||||
|
||||
.. ocv:function:: void ocl::MOG2::release() |
Loading…
Reference in new issue