From cd407b53a86ba0b8af7903cf5892da6e3e1a7329 Mon Sep 17 00:00:00 2001 From: Ilya Lysenkov Date: Thu, 12 Apr 2012 09:01:03 +0000 Subject: [PATCH] Corrected doc of Mat::adjustROI() (issue #1245) --- modules/core/doc/basic_structures.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/core/doc/basic_structures.rst b/modules/core/doc/basic_structures.rst index 6f0077c..262b2dc 100644 --- a/modules/core/doc/basic_structures.rst +++ b/modules/core/doc/basic_structures.rst @@ -1380,7 +1380,7 @@ The method is complimentary to In this example, the matrix size is increased by 4 elements in each direction. The matrix is shifted by 2 elements to the left and 2 elements up, which brings in all the necessary pixels for the filtering with the 5x5 kernel. -It is your responsibility to make sure ``adjustROI`` does not cross the parent matrix boundary. If it does, the function signals an error. +``adjustROI`` forces the adjusted ROI to be inside of the parent matrix that is boundaries of the adjusted ROI are constrained by boundaries of the parent matrix. For example, if the submatrix ``A`` is located in the first row of a parent matrix and you called ``A.adjustROI(2, 2, 2, 2)`` then ``A`` will not be increased in the upward direction. The function is used internally by the OpenCV filtering functions, like :ocv:func:`filter2D` , morphological operations, and so on. -- 2.7.4