Commit 1b88ca28 authored by Guillaume Lazzara's avatar Guillaume Lazzara
Browse files

Add algorithms to documentation groups.

	* scribo/primitive/extract/horizontal_separators.hh,
	* scribo/primitive/extract/lines_discontinued.hh,
	* scribo/primitive/extract/lines_h_discontinued.hh,
	* scribo/primitive/extract/lines_h_pattern.hh,
	* scribo/primitive/extract/lines_h_single.hh,
	* scribo/primitive/extract/lines_h_thick.hh,
	* scribo/primitive/extract/lines_h_thick_and_single.hh,
	* scribo/primitive/extract/lines_h_thick_and_thin.hh,
	* scribo/primitive/extract/lines_pattern.hh,
	* scribo/primitive/extract/lines_thick.hh,
	* scribo/primitive/extract/lines_v_discontinued.hh,
	* scribo/primitive/extract/lines_v_pattern.hh,
	* scribo/primitive/extract/lines_v_single.hh,
	* scribo/primitive/extract/lines_v_thick.hh,
	* scribo/primitive/extract/lines_v_thick_and_single.hh,
	* scribo/primitive/extract/separators.hh,
	* scribo/primitive/extract/separators_nonvisible.hh,
	* scribo/primitive/extract/vertical_separators.hh,
	* scribo/text/extract_lines.hh,
	* scribo/text/extract_lines_with_features.hh,
	* scribo/text/extract_lines_wo_merge.hh,
	* scribo/text/extract_paragraphs.hh,
	* scribo/text/extract_paragraphs_hdoc.hh,
	* scribo/text/link_lines.hh,
	* scribo/text/merging.hh,
	* scribo/text/merging_hdoc.hh,
	* scribo/text/recognition.hh: Here.
parent 53f3077a
2012-02-27 Guillaume Lazzara <z@lrde.epita.fr>
Add algorithms to documentation groups.
* scribo/primitive/extract/horizontal_separators.hh,
* scribo/primitive/extract/lines_discontinued.hh,
* scribo/primitive/extract/lines_h_discontinued.hh,
* scribo/primitive/extract/lines_h_pattern.hh,
* scribo/primitive/extract/lines_h_single.hh,
* scribo/primitive/extract/lines_h_thick.hh,
* scribo/primitive/extract/lines_h_thick_and_single.hh,
* scribo/primitive/extract/lines_h_thick_and_thin.hh,
* scribo/primitive/extract/lines_pattern.hh,
* scribo/primitive/extract/lines_thick.hh,
* scribo/primitive/extract/lines_v_discontinued.hh,
* scribo/primitive/extract/lines_v_pattern.hh,
* scribo/primitive/extract/lines_v_single.hh,
* scribo/primitive/extract/lines_v_thick.hh,
* scribo/primitive/extract/lines_v_thick_and_single.hh,
* scribo/primitive/extract/separators.hh,
* scribo/primitive/extract/separators_nonvisible.hh,
* scribo/primitive/extract/vertical_separators.hh,
* scribo/text/extract_lines.hh,
* scribo/text/extract_lines_with_features.hh,
* scribo/text/extract_lines_wo_merge.hh,
* scribo/text/extract_paragraphs.hh,
* scribo/text/extract_paragraphs_hdoc.hh,
* scribo/text/link_lines.hh,
* scribo/text/merging.hh,
* scribo/text/merging_hdoc.hh,
* scribo/text/recognition.hh: Here.
2012-02-27 Guillaume Lazzara <z@lrde.epita.fr>
* doc/scribo/binarization/sauvola.dox: Fix documentation.
......
// Copyright (C) 2010, 2011 EPITA Research and Development Laboratory
// (LRDE)
// Copyright (C) 2010, 2011, 2012 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of Olena.
//
......@@ -57,6 +57,8 @@ namespace scribo
* \return A binary image were separators are set to 'True'.
*
* \sa primitive::remove::separators
*
* \ingroup extractprimitiveseps
*/
template <typename I>
mln_concrete(I)
......
// Copyright (C) 2009, 2010, 2013 EPITA Research and Development
// Copyright (C) 2009, 2010, 2012, 2013 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of Olena.
......@@ -70,6 +70,8 @@ namespace scribo
* \return An image in which lines are labeled.
*
* \pre win.length() > 2 * (rank_k + 1)
*
* \ingroup extractprimitiveseps
*/
template <typename I, typename N, typename V, typename W>
component_set<mln_ch_value(I,V)>
......
// Copyright (C) 2009, 2010 EPITA Research and Development Laboratory
// (LRDE)
// Copyright (C) 2009, 2010, 2012 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of Olena.
//
......@@ -61,6 +61,8 @@ namespace scribo
*
* \result An image in which lines are labeled with a value different
* from 0.
*
* \ingroup extractprimitiveseps
*/
template <typename I, typename N, typename V>
component_set<mln_ch_value(I,V)>
......
// Copyright (C) 2009, 2010, 2011, 2013 EPITA Research and Development
// Laboratory (LRDE)
// Copyright (C) 2009, 2010, 2011, 2012, 2013 EPITA Research and
// Development Laboratory (LRDE)
//
// This file is part of Olena.
//
......@@ -78,6 +78,7 @@ namespace scribo
Using a delta of 0 is equivalent to the use of a c2_row
neighborhood.
\ingroup extractprimitiveseps
*/
template <typename I>
mln_concrete(I)
......
// Copyright (C) 2009, 2010, 2011 EPITA Research and Development
// Copyright (C) 2009, 2010, 2011, 2012 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of Olena.
......@@ -66,6 +66,8 @@ namespace scribo
*
* \return An image in which only horizontal single lines are
* labeled.
*
* \ingroup extractprimitiveseps
*/
template <typename I, typename N, typename V>
component_set<mln_ch_value(I,V)>
......@@ -88,6 +90,8 @@ namespace scribo
*
* \return An image in which only horizontal single lines are
* labeled.
*
* \ingroup extractprimitiveseps
*/
template <typename L>
component_set<L>
......
// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE)
// Copyright (C) 2009, 2012 EPITA Research and Development Laboratory
// (LRDE)
//
// This file is part of Olena.
//
......@@ -59,6 +60,8 @@ namespace scribo
* \param[in] line_length The minimum line length.
*
* \return An image in which lines are labeled.
*
* \ingroup extractprimitiveseps
*/
template <typename I, typename N, typename V, typename W>
component_set<mln_ch_value(I,V)>
......
// Copyright (C) 2009, 2010, 2011 EPITA Research and Development
// Copyright (C) 2009, 2010, 2011, 2012 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of Olena.
......@@ -73,6 +73,8 @@ namespace scribo
* object as a single line.
*
* \return An image in which lines are labeled.
*
* \ingroup extractprimitiveseps
*/
template <typename I, typename N, typename V>
component_set<mln_ch_value(I,V)>
......
// Copyright (C) 2011 EPITA Research and Development Laboratory (LRDE)
// Copyright (C) 2011, 2012 EPITA Research and Development Laboratory
// (LRDE)
//
// This file is part of Olena.
//
......@@ -77,6 +78,9 @@ namespace scribo
{
using namespace mln;
/*! \brief Extract both thick and thin horizontal lines.
* \ingroup extractprimitiveseps
*/
template <typename I>
mln_concrete(I)
lines_h_thick_and_thin(const Image<I>& binary_image,
......
// Copyright (C) 2009, 2010 EPITA Research and Development Laboratory
// (LRDE)
// Copyright (C) 2009, 2010, 2012 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of Olena.
//
......@@ -58,16 +58,17 @@ namespace scribo
using namespace mln;
/// Extract lines with a specific pattern
///
/// \param[in] input_ A binary image.
/// \param[in] length The minimum line length.
/// \param[in] dir The direction of the lines.
/// \param[in] win_ A window corresponding to the line pattern.
///
/// \return A image with lines of direction \p dir.
///
//
/*! \brief Extract lines with a specific pattern
\param[in] input_ A binary image.
\param[in] length The minimum line length.
\param[in] dir The direction of the lines.
\param[in] win_ A window corresponding to the line pattern.
\return A image with lines of direction \p dir.
\ingroup extractprimitiveseps
*/
template <typename I, typename W>
mln_concrete(I)
lines_pattern(const Image<I>& input_, unsigned length,
......
// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE)
// Copyright (C) 2009, 2012 EPITA Research and Development Laboratory
// (LRDE)
//
// This file is part of Olena.
//
......@@ -52,8 +53,7 @@ namespace scribo
using namespace mln;
/// Extract thick lines in a binary image.
/*!
/*! \brief Extract thick lines in a binary image.
* Only non discontinued lines are correctly extracted with this routine.
*
* \param[in] input_ A binary image.
......@@ -63,6 +63,8 @@ namespace scribo
* \param[in] win_ Window used to extract the lines
*
* \return An image in which lines are labeled.
*
* \ingroup extractprimitiveseps
*/
template <typename I, typename N, typename V, typename W>
component_set<mln_ch_value(I,V)>
......
// Copyright (C) 2009, 2010 EPITA Research and Development Laboratory
// (LRDE)
// Copyright (C) 2009, 2010, 2012 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of Olena.
//
......@@ -48,8 +48,8 @@ namespace scribo
{
/// Extract vertical discontinued lines.
/*!
/*! \brief Extract vertical discontinued lines.
*
* \param[in] input A binary image.
* \param[in] nbh A neighborhood used to label lines.
* \param[in,out] nlines The number of lines found.
......@@ -59,6 +59,8 @@ namespace scribo
*
* \result An image in which lines are labeled with a value different
* from 0.
*
* \ingroup extractprimitiveseps
*/
template <typename I, typename N, typename V>
component_set<mln_ch_value(I,V)>
......
// Copyright (C) 2009, 2010, 2011, 2013 EPITA Research and Development
// Laboratory (LRDE)
// Copyright (C) 2009, 2010, 2011, 2012, 2013 EPITA Research and
// Development Laboratory (LRDE)
//
// This file is part of Olena.
//
......@@ -56,15 +56,17 @@ namespace scribo
using namespace mln;
/// \brief Extract vertical lines matching a specific pattern.
///
/// \param[in] input A binary image.
/// \param[in] length The minimum line length.
/// \param[in] delta space between the first background pixels
/// and the line pixels (usually 2 or 3).
///
/// \result An image of vertical lines.
//
/*! \brief Extract vertical lines matching a specific pattern.
\param[in] input A binary image.
\param[in] length The minimum line length.
\param[in] delta space between the first background pixels
and the line pixels (usually 2 or 3).
\result An image of vertical lines.
\ingroup extractprimitiveseps
*/
template <typename I>
mln_concrete(I)
lines_v_pattern(const Image<I>& input, unsigned length, unsigned delta);
......
// Copyright (C) 2009, 2010, 2011 EPITA Research and Development
// Copyright (C) 2009, 2010, 2011, 2012 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of Olena.
......@@ -65,6 +65,8 @@ namespace scribo
*
* \return An image in which only vertical single lines are
* labeled.
*
* \ingroup extractprimitiveseps
*/
template <typename I, typename N, typename V>
component_set<mln_ch_value(I,V)>
......@@ -87,6 +89,8 @@ namespace scribo
*
* \return An image in which only vertical single lines are
* labeled.
*
*\ingroup extractprimitiveseps
*/
template <typename L>
component_set<L>
......
// Copyright (C) 2009, 2010 EPITA Research and Development Laboratory
// (LRDE)
// Copyright (C) 2009, 2010, 2012 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of Olena.
//
......@@ -48,8 +48,8 @@ namespace scribo
using namespace mln;
/// Extract thick lines in a binary image.
/*!
/*! \brief Extract thick lines in a binary image.
*
* Only non discontinued lines are correctly extracted with this routine.
*
* \param[in] input_ A binary image.
......@@ -59,6 +59,8 @@ namespace scribo
* \param[in] line_length The minimum line length.
*
* \return An image in which lines are labeled.
*
* \ingroup extractprimitiveseps
*/
template <typename I, typename N, typename V, typename W>
component_set<mln_ch_value(I,V)>
......
// Copyright (C) 2009, 2010, 2011 EPITA Research and Development
// Copyright (C) 2009, 2010, 2011, 2012 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of Olena.
......@@ -71,6 +71,8 @@ namespace scribo
* object as a single line.
*
* \return An image in which lines are labeled.
*
* \ingroup extractprimitiveseps
*/
template <typename I, typename N, typename V>
component_set<mln_ch_value(I,V)>
......
// Copyright (C) 2010, 2011 EPITA Research and Development Laboratory
// (LRDE)
// Copyright (C) 2010, 2011, 2012 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of Olena.
//
......@@ -49,8 +49,8 @@ namespace scribo
using namespace mln;
/// \brief Extract vertical and horizontal separators.
/*!
/*! \brief Extract vertical and horizontal separators.
*
*
* \param[in] input A binary image.
* \param[in] line_length The minimum line length.
......@@ -58,6 +58,8 @@ namespace scribo
* \return A binary image were separators are set to 'True'.
*
* \sa primitive::remove::separators
*
* \ingroup extractprimitiveseps
*/
template <typename I>
mln_concrete(I)
......
// Copyright (C) 2010, 2011 EPITA Research and Development Laboratory
// (LRDE)
// Copyright (C) 2010, 2011, 2012 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of Olena.
//
......@@ -92,9 +92,11 @@ namespace scribo
using namespace scribo::debug;
/// \brief Find non visible separators. Based on components
/// alignments.
//
/*! \brief Find non visible separators. Based on components
alignments.
\ingroup extractprimitiveseps
*/
template <typename I>
mln_concrete(I)
separators_nonvisible(const Image<I>& in_);
......
// Copyright (C) 2010 EPITA Research and Development Laboratory (LRDE)
// Copyright (C) 2010, 2012 EPITA Research and Development Laboratory
// (LRDE)
//
// This file is part of Olena.
//
......@@ -47,8 +48,8 @@ namespace scribo
using namespace mln;
/// \brief Extract vertical separators.
/*!
/*! \brief Extract vertical separators.
*
*
* \param[in] input A binary image.
* \param[in] line_length The minimum line length.
......@@ -56,6 +57,8 @@ namespace scribo
* \return A binary image were separators are set to 'True'.
*
* \sa primitive::remove::separators
*
* \ingroup extractprimitiveseps
*/
template <typename I>
mln_concrete(I)
......
// Copyright (C) 2009, 2010, 2011 EPITA Research and Development
// Copyright (C) 2009, 2010, 2011, 2012 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of Olena.
......@@ -63,25 +63,31 @@ namespace scribo
using namespace mln;
/*! \brief Extract lines of text in a binary image.
**
** \param[in] input A binary image.
** \param[in] nbh A neighborhood used for labeling.
** \param[in] separators A binary image with separator information.
**
** \return A set of lines.
*/
*
* \param[in] input A binary image.
* \param[in] nbh A neighborhood used for labeling.
* \param[in] separators A binary image with separator information.
*
* \return A set of lines.
*
* \ingroup grptext
*/
template <typename I, typename N>
line_set<mln_ch_value(I,scribo::def::lbl_type)>
extract_lines(const Image<I>& input, const Neighborhood<N>& nbh,
const mln_ch_value(I,bool)& separators);
/// \overload
/*! \overload
\ingroup grptext
*/
template <typename I, typename N>
line_set<mln_ch_value(I,scribo::def::lbl_type)>
extract_lines(const Image<I>& input, const Neighborhood<N>& nbh);
/// \overload
/*! \overload
\ingroup grptext
*/
template <typename L>
line_set<mln_ch_value(L,scribo::def::lbl_type)>
extract_lines(const component_set<L>& input);
......
Supports Markdown
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