"tools/python/vscode:/vscode.git/clone" did not exist on "225e1c5ab0880447a6cd739ffd30c72f9b9b1ef4"
Commit 068fcd9a authored by Davis King's avatar Davis King
Browse files

Updated requires clause for the spatial filtering methods to note that you

can't use the add_to or use_abs options with color images.
parent f30c1c34
...@@ -124,9 +124,7 @@ namespace dlib ...@@ -124,9 +124,7 @@ namespace dlib
const in_image_type& in_img, const in_image_type& in_img,
out_image_type& out_img, out_image_type& out_img,
const matrix_exp<EXP>& filter, const matrix_exp<EXP>& filter,
T scale, T scale
bool use_abs = false,
bool add_to = false
) )
{ {
COMPILE_TIME_ASSERT( pixel_traits<typename in_image_type::type>::has_alpha == false ); COMPILE_TIME_ASSERT( pixel_traits<typename in_image_type::type>::has_alpha == false );
......
...@@ -36,6 +36,9 @@ namespace dlib ...@@ -36,6 +36,9 @@ namespace dlib
- scale != 0 - scale != 0
- filter.nr() % 2 == 1 (i.e. must be odd) - filter.nr() % 2 == 1 (i.e. must be odd)
- filter.nc() % 2 == 1 (i.e. must be odd) - filter.nc() % 2 == 1 (i.e. must be odd)
- if (pixel_traits<typename in_image_type::type>::grayscale == false) then
- use_abs == false && add_to == false
(i.e. You can only use the use_abs and add_to options with grayscale images)
ensures ensures
- Applies the given spatial filter to in_img and stores the result in out_img (i.e. - Applies the given spatial filter to in_img and stores the result in out_img (i.e.
cross-correlates in_img with filter). Also divides each resulting pixel by scale. cross-correlates in_img with filter). Also divides each resulting pixel by scale.
...@@ -88,6 +91,9 @@ namespace dlib ...@@ -88,6 +91,9 @@ namespace dlib
- is_vector(col_filter) == true - is_vector(col_filter) == true
- row_filter.size() % 2 == 1 (i.e. must be odd) - row_filter.size() % 2 == 1 (i.e. must be odd)
- col_filter.size() % 2 == 1 (i.e. must be odd) - col_filter.size() % 2 == 1 (i.e. must be odd)
- if (pixel_traits<typename in_image_type::type>::grayscale == false) then
- use_abs == false && add_to == false
(i.e. You can only use the use_abs and add_to options with grayscale images)
ensures ensures
- Applies the given separable spatial filter to in_img and stores the result in out_img. - Applies the given separable spatial filter to in_img and stores the result in out_img.
Also divides each resulting pixel by scale. Calling this function has the same Also divides each resulting pixel by scale. Calling this function has the same
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment