Commit f0bd11ea authored by Guillaume Lazzara's avatar Guillaume Lazzara
Browse files

Fix and improve documentation in Scribo.

	* doc/Doxyfile.in: Cleanup doxygen output.

	* doc/groups.dox: Set groups.

	* scribo/binarization/global_threshold.hh,
	* scribo/binarization/internal/niblack_formula.hh,
	* scribo/binarization/internal/sauvola_formula.hh,
	* scribo/binarization/local_threshold.hh,
	* scribo/binarization/niblack.hh,
	* scribo/binarization/niblack_threshold.hh,
	* scribo/binarization/otsu.hh,
	* scribo/binarization/otsu_threshold.hh,
	* scribo/binarization/sauvola.hh,
	* scribo/binarization/sauvola_ms.hh,
	* scribo/binarization/sauvola_ms_split.hh,
	* scribo/binarization/sauvola_threshold.hh,
	* scribo/core/erase_objects.hh,
	* scribo/debug/alignment_decision_image.hh,
	* scribo/debug/bboxes_enlarged_image.hh,
	* scribo/debug/bboxes_image.hh,
	* scribo/debug/char_space_image.hh,
	* scribo/debug/decision_image.hh,
	* scribo/debug/highlight_text_area.hh,
	* scribo/debug/line_info_image.hh,
	* scribo/debug/linked_bboxes_image.hh,
	* scribo/debug/links_decision_image.hh,
	* scribo/debug/links_image.hh,
	* scribo/debug/logger.hh,
	* scribo/debug/looks_like_a_text_line_image.hh,
	* scribo/debug/mean_and_base_lines_image.hh,
	* scribo/debug/save_comp_diff.hh,
	* scribo/debug/save_label_image.hh,
	* scribo/debug/save_table_image.hh,
	* scribo/debug/text_areas_image.hh,
	* scribo/debug/text_color_image.hh,
	* scribo/draw/bounding_box_links.hh,
	* scribo/filter/images_in_paragraph.hh,
	* scribo/filter/line_links_x_height.hh,
	* scribo/filter/object_groups_mean_width.hh,
	* scribo/filter/object_groups_size_ratio.hh,
	* scribo/filter/object_groups_small.hh,
	* scribo/filter/object_groups_with_holes.hh,
	* scribo/filter/object_links_aligned.hh,
	* scribo/filter/object_links_bbox_h_ratio.hh,
	* scribo/filter/object_links_bbox_overlap.hh,
	* scribo/filter/object_links_bbox_ratio.hh,
	* scribo/filter/object_links_bbox_w_ratio.hh,
	* scribo/filter/object_links_bottom_aligned.hh,
	* scribo/filter/object_links_center_aligned.hh,
	* scribo/filter/object_links_left_aligned.hh,
	* scribo/filter/object_links_non_aligned_simple.hh,
	* scribo/filter/object_links_right_aligned.hh,
	* scribo/filter/object_links_top_aligned.hh,
	* scribo/filter/objects_h_thick.hh,
	* scribo/filter/objects_h_thin.hh,
	* scribo/filter/objects_large.hh,
	* scribo/filter/objects_on_border.hh,
	* scribo/filter/objects_size_ratio.hh,
	* scribo/filter/objects_small.hh,
	* scribo/filter/objects_thick.hh,
	* scribo/filter/objects_thin.hh,
	* scribo/filter/objects_v_thick.hh,
	* scribo/filter/objects_v_thin.hh,
	* scribo/filter/objects_with_holes.hh,
	* scribo/filter/paragraphs_bbox_overlap.hh,
	* scribo/filter/paragraphs_in_borders.hh,
	* scribo/filter/paragraphs_in_image.hh,
	* scribo/filter/separators_in_borders.hh,
	* scribo/filter/separators_in_element.hh,
	* scribo/filter/separators_in_paragraph.hh,
	* scribo/filter/separators_vert_in_borders.hh,
	* scribo/fun/v2b/objects_on_border_filter.hh,
	* scribo/postprocessing/images_to_drop_capital.hh,
	* scribo/preprocessing/denoise.hh,
	* scribo/preprocessing/denoise_bg.hh,
	* scribo/preprocessing/denoise_fg.hh,
	* scribo/preprocessing/deskew_crop.hh,
	* scribo/preprocessing/homogeneous_contrast.hh,
	* scribo/preprocessing/split_bg_fg.hh,
	* scribo/primitive/extract/alignments.hh,
	* scribo/primitive/extract/cells.hh,
	* scribo/primitive/extract/components.hh,
	* scribo/primitive/extract/lines_h_single.hh,
	* scribo/primitive/extract/lines_h_thick_and_single.hh,
	* scribo/primitive/extract/lines_v_pattern.hh,
	* scribo/primitive/extract/lines_v_single.hh,
	* scribo/primitive/extract/lines_v_thick_and_single.hh,
	* scribo/primitive/group/from_double_link.hh,
	* scribo/primitive/identify.hh,
	* scribo/primitive/link/compute.hh,
	* scribo/primitive/link/with_single_left_link.hh,
	* scribo/primitive/link/with_single_left_link_dmax_ratio_aligned.hh,
	* scribo/primitive/link/with_single_right_link.hh,
	* scribo/primitive/link/with_single_right_link_bottom.hh,
	* scribo/primitive/link/with_single_right_link_dmax_ratio_aligned.hh,
	* scribo/primitive/link/with_single_right_link_top.hh,
	* scribo/table/align_lines_horizontaly.hh,
	* scribo/table/rebuild.hh,
	* scribo/text/extract_lines.hh,
	* scribo/text/extract_lines_wo_merge.hh,
	* scribo/text/recognition.hh,
	* scribo/toolchain/content_in_doc.hh,
	* scribo/toolchain/content_in_hdoc.hh,
	* scribo/toolchain/internal/content_in_doc_functor.hh,
	* scribo/toolchain/internal/content_in_hdoc_functor.hh,
	* scribo/toolchain/internal/text_in_doc_functor.hh,
	* scribo/toolchain/internal/text_in_doc_preprocess_functor.hh,
	* scribo/toolchain/internal/text_in_picture_functor.hh,
	* scribo/toolchain/internal/toolchain_functor.hh,
	* scribo/toolchain/nepomuk/text_extraction.hh,
	* scribo/toolchain/text_in_doc.hh,
	* scribo/toolchain/text_in_doc_preprocess.hh,
	* scribo/toolchain/text_in_picture.hh: Fix comments.
parent a3a8d02a
2012-02-01 Guillaume Lazzara <z@lrde.epita.fr>
Fix and improve documentation in Scribo.
* doc/Doxyfile.in: Cleanup doxygen output.
* doc/groups.dox: Set groups.
* scribo/binarization/global_threshold.hh,
* scribo/binarization/internal/niblack_formula.hh,
* scribo/binarization/internal/sauvola_formula.hh,
* scribo/binarization/local_threshold.hh,
* scribo/binarization/niblack.hh,
* scribo/binarization/niblack_threshold.hh,
* scribo/binarization/otsu.hh,
* scribo/binarization/otsu_threshold.hh,
* scribo/binarization/sauvola.hh,
* scribo/binarization/sauvola_ms.hh,
* scribo/binarization/sauvola_ms_split.hh,
* scribo/binarization/sauvola_threshold.hh,
* scribo/core/erase_objects.hh,
* scribo/debug/alignment_decision_image.hh,
* scribo/debug/bboxes_enlarged_image.hh,
* scribo/debug/bboxes_image.hh,
* scribo/debug/char_space_image.hh,
* scribo/debug/decision_image.hh,
* scribo/debug/highlight_text_area.hh,
* scribo/debug/line_info_image.hh,
* scribo/debug/linked_bboxes_image.hh,
* scribo/debug/links_decision_image.hh,
* scribo/debug/links_image.hh,
* scribo/debug/logger.hh,
* scribo/debug/looks_like_a_text_line_image.hh,
* scribo/debug/mean_and_base_lines_image.hh,
* scribo/debug/save_comp_diff.hh,
* scribo/debug/save_label_image.hh,
* scribo/debug/save_table_image.hh,
* scribo/debug/text_areas_image.hh,
* scribo/debug/text_color_image.hh,
* scribo/draw/bounding_box_links.hh,
* scribo/filter/images_in_paragraph.hh,
* scribo/filter/line_links_x_height.hh,
* scribo/filter/object_groups_mean_width.hh,
* scribo/filter/object_groups_size_ratio.hh,
* scribo/filter/object_groups_small.hh,
* scribo/filter/object_groups_with_holes.hh,
* scribo/filter/object_links_aligned.hh,
* scribo/filter/object_links_bbox_h_ratio.hh,
* scribo/filter/object_links_bbox_overlap.hh,
* scribo/filter/object_links_bbox_ratio.hh,
* scribo/filter/object_links_bbox_w_ratio.hh,
* scribo/filter/object_links_bottom_aligned.hh,
* scribo/filter/object_links_center_aligned.hh,
* scribo/filter/object_links_left_aligned.hh,
* scribo/filter/object_links_non_aligned_simple.hh,
* scribo/filter/object_links_right_aligned.hh,
* scribo/filter/object_links_top_aligned.hh,
* scribo/filter/objects_h_thick.hh,
* scribo/filter/objects_h_thin.hh,
* scribo/filter/objects_large.hh,
* scribo/filter/objects_on_border.hh,
* scribo/filter/objects_size_ratio.hh,
* scribo/filter/objects_small.hh,
* scribo/filter/objects_thick.hh,
* scribo/filter/objects_thin.hh,
* scribo/filter/objects_v_thick.hh,
* scribo/filter/objects_v_thin.hh,
* scribo/filter/objects_with_holes.hh,
* scribo/filter/paragraphs_bbox_overlap.hh,
* scribo/filter/paragraphs_in_borders.hh,
* scribo/filter/paragraphs_in_image.hh,
* scribo/filter/separators_in_borders.hh,
* scribo/filter/separators_in_element.hh,
* scribo/filter/separators_in_paragraph.hh,
* scribo/filter/separators_vert_in_borders.hh,
* scribo/fun/v2b/objects_on_border_filter.hh,
* scribo/postprocessing/images_to_drop_capital.hh,
* scribo/preprocessing/denoise.hh,
* scribo/preprocessing/denoise_bg.hh,
* scribo/preprocessing/denoise_fg.hh,
* scribo/preprocessing/deskew_crop.hh,
* scribo/preprocessing/homogeneous_contrast.hh,
* scribo/preprocessing/split_bg_fg.hh,
* scribo/primitive/extract/alignments.hh,
* scribo/primitive/extract/cells.hh,
* scribo/primitive/extract/components.hh,
* scribo/primitive/extract/lines_h_single.hh,
* scribo/primitive/extract/lines_h_thick_and_single.hh,
* scribo/primitive/extract/lines_v_pattern.hh,
* scribo/primitive/extract/lines_v_single.hh,
* scribo/primitive/extract/lines_v_thick_and_single.hh,
* scribo/primitive/group/from_double_link.hh,
* scribo/primitive/identify.hh,
* scribo/primitive/link/compute.hh,
* scribo/primitive/link/with_single_left_link.hh,
* scribo/primitive/link/with_single_left_link_dmax_ratio_aligned.hh,
* scribo/primitive/link/with_single_right_link.hh,
* scribo/primitive/link/with_single_right_link_bottom.hh,
* scribo/primitive/link/with_single_right_link_dmax_ratio_aligned.hh,
* scribo/primitive/link/with_single_right_link_top.hh,
* scribo/table/align_lines_horizontaly.hh,
* scribo/table/rebuild.hh,
* scribo/text/extract_lines.hh,
* scribo/text/extract_lines_wo_merge.hh,
* scribo/text/recognition.hh,
* scribo/toolchain/content_in_doc.hh,
* scribo/toolchain/content_in_hdoc.hh,
* scribo/toolchain/internal/content_in_doc_functor.hh,
* scribo/toolchain/internal/content_in_hdoc_functor.hh,
* scribo/toolchain/internal/text_in_doc_functor.hh,
* scribo/toolchain/internal/text_in_doc_preprocess_functor.hh,
* scribo/toolchain/internal/text_in_picture_functor.hh,
* scribo/toolchain/internal/toolchain_functor.hh,
* scribo/toolchain/nepomuk/text_extraction.hh,
* scribo/toolchain/text_in_doc.hh,
* scribo/toolchain/text_in_doc_preprocess.hh,
* scribo/toolchain/text_in_picture.hh: Fix comments.
2012-02-01 Guillaume Lazzara <z@lrde.epita.fr>
Fix scribo doc (un)installation.
......
......@@ -49,6 +49,7 @@ DISTRIBUTE_GROUP_DOC = NO
SUBGROUPING = YES
INLINE_GROUPED_CLASSES = NO
SORT_GROUP_NAMES = YES
TYPEDEF_HIDES_STRUCT = YES
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
......@@ -85,7 +86,7 @@ FILE_VERSION_FILTER =
#---------------------------------------------------------------------------
QUIET = YES
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_UNDOCUMENTED = NO
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = NO
WARN_FORMAT = "$file:$line: $text"
......@@ -107,7 +108,7 @@ EXCLUDE = @top_srcdir@/scribo/demo \
@top_srcdir@/scribo/tests/unit_test
EXCLUDE_SYMLINKS = YES
EXCLUDE_PATTERNS = *spe.hh
EXCLUDE_SYMBOLS = *::internal* *_ mln::trait::*
EXCLUDE_SYMBOLS = *_ mln::trait::*
EXAMPLE_PATH = @top_srcdir@/scribo/doc/examples \
@top_srcdir@/scribo/doc/outputs \
@top_srcdir@/scribo/doc/examples/split \
......@@ -260,7 +261,6 @@ PREDEFINED = "for_all(x)=for(x.start(); x.is_valid(); x.next())" \
"mln_trait_op_plus(L, R)=typename mln::trait::op::plus< L , R >::ret" \
"mln_trait_op_times(L, R)=typename mln::trait::op::times< L , R >::ret" \
"mln_trait_op_uminus(T)=typename mln::trait::op::uminus< T >::ret" \
"mln_ch_value(I, V)=typename mln::trait::ch_value< I, V >::ret" \
"mlc_unqualif_(T)=mln::metal::unqualif<T>::ret" \
"mln_piter_(T)=T::piter" \
"mln_fwd_piter_(T)=T::fwd_piter" \
......@@ -295,8 +295,8 @@ PREDEFINED = "for_all(x)=for(x.start(); x.is_valid(); x.next())" \
"mln_trait_op_div_(L, R)=mln::trait::op::div< L , R >::ret" \
"mln_trait_op_mod_(L, R)=mln::trait::op::mod< L , R >::ret" \
"mln_trait_op_uminus_(T)=mln::trait::op::uminus< T >::ret" \
"mln_ch_value_(I, V)=typename mln::trait::ch_value< I, V >::ret" \
"mln_ch_value(I, V)_=mln::trait::ch_value< I, V >::ret" \
"mln_ch_value_(I, V)=mln::trait::ch_value< I, V >::ret" \
"mln_ch_value(I, V)=typename mln::trait::ch_value< I, V >::ret" \
"mln_morpher_lvalue(I)=typename internal::morpher_lvalue_<I>::ret" \
"mln_concrete(I)=typename mln::trait::concrete< I >::ret" \
"mln_concrete_ch_value(I, V)=typename mln::trait::ch_value< typename mln::trait::concrete< I >::ret, V >::ret" \
......
......@@ -4,7 +4,6 @@
*
*/
/*! \defgroup grproutine Routines
*
* \brief All routines/algorithms provided in Scribo.
......@@ -12,8 +11,144 @@
*/
/*! \defgroup grpalgobin Binarization
*
* \brief Binarization algorithms.
*
* \ingroup grproutine
*/
/*! \defgroup grpalgobinsauvola Sauvola
*
* \brief Sauvola's Binarization implementations.
*
* \ingroup grpalgobin
*/
/*! \defgroup grpalgobinniblack Niblack
*
* \brief Niblack's Binarization implementations.
*
* \ingroup grpalgobin
*/
/*! \defgroup grpalgobinotsu Otsu
*
* \brief Otsu's Binarization implementations.
*
* \ingroup grpalgobin
*/
/*! \defgroup grpalgodebug Debug
*
* \brief Debug routines.
*
* \ingroup grproutine
*/
/*! \defgroup grpalgofilter Element Filtering
*
* \brief Element filtering routines.
*
* \ingroup grproutine
*/
/*! \defgroup grpalgofiltercomp Components
*
* \brief Component filtering routines.
*
* \ingroup grpalgofilter
*/
/*! \defgroup grpalgofiltercomplink Component Links
*
* \brief Component links filtering routines.
*
* \ingroup grpalgofilter
*/
/*! \defgroup grpalgofiltercompgroup Component Groups
*
* \brief Component groups filtering routines.
*
* \ingroup grpalgofilter
*/
/*! \defgroup grpalgofilterlinelink Line Links
*
* \brief Line links filtering routines.
*
* \ingroup grpalgofilter
*/
/*! \defgroup grpalgofilterpar Paragraphs
*
* \brief Paragraphs filtering routines.
*
* \ingroup grpalgofilter
*/
/*! \defgroup grpalgofilterelt Elements
*
* \brief Elements filtering routines.
*
* \ingroup grpalgofilter
*/
/*! \defgroup grptoolchain Toolchains
*
* \brief Full toolchains performing content analysis and extraction.
*
* \ingroup grproutine
*/
/*! \defgroup grptoolchainpic Pictures
*
* \brief Full toolchains performing content analysis and extraction
* in pictures.
*
* \ingroup grptoolchain
*/
/*! \defgroup grptoolchaindoc Documents
*
* \brief Full toolchains performing content analysis and extraction
* in document images.
*
* \ingroup grptoolchain
*/
/*! \defgroup grptoolchainpicpreproc Preprocessing
*
* \brief Classical preprocessing toolchains for pictures.
*
* \ingroup grptoolchainpic
*/
/*! \defgroup grptoolchaindocpreproc Preprocessing
*
* \brief Classical preprocessing toolchains for document image.
*
* \ingroup grptoolchaindoc
*/
/*! \defgroup grptoolchainpicproc Processing
*
* \brief Classical processing toolchains for pictures.
*
* \ingroup grptoolchainpic
*/
/*! \defgroup grptoolchaindocproc Processing
*
* \brief Classical processing toolchains for document image.
*
* \ingroup grptoolchaindoc
*/
......@@ -55,8 +55,8 @@ namespace scribo
///
/// output(p) = input(p) >= threshold
///
/// \input[in] input A grayscale image.
/// \input[in] threshold A value.
/// \param[in] input A grayscale image.
/// \param[in] threshold A value.
///
/// \return A boolean image.
//
......
......@@ -56,7 +56,7 @@ namespace scribo
\param[in] m_x_y Mean value.
\param[in] s_x_y Standard deviation.
\param[in] k Control the threshold value in the local
\param[in] K Control the threshold value in the local
window. The higher, the lower the threshold
form the local mean m(x, y).
......@@ -66,7 +66,8 @@ namespace scribo
const double K) const;
/*!
\overload K = -0.2.
\overload
K is set to -0.2.
*/
double operator()(const double m_x_y, const double s_x_y) const;
......
......@@ -67,7 +67,7 @@ namespace scribo
\param[in] m_x_y Mean value.
\param[in] s_x_y Standard deviation.
\param[in] k Control the threshold value in the local
\param[in] K Controls the threshold value in the local
window. The higher, the lower the threshold
form the local mean m(x, y).
\param[in] R Maximum value of the standard deviation (128
......@@ -79,7 +79,8 @@ namespace scribo
const double K, const double R) const;
/*!
\overload K = 0.34 and R = 128.
\overload
K is set to 0.34 and R to 128.
*/
double operator()(const double m_x_y, const double s_x_y) const;
......
......@@ -52,8 +52,8 @@ namespace scribo
///
/// \pre input.domain() == threshold.domain()
///
/// \input[in] input A grayscale image.
/// \input[in] threshold A grayscale image.
/// \param[in] input A grayscale image.
/// \param[in] threshold A grayscale image.
///
/// \return A boolean image.
//
......
......@@ -46,12 +46,13 @@ namespace scribo
/*! \brief Convert an image into a binary image.
\input[in] input An image.
\input[in] window_size The window size.
\input[in] K Sauvola's formulae constant.
\param[in] input An image.
\param[in] window_size The window size.
\param[in] K Niblack's formulae constant.
\return A binary image.
\ingroup grpalgobinniblack
*/
template <typename I>
mln_ch_value(I, bool)
......@@ -64,11 +65,12 @@ namespace scribo
Sauvola's formulae constant K is set to
SCRIBO_DEFAULT_NIBLACK_K.
\input[in] input An image.
\input[in] window_size The window size.
\param[in] input An image.
\param[in] window_size The window size.
\return A binary image.
\ingroup grpalgobinniblack
*/
template <typename I>
mln_ch_value(I, bool)
......@@ -77,6 +79,7 @@ namespace scribo
/// \overload
/// The window size is set to 11.
/// \ingroup grpalgobinniblack
//
template <typename I>
mln_ch_value(I, bool)
......
......@@ -51,14 +51,16 @@ namespace scribo
/*! \brief Compute an image of local threshold using Niblack algorithm.
\input[in] input A gray level image.
\input[in] window_size The window size.
\input[out] simple The sum of all intensities of \p input.
\input[out] squared The sum of all squared intensities of \p
\param[in] input A gray level image.
\param[in] window_size The window size.
\param[in] K Controls the threshold value in the local window.
\param[out] simple The sum of all intensities of \p input.
\param[out] squared The sum of all squared intensities of \p
input.
\return An image of local thresholds.
\ingroup grpalgobinniblack
*/
template <typename I, typename J>
mln_ch_value(I, value::int_u8)
......@@ -67,6 +69,8 @@ namespace scribo
/// \overload
/// K is set to 0.34
/// \ingroup grpalgobinniblack
//
template <typename I>
mln_ch_value(I, value::int_u8)
niblack_threshold(const Image<I>& input, unsigned window_size);
......@@ -74,6 +78,7 @@ namespace scribo
/// \overload
/// The window size is set to 11.
/// \ingroup grpalgobinniblack
//
template <typename I>
mln_ch_value(I, value::int_u8)
......
......@@ -48,6 +48,8 @@ namespace scribo
\return A binary image. True for foreground, False for
background.
\ingroup grpalgobinotsu
*/
template <typename I>
mln_ch_value(I,bool)
......
......@@ -50,6 +50,8 @@ namespace scribo
\param[in] input A gray-scale image.
\return A global threshold value.
\ingroup grpalgobinotsu
*/
template <typename I>
mln_value(I)
......
......@@ -46,12 +46,13 @@ namespace scribo
/*! \brief Convert an image into a binary image.
\input[in] input An image.
\input[in] window_size The window size.
\input[in] K Sauvola's formulae constant.
\param[in] input An image.
\param[in] window_size The window size.
\param[in] K Sauvola's formulae constant.
\return A binary image.
\ingroup grpalgobinsauvola
*/
template <typename I>
mln_ch_value(I, bool)
......@@ -61,22 +62,27 @@ namespace scribo
/*! \brief Convert an image into a binary image.
\overload
Sauvola's formulae constant K is set to 0.34.
\input[in] input An image.
\input[in] window_size The window size.
\param[in] input An image.
\param[in] window_size The window size.
\return A binary image.
\ingroup grpalgobinsauvola
*/
template <typename I>
mln_ch_value(I, bool)
sauvola(const Image<I>& input, unsigned window_size);
/// \overload
/// The window size is set to 11.
//
/*! \overload
The window size is set to 11.
\ingroup grpalgobinsauvola
*/
template <typename I>
mln_ch_value(I, bool)
sauvola(const Image<I>& input);
......
......@@ -100,11 +100,13 @@ namespace scribo
\param[out] integral_sum_sum_2 Integral image of sum and squared
sum.
Sauvola's formula parameter K is set to 0.34.
\p w_1 and \p lambda_min_1 are expressed according to the image
at scale 0, i.e. the original size.
Sauvola's formula parameter K is set to 0.34. \p w_1 and \p
lambda_min_1 are expressed according to the image at scale 0,
i.e. the original size.
\return A Boolean image.
\ingroup grpalgobinsauvola
*/
template <typename I>
mln_ch_value(I,bool)
......@@ -115,6 +117,8 @@ namespace scribo
/// \overload
/// The integral image is not returned.
/// K is set to 0.34.
///
/// \ingroup grpalgobinsauvola
//
template <typename I>
mln_ch_value(I,bool)
......
// Copyright (C) 2010, 2011, 2012 EPITA Research and Development
// Copyright (C) 2010, 2011, 2012, 2013 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of Olena.
......@@ -67,6 +67,8 @@ namespace scribo
original size.
\return A Boolean image.
\ingroup grpalgobinsauvola
*/
template <typename I>
mln_ch_value(I, bool)
......@@ -84,6 +86,9 @@ namespace scribo
/// \overload
/// k2, k3 and k4 are set to 0.34.
///
/// \ingroup grpalgobinsauvola
//
template <typename I>
mln_ch_value(I, bool)
sauvola_ms_split(const Image<I>& input_1_, unsigned w_1,
......
// Copyright (C) 2009, 2010, 2011 EPITA Research and Development
// Copyright (C) 2009, 2010, 2011, 2013 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of Olena.
......@@ -52,22 +52,22 @@ namespace scribo
/*! \brief Compute an image of local threshold using Sauvola algorithm.
\input[in] input A gray level image.
\input[in] window_size The window size.
\input[out] simple The sum of all intensities of \p input.
\input[out] squared The sum of all squared intensities of \p
input.
\param[in] input A gray level image.
\param[in] window_size The window size.
\param[in] K Controls the threshold value in the local window.
\return An image of local thresholds.
\ingroup grpalgobinsauvola
*/
template <typename I, typename J>
mln_ch_value(I, value::int_u8)
sauvola_threshold(const Image<I>& input, unsigned window_size,
double K);
double K);
/// \overload
/// K is set to 0.34
/// \ingroup grpalgobinsauvola
template <typename I>
mln_ch_value(I, value::int_u8)
sauvola_threshold(const Image<I>& input, unsigned window_size);
......@@ -75,6 +75,7 @@ namespace scribo
/// \overload
/// The window size is set to 11.
/// \ingroup grpalgobinsauvola
//
template <typename I>
mln_ch_value(I, value::int_u8)
......
// Copyright (C) 2009, 2010 EPITA Research and Development Laboratory
// (LRDE)
// Copyright (C) 2009, 2010, 2011 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of Olena.
//
......@@ -47,7 +47,7 @@ namespace scribo
/// Remove labeled components from a binary image.
///
/// \param[in,out] input_ A binary image.
/// \param[in,out] input A binary image.
/// \param[in] comps A set of components to be erased.
///
//
......