November 2011 - Olena-patches

olena-2.0-20-g0949555 Add more content in general documentation.
by Guillaume Lazzara 29 Nov '11

29 Nov '11

* doc/Makefile.am: New dependencies. * doc/license_commercial.dox, * doc/mainpage.dox, * doc/modules_list.dox: More content. * doc/get_sources.dox, * doc/online_resources.dox: New. --- ChangeLog | 13 +++++++++++++ doc/Makefile.am | 2 ++ doc/get_sources.dox | 37 +++++++++++++++++++++++++++++++++++++ doc/license_commercial.dox | 5 +++-- doc/mainpage.dox | 4 ++-- doc/modules_list.dox | 2 +- doc/online_resources.dox | 34 ++++++++++++++++++++++++++++++++++ 7 files changed, 92 insertions(+), 5 deletions(-) create mode 100644 doc/get_sources.dox create mode 100644 doc/online_resources.dox diff --git a/ChangeLog b/ChangeLog index b385e9c..679dfa0 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,16 @@ +2011-10-28 Guillaume Lazzara <z(a)lrde.epita.fr> + + Add more content in general documentation. + + * doc/Makefile.am: New dependencies. + + * doc/license_commercial.dox, + * doc/mainpage.dox, + * doc/modules_list.dox: More content. + + * doc/get_sources.dox, + * doc/online_resources.dox: New. + 2011-09-16 Roland Levillain <roland(a)lrde.epita.fr> * configure.ac, NEWS: Version 2.0a. diff --git a/doc/Makefile.am b/doc/Makefile.am index 410316b..81c34b1 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -64,6 +64,8 @@ REFMAN_deps = $(srcdir)/footer.html \ $(srcdir)/bibliography.dox \ $(srcdir)/license.dox \ $(srcdir)/license_commercial.dox \ + $(srcdir)/online_resources.dox \ + $(srcdir)/get_sources.dox \ contributors.html \ lrde_olena.html diff --git a/doc/get_sources.dox b/doc/get_sources.dox new file mode 100644 index 0000000..23f1446 --- /dev/null +++ b/doc/get_sources.dox @@ -0,0 +1,37 @@ +/*! \page getsources Get the Sources + +If you are interested in developping for Olena, you are definitely +interested in using the development version from our Git Repository. + +To successfuly compile and use the development version, you will need the following additional tools: + +\li Git 1.5 or higher +\li Autoconf 2.61 or higher +\li Automake 1.10 or higher +\li Libtool 1.5.22 or higher +\li Doxygen 1.5.6 or higher +\li ImageMagick 6.3.7 or higher +\li HeVeA 1.10 +\li LaTeX2HTML (or at minimum, its html.sty style file) + +The Git repository is located at git://git.lrde.epita.fr/olena. + +For those who are not used to Git, here are the required commands to get and build a fresh source tree: +\verbatim + git clone git://git.lrde.epita.fr/olena + cd olena + ./bootstrap + mkdir _build + cd _build + ../configure + make +\endverbatim + +The last command may take some time. + +If you want to install Olena, type thereafter (as root): +\verbatim + make install +\endverbatim + +*/ \ No newline at end of file diff --git a/doc/license_commercial.dox b/doc/license_commercial.dox index 0ece2b5..af2f094 100644 --- a/doc/license_commercial.dox +++ b/doc/license_commercial.dox @@ -1,6 +1,7 @@ /*! \page commercial "Commercial Use" - < Under construction > + Even though Olena is released under GPL v2, using Olena in a close + source commercial products may be possible. - Please contact us : olena(a)lrde.epita.fr + If you are interested, please contact us at olena(a)lrde.epita.fr */ \ No newline at end of file diff --git a/doc/mainpage.dox b/doc/mainpage.dox index ea15c32..9ebda3b 100644 --- a/doc/mainpage.dox +++ b/doc/mainpage.dox @@ -38,8 +38,8 @@ <tr> <td> \li Report Bugs and Make Suggestions - \li Get the Sources - \li Online Resources + \li \ref getsources + \li \ref onlineres </td> <td> \li \ref gplv2 "GNU GPL" diff --git a/doc/modules_list.dox b/doc/modules_list.dox index e3f2b8d..6b872ef 100644 --- a/doc/modules_list.dox +++ b/doc/modules_list.dox @@ -1,4 +1,4 @@ -/** \page moduleslist List of available modules +/** \page moduleslist List of Available Modules As a platform, Olena is divided in several modules: diff --git a/doc/online_resources.dox b/doc/online_resources.dox new file mode 100644 index 0000000..32cd18d --- /dev/null +++ b/doc/online_resources.dox @@ -0,0 +1,34 @@ +/*! \page onlineres Online Resources + +\section Trac + +In order to keep traces of bugs and feature requests, we provide a +Trac at <a +href="https://trac.lrde.org/olena">https://trac.lrde.org/olena</a>. + +\section Gitweb + +Source code is freely browseable through a web interface at this +address : <a +href="http://git.lrde.epita.fr/?p=olena.git">http://git.lrde.epita.fr/?p=olena.git</a> + +It is also a way to keep an eye on current develop. + +\section BuildBot + +During the development process, we need to be sure that changes don't +break the whole code. To do so, we have a buildfarm running several +architectures and compilers. A monitoring interface is available here +: <a href="https://buildfarm.lrde.org/buildfarm/oln/">https://buildfarm.lrde.org/buildfarm/oln/</a> + +\section Mailing-list + +A general mailing-list is available and open for any questions related +to Olena. You can : + +\li <a href="https://www.lrde.epita.fr/mailman/listinfo/olena">subscribe to our mailing-list</a> +\li <a href="https://www.lrde.epita.fr/pipermail/olena/">fetch the archives of the list</a> +\li send any questions to: <a href="mailto::olena@lrde.epita.fr">olena(a)lrde.epita.fr</a> + + +*/ \ No newline at end of file -- 1.7.2.5

1 0

olena-2.0-19-g899e2b8 Update general documentation.
by Guillaume Lazzara 29 Nov '11

29 Nov '11

--- doc/Doxyfile.in | 3 ++- doc/Makefile.am | 2 ++ doc/license.dox | 15 +++++++++++++++ doc/license_commercial.dox | 6 ++++++ doc/mainpage.dox | 4 ++-- 5 files changed, 27 insertions(+), 3 deletions(-) create mode 100644 doc/license.dox create mode 100644 doc/license_commercial.dox diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 8474dc6..b53bbe8 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -100,7 +100,8 @@ EXCLUDE_SYMLINKS = YES EXCLUDE_PATTERNS = *spe.hh EXCLUDE_SYMBOLS = *::internal* *_ mln::trait::* EXAMPLE_PATH = @top_srcdir@/doc/ \ - @builddir@ + @builddir@ \ + @top_srcdir@ EXAMPLE_PATTERNS = *.cc \ *.cc.raw \ *.txt diff --git a/doc/Makefile.am b/doc/Makefile.am index 1bf95d5..410316b 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -62,6 +62,8 @@ REFMAN_deps = $(srcdir)/footer.html \ $(srcdir)/olena.bib \ $(srcdir)/contributors.dox \ $(srcdir)/bibliography.dox \ + $(srcdir)/license.dox \ + $(srcdir)/license_commercial.dox \ contributors.html \ lrde_olena.html diff --git a/doc/license.dox b/doc/license.dox new file mode 100644 index 0000000..eb9a8e4 --- /dev/null +++ b/doc/license.dox @@ -0,0 +1,15 @@ +/*! \page gplv2 "GNU General Public License (GPL)" + +Olena and its modules are Copyright (C) 2011 EPITA Research and +Development Laboratory (LRDE). + Olena and its modules are released under GNU GPL v2. + + +\section gplv2sec "The GNU General Public License (Version 2)" + +Reference : <a href="http://www.gnu.org/licenses/gpl.html">GNU General +Public License</a> + +\verbinclude COPYING + +*/ \ No newline at end of file diff --git a/doc/license_commercial.dox b/doc/license_commercial.dox new file mode 100644 index 0000000..0ece2b5 --- /dev/null +++ b/doc/license_commercial.dox @@ -0,0 +1,6 @@ +/*! \page commercial "Commercial Use" + + < Under construction > + + Please contact us : olena(a)lrde.epita.fr +*/ \ No newline at end of file diff --git a/doc/mainpage.dox b/doc/mainpage.dox index 8f49ca3..ea15c32 100644 --- a/doc/mainpage.dox +++ b/doc/mainpage.dox @@ -42,8 +42,8 @@ \li Online Resources </td> <td> - \li GNU GPL - \li Commercial Use + \li \ref gplv2 "GNU GPL" + \li \ref commercial "Commercial Use" </td> <td> </td> </tr> -- 1.7.2.5

1 0

olena-2.0-18-gef717c9 doc/Doxyfile.in: Do not warn about undocumented code.
by Guillaume Lazzara 29 Nov '11

29 Nov '11

--- doc/Doxyfile.in | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 86377ef..8474dc6 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -83,7 +83,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" -- 1.7.2.5

1 0

olena-2.0-17-g20ec3f3 Fix and improve documentation in Scribo.
by Guillaume Lazzara 29 Nov '11

29 Nov '11

--- scribo/doc/Doxyfile.in | 10 +- scribo/doc/groups.dox | 137 +++++++++++++++++++- scribo/scribo/binarization/global_threshold.hh | 4 +- .../binarization/internal/niblack_formula.hh | 5 +- .../binarization/internal/sauvola_formula.hh | 5 +- scribo/scribo/binarization/local_threshold.hh | 8 +- scribo/scribo/binarization/niblack.hh | 13 +- scribo/scribo/binarization/niblack_threshold.hh | 15 ++- scribo/scribo/binarization/otsu.hh | 2 + scribo/scribo/binarization/otsu_threshold.hh | 2 + scribo/scribo/binarization/sauvola.hh | 22 ++- scribo/scribo/binarization/sauvola_ms.hh | 12 +- scribo/scribo/binarization/sauvola_ms_split.hh | 7 +- scribo/scribo/binarization/sauvola_threshold.hh | 13 ++- scribo/scribo/core/erase_objects.hh | 6 +- scribo/scribo/debug/alignment_decision_image.hh | 13 +- scribo/scribo/debug/bboxes_enlarged_image.hh | 8 +- scribo/scribo/debug/bboxes_image.hh | 17 ++- scribo/scribo/debug/char_space_image.hh | 5 +- scribo/scribo/debug/decision_image.hh | 22 ++- scribo/scribo/debug/highlight_text_area.hh | 12 +- scribo/scribo/debug/line_info_image.hh | 4 + scribo/scribo/debug/linked_bboxes_image.hh | 29 +++- scribo/scribo/debug/links_decision_image.hh | 12 +- scribo/scribo/debug/links_image.hh | 7 +- scribo/scribo/debug/logger.hh | 9 +- .../scribo/debug/looks_like_a_text_line_image.hh | 12 ++- scribo/scribo/debug/mean_and_base_lines_image.hh | 8 +- scribo/scribo/debug/save_comp_diff.hh | 31 +++-- scribo/scribo/debug/save_label_image.hh | 9 +- scribo/scribo/debug/save_table_image.hh | 11 ++- scribo/scribo/debug/text_areas_image.hh | 4 +- scribo/scribo/debug/text_color_image.hh | 4 + scribo/scribo/draw/bounding_box_links.hh | 38 +++--- scribo/scribo/filter/images_in_paragraph.hh | 14 +-- scribo/scribo/filter/line_links_x_height.hh | 9 ++ scribo/scribo/filter/object_groups_mean_width.hh | 1 + scribo/scribo/filter/object_groups_size_ratio.hh | 16 +++ scribo/scribo/filter/object_groups_small.hh | 9 +- scribo/scribo/filter/object_groups_with_holes.hh | 13 ++- scribo/scribo/filter/object_links_aligned.hh | 6 +- scribo/scribo/filter/object_links_bbox_h_ratio.hh | 8 +- scribo/scribo/filter/object_links_bbox_overlap.hh | 6 +- scribo/scribo/filter/object_links_bbox_ratio.hh | 6 +- scribo/scribo/filter/object_links_bbox_w_ratio.hh | 9 +- .../scribo/filter/object_links_bottom_aligned.hh | 5 +- .../scribo/filter/object_links_center_aligned.hh | 11 +- scribo/scribo/filter/object_links_left_aligned.hh | 10 +- .../filter/object_links_non_aligned_simple.hh | 4 +- scribo/scribo/filter/object_links_right_aligned.hh | 5 +- scribo/scribo/filter/object_links_top_aligned.hh | 8 +- scribo/scribo/filter/objects_h_thick.hh | 4 + scribo/scribo/filter/objects_h_thin.hh | 4 + scribo/scribo/filter/objects_large.hh | 17 ++- scribo/scribo/filter/objects_on_border.hh | 8 +- scribo/scribo/filter/objects_size_ratio.hh | 6 +- scribo/scribo/filter/objects_small.hh | 17 ++- scribo/scribo/filter/objects_thick.hh | 14 ++- scribo/scribo/filter/objects_thin.hh | 15 ++- scribo/scribo/filter/objects_v_thick.hh | 12 ++- scribo/scribo/filter/objects_v_thin.hh | 21 ++- scribo/scribo/filter/objects_with_holes.hh | 26 ++++- scribo/scribo/filter/paragraphs_bbox_overlap.hh | 11 +- scribo/scribo/filter/paragraphs_in_borders.hh | 8 +- scribo/scribo/filter/paragraphs_in_image.hh | 11 +- scribo/scribo/filter/separators_in_borders.hh | 15 ++- scribo/scribo/filter/separators_in_element.hh | 12 +- scribo/scribo/filter/separators_in_paragraph.hh | 26 +++-- scribo/scribo/filter/separators_vert_in_borders.hh | 10 +- scribo/scribo/fun/v2b/objects_on_border_filter.hh | 5 +- .../postprocessing/images_to_drop_capital.hh | 10 +- scribo/scribo/preprocessing/denoise.hh | 11 +- scribo/scribo/preprocessing/denoise_bg.hh | 6 +- scribo/scribo/preprocessing/denoise_fg.hh | 9 +- scribo/scribo/preprocessing/deskew_crop.hh | 13 +- .../scribo/preprocessing/homogeneous_contrast.hh | 4 +- scribo/scribo/preprocessing/split_bg_fg.hh | 8 +- scribo/scribo/primitive/extract/alignments.hh | 14 ++- scribo/scribo/primitive/extract/cells.hh | 14 +- scribo/scribo/primitive/extract/components.hh | 8 +- scribo/scribo/primitive/extract/lines_h_single.hh | 22 ++-- .../primitive/extract/lines_h_thick_and_single.hh | 23 ++-- scribo/scribo/primitive/extract/lines_v_pattern.hh | 6 +- scribo/scribo/primitive/extract/lines_v_single.hh | 22 ++-- .../primitive/extract/lines_v_thick_and_single.hh | 20 ++-- scribo/scribo/primitive/group/from_double_link.hh | 1 - scribo/scribo/primitive/identify.hh | 2 +- scribo/scribo/primitive/link/compute.hh | 6 +- .../scribo/primitive/link/with_single_left_link.hh | 10 +- .../with_single_left_link_dmax_ratio_aligned.hh | 10 +- .../primitive/link/with_single_right_link.hh | 8 +- .../link/with_single_right_link_bottom.hh | 10 +- .../with_single_right_link_dmax_ratio_aligned.hh | 8 +- .../primitive/link/with_single_right_link_top.hh | 6 +- scribo/scribo/table/align_lines_horizontaly.hh | 9 +- scribo/scribo/table/rebuild.hh | 20 ++-- scribo/scribo/text/extract_lines.hh | 10 +- scribo/scribo/text/extract_lines_wo_merge.hh | 8 +- scribo/scribo/text/recognition.hh | 15 ++- scribo/scribo/toolchain/content_in_doc.hh | 23 +++- scribo/scribo/toolchain/content_in_hdoc.hh | 21 +++- .../toolchain/internal/content_in_doc_functor.hh | 6 + .../toolchain/internal/content_in_hdoc_functor.hh | 9 ++ .../toolchain/internal/text_in_doc_functor.hh | 6 + .../internal/text_in_doc_preprocess_functor.hh | 5 + .../toolchain/internal/text_in_picture_functor.hh | 4 +- .../scribo/toolchain/internal/toolchain_functor.hh | 5 + scribo/scribo/toolchain/nepomuk/text_extraction.hh | 6 +- scribo/scribo/toolchain/text_in_doc.hh | 22 +++- scribo/scribo/toolchain/text_in_doc_preprocess.hh | 14 ++ scribo/scribo/toolchain/text_in_picture.hh | 21 +++- 111 files changed, 971 insertions(+), 382 deletions(-) diff --git a/scribo/doc/Doxyfile.in b/scribo/doc/Doxyfile.in index 7ad639f..a6d8c3e 100644 --- a/scribo/doc/Doxyfile.in +++ b/scribo/doc/Doxyfile.in @@ -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_::ret" \ "mln_concrete(I)=typename mln::trait::concrete::ret" \ "mln_concrete_ch_value(I, V)=typename mln::trait::ch_value< typename mln::trait::concrete::ret, V >::ret" \ diff --git a/scribo/doc/groups.dox b/scribo/doc/groups.dox index 73d842e..f3db20b 100644 --- a/scribo/doc/groups.dox +++ b/scribo/doc/groups.dox @@ -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 */ diff --git a/scribo/scribo/binarization/global_threshold.hh b/scribo/scribo/binarization/global_threshold.hh index b90d6df..2633331 100644 --- a/scribo/scribo/binarization/global_threshold.hh +++ b/scribo/scribo/binarization/global_threshold.hh @@ -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. // diff --git a/scribo/scribo/binarization/internal/niblack_formula.hh b/scribo/scribo/binarization/internal/niblack_formula.hh index 54dbc9b..81432ae 100644 --- a/scribo/scribo/binarization/internal/niblack_formula.hh +++ b/scribo/scribo/binarization/internal/niblack_formula.hh @@ -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). \param[in] R Maximum value of the standard deviation (128 @@ -68,7 +68,8 @@ namespace scribo const double K, const double R) const; /*! - \overload K = 0.34. + \overload + K is set to 0.34. */ double operator()(const double m_x_y, const double s_x_y) const; diff --git a/scribo/scribo/binarization/internal/sauvola_formula.hh b/scribo/scribo/binarization/internal/sauvola_formula.hh index adbef13..6eb49a0 100644 --- a/scribo/scribo/binarization/internal/sauvola_formula.hh +++ b/scribo/scribo/binarization/internal/sauvola_formula.hh @@ -62,7 +62,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 @@ -74,7 +74,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; diff --git a/scribo/scribo/binarization/local_threshold.hh b/scribo/scribo/binarization/local_threshold.hh index 9d116ed..8ac3276 100644 --- a/scribo/scribo/binarization/local_threshold.hh +++ b/scribo/scribo/binarization/local_threshold.hh @@ -1,5 +1,5 @@ -// 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. // @@ -53,8 +53,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. // diff --git a/scribo/scribo/binarization/niblack.hh b/scribo/scribo/binarization/niblack.hh index e66e7b4..cc78808 100644 --- a/scribo/scribo/binarization/niblack.hh +++ b/scribo/scribo/binarization/niblack.hh @@ -55,12 +55,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 Niblack'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) @@ -72,11 +73,12 @@ namespace scribo Niblack'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 grpalgobinniblack */ template <typename I> mln_ch_value(I, bool) @@ -85,6 +87,7 @@ namespace scribo /// \overload /// The window size is set to 11. + /// \ingroup grpalgobinniblack // template <typename I> mln_ch_value(I, bool) diff --git a/scribo/scribo/binarization/niblack_threshold.hh b/scribo/scribo/binarization/niblack_threshold.hh index db4a74e..d9829f4 100644 --- a/scribo/scribo/binarization/niblack_threshold.hh +++ b/scribo/scribo/binarization/niblack_threshold.hh @@ -56,14 +56,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) @@ -73,6 +75,8 @@ namespace scribo Image<J>& squared); /// \overload + /// \ingroup grpalgobinniblack + // template <typename I> mln_ch_value(I, value::int_u8) niblack_threshold(const Image& input, unsigned window_size, @@ -80,6 +84,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& input, unsigned window_size); @@ -87,6 +93,7 @@ namespace scribo /// \overload /// The window size is set to 11. + /// \ingroup grpalgobinniblack // template <typename I> mln_ch_value(I, value::int_u8) diff --git a/scribo/scribo/binarization/otsu.hh b/scribo/scribo/binarization/otsu.hh index 6b9d492..2b8e97a 100644 --- a/scribo/scribo/binarization/otsu.hh +++ b/scribo/scribo/binarization/otsu.hh @@ -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) diff --git a/scribo/scribo/binarization/otsu_threshold.hh b/scribo/scribo/binarization/otsu_threshold.hh index ab663d0..7ba458f 100644 --- a/scribo/scribo/binarization/otsu_threshold.hh +++ b/scribo/scribo/binarization/otsu_threshold.hh @@ -49,6 +49,8 @@ namespace scribo \param[in] input A gray-scale image. \return A global threshold value. + + \ingroup grpalgobinotsu */ template <typename I> mln_value(I) diff --git a/scribo/scribo/binarization/sauvola.hh b/scribo/scribo/binarization/sauvola.hh index fc3e104..35757d6 100644 --- a/scribo/scribo/binarization/sauvola.hh +++ b/scribo/scribo/binarization/sauvola.hh @@ -56,12 +56,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) @@ -71,22 +72,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& 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& input); diff --git a/scribo/scribo/binarization/sauvola_ms.hh b/scribo/scribo/binarization/sauvola_ms.hh index 36629f9..c06cea8 100644 --- a/scribo/scribo/binarization/sauvola_ms.hh +++ b/scribo/scribo/binarization/sauvola_ms.hh @@ -88,21 +88,23 @@ namespace scribo \param[in] input_1 A grayscale or a color image. \param[in] w_1 The window size used to compute stats. \param[in] s The scale factor used for the first subscaling. - \param[in] lambda_min_1 Size of the objects kept at scale 1. \param[in] K Sauvola's formulae parameter. - - \p w_1 and \p lambda_min_1 are expressed according to the image - at scale 0, i.e. the original size. + \p w_1 is 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) - sauvola_ms(const Image& input_1_, unsigned w_1, unsigned s, double K); + sauvola_ms(const Image& input_1, unsigned w_1, unsigned s, double K); /// \overload /// K is set to 0.34. + /// + /// \ingroup grpalgobinsauvola // template <typename I> mln_ch_value(I,bool) diff --git a/scribo/scribo/binarization/sauvola_ms_split.hh b/scribo/scribo/binarization/sauvola_ms_split.hh index ac06a39..a3ab660 100644 --- a/scribo/scribo/binarization/sauvola_ms_split.hh +++ b/scribo/scribo/binarization/sauvola_ms_split.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2010 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2010, 2011 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -66,6 +67,8 @@ namespace scribo original size. \return A Boolean image. + + \ingroup grpalgobinsauvola */ template <typename I> mln_ch_value(I, bool) @@ -76,6 +79,8 @@ namespace scribo /// \overload /// K is set to 0.34. + /// \ingroup grpalgobinsauvola + // template <typename I> mln_ch_value(I, bool) sauvola_ms_split(const Image& input_1_, unsigned w_1, diff --git a/scribo/scribo/binarization/sauvola_threshold.hh b/scribo/scribo/binarization/sauvola_threshold.hh index df46e95..41d70f7 100644 --- a/scribo/scribo/binarization/sauvola_threshold.hh +++ b/scribo/scribo/binarization/sauvola_threshold.hh @@ -56,14 +56,16 @@ 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 + \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 grpalgobinsauvola */ template <typename I, typename J> mln_ch_value(I, value::int_u8) @@ -73,6 +75,7 @@ namespace scribo Image<J>& squared); /// \overload + /// \ingroup grpalgobinsauvola template <typename I> mln_ch_value(I, value::int_u8) sauvola_threshold(const Image& input, unsigned window_size, @@ -80,6 +83,7 @@ namespace scribo /// \overload /// K is set to 0.34 + /// \ingroup grpalgobinsauvola template <typename I> mln_ch_value(I, value::int_u8) sauvola_threshold(const Image& input, unsigned window_size); @@ -87,6 +91,7 @@ namespace scribo /// \overload /// The window size is set to 11. + /// \ingroup grpalgobinsauvola // template <typename I> mln_ch_value(I, value::int_u8) diff --git a/scribo/scribo/core/erase_objects.hh b/scribo/scribo/core/erase_objects.hh index 931024e..78fd293 100644 --- a/scribo/scribo/core/erase_objects.hh +++ b/scribo/scribo/core/erase_objects.hh @@ -1,5 +1,5 @@ -// 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. /// // diff --git a/scribo/scribo/debug/alignment_decision_image.hh b/scribo/scribo/debug/alignment_decision_image.hh index 450091d..cc7937b 100644 --- a/scribo/scribo/debug/alignment_decision_image.hh +++ b/scribo/scribo/debug/alignment_decision_image.hh @@ -55,18 +55,21 @@ namespace scribo /*! \brief Save a color image showing the difference between to object links. - \input[in] input An image. It's value type must be convertible + \param[in] input An image. It's value type must be convertible towards rgb8. - \input[in] links Object links information. - \input[in] filtered_links A copy of \p links which have been + \param[in] links Object links information. + \param[in] filtered_links A copy of \p links which have been filtered. + \param[in] anchor Anchor from where the links are drawn. \return A color image. Non filtered links are drawn in green. Others are drawn in red. - */ + + \ingroup grpalgodebug + */ template <typename I, typename L> mln_ch_value(I,value::rgb8) - alignment_decision_image(const Image& input_, + alignment_decision_image(const Image& input, const object_links<L>& links, const object_links<L>& filtered_links, const anchor::Type& anchor); diff --git a/scribo/scribo/debug/bboxes_enlarged_image.hh b/scribo/scribo/debug/bboxes_enlarged_image.hh index 24fea2f..01afd2c 100644 --- a/scribo/scribo/debug/bboxes_enlarged_image.hh +++ b/scribo/scribo/debug/bboxes_enlarged_image.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2010 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2010, 2011 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -70,6 +71,8 @@ namespace scribo /// a text line. /// /// \return A color image. + /// + /// \ingroup grpalgodebug // template <typename I, typename L> mln_ch_value(I,value::rgb8) @@ -81,6 +84,9 @@ namespace scribo /// \overload /// text_value is set to literal::green. /// non_text_value is set to literal::red. + /// + /// \ingroup grpalgodebug + // template <typename I, typename L> mln_ch_value(I,value::rgb8) bboxes_enlarged_image(const Image& input, diff --git a/scribo/scribo/debug/bboxes_image.hh b/scribo/scribo/debug/bboxes_image.hh index d3dc64b..1b2ee4f 100644 --- a/scribo/scribo/debug/bboxes_image.hh +++ b/scribo/scribo/debug/bboxes_image.hh @@ -51,14 +51,20 @@ namespace scribo using namespace mln; - /// Draw a list of bounding boxes + /// \brief Draw a list of bounding boxes + /// + /// \ingroup grpalgodebug + // template <typename I> mln_ch_value(I, value::rgb8) bboxes_image(const Image& input, const mln::util::array< box<mln_site(I)> >& bboxes, const value::rgb8& value); - + /// \overload + /// + /// \ingroup grpalgodebug + // template <typename I, typename L> mln_ch_value(I, value::rgb8) bboxes_image(const Image& input, @@ -67,6 +73,8 @@ namespace scribo /// \overload /// value is set to literal::red. + /// + /// \ingroup grpalgodebug // template <typename I, typename L> inline @@ -74,7 +82,10 @@ namespace scribo bboxes_image(const Image& input, const line_set<L>& lines); - /// \overload. + /// \overload + /// + /// \ingroup grpalgodebug + // template <typename I, typename L> inline mln_ch_value(I, value::rgb8) diff --git a/scribo/scribo/debug/char_space_image.hh b/scribo/scribo/debug/char_space_image.hh index 53fc303..ffb2e82 100644 --- a/scribo/scribo/debug/char_space_image.hh +++ b/scribo/scribo/debug/char_space_image.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2010 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2010, 2011 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -53,6 +54,8 @@ namespace scribo /// \brief Draw inter character space. + /// + /// \ingroup grpalgodebug // template <typename I, typename L> mln_ch_value(I,value::rgb8) diff --git a/scribo/scribo/debug/decision_image.hh b/scribo/scribo/debug/decision_image.hh index ff298e6..9857c66 100644 --- a/scribo/scribo/debug/decision_image.hh +++ b/scribo/scribo/debug/decision_image.hh @@ -56,19 +56,22 @@ namespace scribo /*! \brief Save a color image showing the difference between to object groups. - \input[in] input An image. It's value type must be convertible + \param[in] input An image. It's value type must be convertible towards rgb8. - \input[in] groups Object groups information. - \input[in] filtered_groups A copy of \p groups which have been + \param[in] groups Object groups information. + \param[in] filtered_groups A copy of \p groups which have been filtered. + \param[in] anchor Anchor from where the links are drawn. \return A color image. Components part of a validated group are drawn in green with their bounding box. Otherwise, they are drawn in red. + + \ingroup grpalgodebug */ template <typename I, typename L> mln_ch_value(I,value::rgb8) - decision_image(const Image& input_, + decision_image(const Image& input, const object_groups<L>& groups, const object_groups<L>& filtered_groups, anchor::Type anchor); @@ -76,18 +79,21 @@ namespace scribo /*! \brief Save a color image showing the difference between to object links. - \input[in] input An image. It's value type must be convertible + \param[in] input An image. It's value type must be convertible towards rgb8. - \input[in] links Object links information. - \input[in] filtered_links A copy of \p links which have been + \param[in] links Object links information. + \param[in] filtered_links A copy of \p links which have been filtered. + \param[in] anchor Anchor from where the links are drawn. \return A color image. Non filtered links are drawn in green. Others are drawn in red. + + \ingroup grpalgodebug */ template <typename I, typename L> mln_ch_value(I,value::rgb8) - decision_image(const Image& input_, + decision_image(const Image& input, const object_links<L>& links, const object_links<L>& filtered_links, anchor::Type anchor); diff --git a/scribo/scribo/debug/highlight_text_area.hh b/scribo/scribo/debug/highlight_text_area.hh index 5fc9329..2a7ed8a 100644 --- a/scribo/scribo/debug/highlight_text_area.hh +++ b/scribo/scribo/debug/highlight_text_area.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2010 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2010, 2011 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -62,10 +63,11 @@ namespace scribo \return a color image with highlighted text areas. + \ingroup grpalgodebug */ template <typename I> mln_ch_value(I, value::rgb8) - highlight_text_area(const Image& input_, + highlight_text_area(const Image& input, const mln::util::array<box<mln_site(I)> >& bbox); @@ -76,10 +78,11 @@ namespace scribo \return a color image with highlighted text areas. + \ingroup grpalgodebug */ template <typename I, typename L> mln_ch_value(I, value::rgb8) - highlight_text_area(const Image& input_, + highlight_text_area(const Image& input, const line_set<L>& lines); /*! \brief Darken an image and highlight valid lines. @@ -92,10 +95,11 @@ namespace scribo \return a color image with highlighted text areas. + \ingroup grpalgodebug */ template <typename I, typename L> mln_ch_value(I, value::rgb8) - highlight_text_area(const Image& input_, + highlight_text_area(const Image& input, const scribo::component_set<L>& components); diff --git a/scribo/scribo/debug/line_info_image.hh b/scribo/scribo/debug/line_info_image.hh index f3d7ddf..ff277ef 100644 --- a/scribo/scribo/debug/line_info_image.hh +++ b/scribo/scribo/debug/line_info_image.hh @@ -53,6 +53,10 @@ namespace scribo using namespace mln; + /*! \brief Draw typographic information from lines. + + \ingroup grpalgodebug + */ template <typename I, typename L> mln_ch_value(I,value::rgb8) line_info_image(const Image& input, const line_set<L>& line); diff --git a/scribo/scribo/debug/linked_bboxes_image.hh b/scribo/scribo/debug/linked_bboxes_image.hh index 2373405..1b502b0 100644 --- a/scribo/scribo/debug/linked_bboxes_image.hh +++ b/scribo/scribo/debug/linked_bboxes_image.hh @@ -1,5 +1,5 @@ -// 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. // @@ -29,7 +29,7 @@ /// \file /// -/// Compute the bounding box links image. +/// \brief Compute the bounding box links image. # include <mln/core/concept/image.hh> # include <mln/core/concept/graph.hh> @@ -59,10 +59,12 @@ namespace scribo /// Compute the line of components links image. /// /// \param[in,out] input The binary from where the components are extracted. - /// \param[in] link_array Lines of components links. + /// \param[in] array Components links. /// \param[in] box_value Value used to draw line bounding boxes. /// \param[in] link_value Value used to draw line links. /// \param[in] anchor Anchor from where the links are drawn. + /// + /// \ingroup grpalgodebug // template <typename I, typename L> mln_ch_value(I,value::rgb8) @@ -74,6 +76,8 @@ namespace scribo /// \overload /// The default anchor type is set to anchor::Center. + /// + /// \ingroup grpalgodebug // template <typename I, typename L> mln_ch_value(I,value::rgb8) @@ -85,10 +89,13 @@ namespace scribo /// Compute the line of components left and right links image. /// /// \param[in,out] input The binary from where the components are extracted. - /// \param[in] left_link Lines of components left links. - /// \param[in] right_link Lines of components right links. + /// \param[in] left_link Components left links. + /// \param[in] right_link Components right links. /// \param[in] box_value Value used to draw line bounding boxes. /// \param[in] link_value Value used to draw line links. + /// \param[in] anchor Anchor from where the links are drawn. + /// + /// \ingroup grpalgodebug // template <typename I, typename L> mln_ch_value(I,value::rgb8) @@ -103,12 +110,15 @@ namespace scribo /// Draw also validated links. /// /// \param[in,out] input The binary from where the components are extracted. - /// \param[in] left_link Lines of components left links. - /// \param[in] right_link Lines of components right links. + /// \param[in] left_link Components left links. + /// \param[in] right_link Components right links. /// \param[in] box_value Value used to draw line bounding boxes. /// \param[in] left_link_value Value used to draw line left links. /// \param[in] right_link_value Value used to draw line left links. /// \param[in] validated_link_value Value used to draw line validated links. + /// \param[in] anchor Anchor from where the links are drawn. + /// + /// \ingroup grpalgodebug // template <typename I, typename L> inline @@ -129,6 +139,9 @@ namespace scribo /// \param[in] g The link graph. /// \param[in] box_value Value used to draw line bounding boxes. /// \param[in] link_value Value used to draw line links. + /// \param[in] anchor Anchor from where the links are drawn. + /// + /// \ingroup grpalgodebug // template <typename I, typename L, typename G> mln_ch_value(I,value::rgb8) diff --git a/scribo/scribo/debug/links_decision_image.hh b/scribo/scribo/debug/links_decision_image.hh index 387cd7f..f62eca4 100644 --- a/scribo/scribo/debug/links_decision_image.hh +++ b/scribo/scribo/debug/links_decision_image.hh @@ -1,5 +1,5 @@ -// 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. // @@ -29,7 +29,7 @@ /// \file /// -/// Save a color image showing the difference between to object groups. +/// \brief Save a color image showing the difference between to object groups. # include <mln/core/concept/image.hh> # include <mln/data/convert.hh> @@ -49,7 +49,11 @@ namespace scribo using namespace mln; - /// FIXME: DOC! + /*! \brief Save a color image showing the difference between to + object groups. + + \ingroup grpalgodebug + */ template <typename I, typename L> mln_ch_value(I,value::rgb8) links_decision_image(const Image& input_, diff --git a/scribo/scribo/debug/links_image.hh b/scribo/scribo/debug/links_image.hh index 47394be..ec747f6 100644 --- a/scribo/scribo/debug/links_image.hh +++ b/scribo/scribo/debug/links_image.hh @@ -28,7 +28,7 @@ /// \file /// -/// Save a color image showing components links. +/// \brief Save a color image showing components links. # include <mln/core/concept/image.hh> # include <mln/accu/center.hh> @@ -50,7 +50,10 @@ namespace scribo using namespace mln; - /// FIXME: DOC! + /*! \brief Save a color image showing components links. + + \ingroup grpalgodebug + */ template <typename I, typename L> mln_ch_value(I,value::rgb8) links_image(const Image& input_, diff --git a/scribo/scribo/debug/logger.hh b/scribo/scribo/debug/logger.hh index f16dd89..ef5fd74 100644 --- a/scribo/scribo/debug/logger.hh +++ b/scribo/scribo/debug/logger.hh @@ -27,6 +27,10 @@ #ifndef SCRIBO_CORE_LOGGER_HH # define SCRIBO_CORE_LOGGER_HH +/// \file +/// +/// \brief Logger class used to save debug images. + # include <mln/core/concept/image.hh> # include <mln/data/wrap.hh> # include <mln/value/int_u8.hh> @@ -115,7 +119,10 @@ namespace scribo } // end of namespace scribo::debug::internal - // Return a reference to the logger. + /*! \brief Return a reference to the logger. + + \ingroup grpalgodebug + */ scribo::debug::internal::logger_& logger(); diff --git a/scribo/scribo/debug/looks_like_a_text_line_image.hh b/scribo/scribo/debug/looks_like_a_text_line_image.hh index 376baae..5bfe61e 100644 --- a/scribo/scribo/debug/looks_like_a_text_line_image.hh +++ b/scribo/scribo/debug/looks_like_a_text_line_image.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2010 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2010, 2011 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -28,8 +29,8 @@ /// \file /// -/// Compute an image where components are drawn differently whether -/// they look like a line or not. +/// \brief Compute an image where components are drawn differently +/// whether they look like a line or not. # include <mln/core/concept/image.hh> @@ -64,6 +65,8 @@ namespace scribo /// a text line. /// /// \return A color image. + /// + /// \ingroup grpalgodebug // template <typename I, typename L> mln_ch_value(I,value::rgb8) @@ -75,6 +78,9 @@ namespace scribo /// \overload /// text_value is set to literal::green. /// non_text_value is set to literal::red. + /// + /// \ingroup grpalgodebug + // template <typename I, typename L> mln_ch_value(I,value::rgb8) looks_like_a_text_line_image(const Image& input, diff --git a/scribo/scribo/debug/mean_and_base_lines_image.hh b/scribo/scribo/debug/mean_and_base_lines_image.hh index 56055c9..89ee198 100644 --- a/scribo/scribo/debug/mean_and_base_lines_image.hh +++ b/scribo/scribo/debug/mean_and_base_lines_image.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2010 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2010, 2011 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -65,6 +66,8 @@ namespace scribo /// \param[in] baseline_value Value used to draw base lines. /// /// \return A color image. + /// + /// \ingroup grpalgodebug // template <typename I, typename L> mln_ch_value(I,value::rgb8) @@ -77,6 +80,9 @@ namespace scribo /// \overload /// text_value is set to literal::green. /// non_text_value is set to literal::red. + /// + /// \ingroup grpalgodebug + // template <typename I, typename L> mln_ch_value(I,value::rgb8) mean_and_base_lines_image(const Image& input, diff --git a/scribo/scribo/debug/save_comp_diff.hh b/scribo/scribo/debug/save_comp_diff.hh index f1f93f0..6b2bc3b 100644 --- a/scribo/scribo/debug/save_comp_diff.hh +++ b/scribo/scribo/debug/save_comp_diff.hh @@ -1,5 +1,5 @@ -// 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. // @@ -55,15 +55,16 @@ namespace scribo /*! \brief Show the difference between two object images. - \param[in] lbl A component set. - \param[in] lbl_2 Another component set. + \param[in] comps_ref A component set. + \param[in] comps_new Another component set. \param[in] filename The output filename. + \ingroup grpalgodebug */ template <typename L, typename L2> void - save_comp_diff(const component_set<L>& cset_1, - const component_set<L2>& cset_2, + save_comp_diff(const component_set<L>& comps_ref, + const component_set<L2>& comps_new, const std::string& filename); @@ -72,22 +73,26 @@ namespace scribo template <typename L, typename L2> void - save_comp_diff(const component_set<L>& cset_1, - const component_set<L2>& cset_2, + save_comp_diff(const component_set<L>& comps_ref, + const component_set<L2>& comps_new, const std::string& filename) { trace::entering("scribo::debug::save_comp_diff"); image2d<value::rgb8> output; - initialize(output, cset_1.labeled_image()); + initialize(output, comps_ref.labeled_image()); data::fill(output, literal::black); - for_all_comps(i, cset_1) - data::fill(((output | cset_1(i).bbox()).rw() | (pw::value(cset_1.labeled_image()) == i)).rw(), literal::red); + for_all_comps(i, comps_ref) + data::fill(((output | comps_ref(i).bbox()).rw() + | (pw::value(comps_ref.labeled_image()) == i)).rw(), + literal::red); - for_all_comps(i, cset_2) - data::fill(((output | cset_2(i).bbox()).rw() | (pw::value(cset_2.labeled_image()) == i)).rw(), literal::green); + for_all_comps(i, comps_new) + data::fill(((output | comps_new(i).bbox()).rw() + | (pw::value(comps_new.labeled_image()) == i)).rw(), + literal::green); io::ppm::save(output, filename); diff --git a/scribo/scribo/debug/save_label_image.hh b/scribo/scribo/debug/save_label_image.hh index b41325e..af138d9 100644 --- a/scribo/scribo/debug/save_label_image.hh +++ b/scribo/scribo/debug/save_label_image.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2011 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -28,7 +29,7 @@ /// \file /// -/// Save a labeled image in a color image. +/// \brief Save a labeled image in a color image. # include <mln/core/concept/image.hh> # include <mln/labeling/colorize.hh> @@ -43,11 +44,13 @@ namespace scribo using namespace mln; - /// Save a labeled image in a color image. + /// \brief Save a labeled image in a color image. /// /// \param[in] lbl A label image. /// \param[in] nlabels The number of labels. /// \param[in] filename The output file name. + /// + /// \ingroup grpalgodebug // template <typename I> void diff --git a/scribo/scribo/debug/save_table_image.hh b/scribo/scribo/debug/save_table_image.hh index 746d162..8a5c01f 100644 --- a/scribo/scribo/debug/save_table_image.hh +++ b/scribo/scribo/debug/save_table_image.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2011 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -28,7 +29,7 @@ /// \file /// -/// Save table line bounding boxes in an image. +/// \brief Save table line bounding boxes in an image. # include <string> @@ -53,6 +54,9 @@ namespace scribo /// Save lines bounding boxes in a copy of \p input_. /// Bounding boxes are displayed with \p bbox_color. + /// + /// \ingroup grpalgodebug + // template <typename I> void save_table_image(const Image& input_, @@ -64,6 +68,9 @@ namespace scribo /// Save lines bounding boxes in an image defined on \p input_domain /// filled with \p bg_color. /// Bounding boxes are displayed with \p bbox_color. + /// + /// \ingroup grpalgodebug + // template <typename S> void save_table_image(const Site_Set<S>& input_domain, diff --git a/scribo/scribo/debug/text_areas_image.hh b/scribo/scribo/debug/text_areas_image.hh index 5b9f086..6aaa64f 100644 --- a/scribo/scribo/debug/text_areas_image.hh +++ b/scribo/scribo/debug/text_areas_image.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2010 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2010, 2011 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -59,6 +60,7 @@ namespace scribo /*! \brief Compute an image including detected text areas only. + \ingroup grpalgodebug */ template <typename I, typename L> mln_concrete(I) diff --git a/scribo/scribo/debug/text_color_image.hh b/scribo/scribo/debug/text_color_image.hh index f8d76c8..182b71b 100644 --- a/scribo/scribo/debug/text_color_image.hh +++ b/scribo/scribo/debug/text_color_image.hh @@ -49,6 +49,10 @@ namespace scribo { using namespace mln; + /*! \brief Draw text components with their respective colors. + + \ingroup grpalgodebug + */ template <typename L> image2d<value::rgb8> text_color_image(const document<L>& doc); diff --git a/scribo/scribo/draw/bounding_box_links.hh b/scribo/scribo/draw/bounding_box_links.hh index 830da25..2816d4e 100644 --- a/scribo/scribo/draw/bounding_box_links.hh +++ b/scribo/scribo/draw/bounding_box_links.hh @@ -50,18 +50,16 @@ namespace scribo using namespace mln; - /// Draw a list of bounding box links. Draw links from the bounding - /// box centers. + /// \brief Draw a list of bounding box links. /// - /// \param[in,out] input_ An image where to draw. - /// \param[in] bboxes Bounding boxes. - /// \param[in] links Bounding box links. + /// \param[in,out] input An image where to draw. + /// \param[in] link component links. /// \param[in] value Value used to draw links. /// \param[in] anchor Anchor from where the links are drawn. // template <typename I, typename L> void - bounding_box_links(Image& input_, + bounding_box_links(Image& input, const object_links<L>& link, const mln_value(I)& value, anchor::Type anchor); @@ -72,24 +70,26 @@ namespace scribo // template <typename I, typename L> void - bounding_box_links(Image& input_, + bounding_box_links(Image& input, const object_links<L>& link, const mln_value(I)& value); - /// Draw left, right and validated lists of bounding box links. - /// Draw from anchors. + /// \brief Draw left, right and validated lists of bounding box + /// links. /// - /// \param[in,out] input_ An image where to draw. - /// \param[in] left_link Bounding box left links. - /// \param[in] right_link Bounding box right links. + /// \param[in,out] input An image where to draw. + /// \param[in] left_link Component's left links. + /// \param[in] right_link Component's right links. /// \param[in] left_link_value Value used to draw left links. /// \param[in] right_link_value Value used to draw right links. /// \param[in] validated_link_value Value used to draw validated links. + /// \param[in] anchor Anchor from where the links are drawn. + // template <typename I, typename L> inline void - bounding_box_links(Image& input_, + bounding_box_links(Image& input, const object_links<L>& left_link, const object_links<L>& right_link, const mln_value(I)& left_link_value, @@ -98,18 +98,18 @@ namespace scribo anchor::Type anchor); - /// Draw a graph of bounding box links. + /// \brief Draw a graph of bounding box links. /// Draw from bounding box centers. /// - /// \param[in,out] input_ An image where to draw. - /// \param[in] bboxes Bounding boxes. - /// \param[in] g_ The link graph. + /// \param[in,out] input An image where to draw. + /// \param[in] g The link graph. /// \param[in] link_value The value used to draw the links. + // template <typename I, typename G> inline void - bounding_box_links(Image& input_, - const Graph<G>& g_, + bounding_box_links(Image& input, + const Graph<G>& g, const mln_value(I)& link_value); diff --git a/scribo/scribo/filter/images_in_paragraph.hh b/scribo/scribo/filter/images_in_paragraph.hh index cf77892..9a88c51 100644 --- a/scribo/scribo/filter/images_in_paragraph.hh +++ b/scribo/scribo/filter/images_in_paragraph.hh @@ -28,7 +28,7 @@ /// \file /// -/// Invalidate false positive separators. +/// Invalidate false positive images. /// \fixme Share same test canvas as text::merging. @@ -47,16 +47,12 @@ namespace scribo using namespace mln; - /// Invalidate false positive separators. + /// Invalidate false positive images. /// - /// \param[in] separators A paragraph set. - /// - /// \return A doc with invalidated separators. - /// - /// Warning: it does not remove separators from separator - /// image. It only invalidate separator components in their - /// respective component_set. + /// \param[in,out] doc A document structure. /// + /// \ingroup grpalgofilterelt + // template <typename L> void images_in_paragraph(document<L>& doc); diff --git a/scribo/scribo/filter/line_links_x_height.hh b/scribo/scribo/filter/line_links_x_height.hh index 0fcc341..c3b2909 100644 --- a/scribo/scribo/filter/line_links_x_height.hh +++ b/scribo/scribo/filter/line_links_x_height.hh @@ -41,6 +41,15 @@ namespace scribo namespace filter { + /*! \brief Filter line links according to character x height. + + \param[in] links Line links information. + + \return A new line_links structure where some links may have + been invalidated. + + \ingroup grpalgofilterlinelink + */ template <typename L> line_links<L> line_links_x_height(const line_links<L>& links); diff --git a/scribo/scribo/filter/object_groups_mean_width.hh b/scribo/scribo/filter/object_groups_mean_width.hh index b9c7b8a..2386517 100644 --- a/scribo/scribo/filter/object_groups_mean_width.hh +++ b/scribo/scribo/filter/object_groups_mean_width.hh @@ -55,6 +55,7 @@ namespace scribo \return Filtered object group information. + \ingroup grpalgofiltercompgroup */ template <typename L> object_groups<L> diff --git a/scribo/scribo/filter/object_groups_size_ratio.hh b/scribo/scribo/filter/object_groups_size_ratio.hh index 6f2e33e..2607c86 100644 --- a/scribo/scribo/filter/object_groups_size_ratio.hh +++ b/scribo/scribo/filter/object_groups_size_ratio.hh @@ -29,6 +29,7 @@ /// \file /// +/// \brief Invalidates groups with too much thin and high components. # include <mln/util/array.hh> @@ -44,6 +45,21 @@ namespace scribo using namespace mln; + /*! \brief Invalidates groups with too much thin and high + components. + + For each components in the group, it computes the height/width + ratio. If it is higher or equal to \p max_size_ratio, the + component is counted as invalid. + + If there are \p max_invalid_ratio_per_group invalid + components, the group is invalidated. + + \return An object_group structure potentially with invalided + groups. + + \ingroup grpalgofiltercompgroup + */ template <typename L> object_groups<L> object_groups_size_ratio(const object_groups<L>& groups, diff --git a/scribo/scribo/filter/object_groups_small.hh b/scribo/scribo/filter/object_groups_small.hh index dd92852..5a698cb 100644 --- a/scribo/scribo/filter/object_groups_small.hh +++ b/scribo/scribo/filter/object_groups_small.hh @@ -29,7 +29,7 @@ /// \file /// -/// Remove small objects groups. +/// \brief Invalidate groups with few components. # include <mln/util/array.hh> @@ -45,14 +45,15 @@ namespace scribo using namespace mln; - /*! \brief Remove objects within a group with less than \p n - links. + /*! \brief Invalidate groups with few components. \param[in] groups Information about object groups. \param[in] n_links The minimum number of links per group. \return A copy of object group in which small groups have been - removed. + invalidated. + + \ingroup grpalgofiltercompgroup */ template <typename L> object_groups<L> diff --git a/scribo/scribo/filter/object_groups_with_holes.hh b/scribo/scribo/filter/object_groups_with_holes.hh index a59beec..ca55980 100644 --- a/scribo/scribo/filter/object_groups_with_holes.hh +++ b/scribo/scribo/filter/object_groups_with_holes.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2010 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2010, 2011 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -69,8 +70,16 @@ namespace scribo using namespace mln; /*! \brief Remove groups not having at least two background - * components of \p min_size pixels. + components of \p min_size pixels. + In order to verify the property of "having two background + components", a component group must have at least one + component with a hole. + + Example: the letter 'o' has two background components: outside + and inside the letter. + + \ingroup grpalgofiltercompgroup */ template <typename L> inline diff --git a/scribo/scribo/filter/object_links_aligned.hh b/scribo/scribo/filter/object_links_aligned.hh index e37bcb6..6d76d95 100644 --- a/scribo/scribo/filter/object_links_aligned.hh +++ b/scribo/scribo/filter/object_links_aligned.hh @@ -28,7 +28,7 @@ /// \file /// -/// Invalidate links between two components if their not aligned +/// \brief Invalidate links between two components if their not aligned /// according to an anchor. # include <scribo/core/macros.hh> @@ -44,7 +44,8 @@ namespace scribo using namespace mln; - /*! \brief Invalidate links between two components according to a specific anchor. + /*! \brief Invalidate links between two components according to a + specific anchor. \param[in] links Object links information. \param[in] max_alpha Maximum angle value (degrees). @@ -74,6 +75,7 @@ namespace scribo Example with an anchor set to the bottom right : The angle between the two bottoms must be lower than \p max_alpha. + \ingroup grpalgofiltercomplink */ template <typename L> object_links<L> diff --git a/scribo/scribo/filter/object_links_bbox_h_ratio.hh b/scribo/scribo/filter/object_links_bbox_h_ratio.hh index 5573f16..2c3256a 100644 --- a/scribo/scribo/filter/object_links_bbox_h_ratio.hh +++ b/scribo/scribo/filter/object_links_bbox_h_ratio.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2011 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -28,7 +29,8 @@ /// \file /// -/// Invalidate links between two objects with too different height. +/// \brief Invalidate links between two objects with too different +/// height. /// /// \todo rename to object_links_bbox_v_ratio (v for vertical) to be /// consistent with other routine names. @@ -57,6 +59,8 @@ namespace scribo bounding boxes. \result A filtered object link information. + + \ingroup grpalgofiltercomplink */ template <typename L> object_links<L> diff --git a/scribo/scribo/filter/object_links_bbox_overlap.hh b/scribo/scribo/filter/object_links_bbox_overlap.hh index 29b71ba..d09839a 100644 --- a/scribo/scribo/filter/object_links_bbox_overlap.hh +++ b/scribo/scribo/filter/object_links_bbox_overlap.hh @@ -29,8 +29,8 @@ /// \file /// -/// Invalidate links between two components having their bounding box -/// overlapping too much. +/// \brief Invalidate links between two components having their +/// bounding box overlapping too much. # include <mln/math/min.hh> @@ -59,6 +59,8 @@ namespace scribo areas. \result A filtered object link information. + + \ingroup grpalgofiltercomplink */ template <typename L> object_links<L> diff --git a/scribo/scribo/filter/object_links_bbox_ratio.hh b/scribo/scribo/filter/object_links_bbox_ratio.hh index d6c9286..2a2afa1 100644 --- a/scribo/scribo/filter/object_links_bbox_ratio.hh +++ b/scribo/scribo/filter/object_links_bbox_ratio.hh @@ -29,8 +29,8 @@ /// \file /// -/// Invalidate links between two objects with too different height or -/// width. +/// \brief Invalidate links between two objects with too different +/// height or width. # include <mln/util/array.hh> @@ -56,6 +56,8 @@ namespace scribo bounding boxes. \result A filtered object link information. + + \ingroup grpalgofiltercomplink */ template <typename L> object_links<L> diff --git a/scribo/scribo/filter/object_links_bbox_w_ratio.hh b/scribo/scribo/filter/object_links_bbox_w_ratio.hh index 07adcee..7bcb3d3 100644 --- a/scribo/scribo/filter/object_links_bbox_w_ratio.hh +++ b/scribo/scribo/filter/object_links_bbox_w_ratio.hh @@ -1,5 +1,5 @@ -// 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. // @@ -29,7 +29,8 @@ /// \file /// -/// Invalidate links between two objects with too different width. +/// \brief Invalidate links between two objects with too different +/// width. /// /// \todo rename to object_links_bbox_h_ratio (h for horizontal) to be /// consistent with other routine names. @@ -57,6 +58,8 @@ namespace scribo bounding boxes. \result A filtered object link information. + + \ingroup grpalgofiltercomplink */ template <typename L> object_links<L> diff --git a/scribo/scribo/filter/object_links_bottom_aligned.hh b/scribo/scribo/filter/object_links_bottom_aligned.hh index 2329f37..353c2f6 100644 --- a/scribo/scribo/filter/object_links_bottom_aligned.hh +++ b/scribo/scribo/filter/object_links_bottom_aligned.hh @@ -29,8 +29,8 @@ /// \file /// -/// Invalidate links between two components if their bottom are not -/// aligned. +/// \brief Invalidate links between two components if their bottom are +/// not aligned. # include <mln/util/array.hh> @@ -77,6 +77,7 @@ namespace scribo The angle between the two bottoms must be lower than \p max_alpha. + \ingroup grpalgofiltercomplink */ template <typename L> object_links<L> diff --git a/scribo/scribo/filter/object_links_center_aligned.hh b/scribo/scribo/filter/object_links_center_aligned.hh index da18b00..adbfad8 100644 --- a/scribo/scribo/filter/object_links_center_aligned.hh +++ b/scribo/scribo/filter/object_links_center_aligned.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2011 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -28,8 +29,8 @@ /// \file /// -/// Invalidate links between two objects if their center are not -/// aligned. +/// \brief Invalidate links between two objects if their center are +/// not aligned. # include <mln/util/array.hh> @@ -50,10 +51,11 @@ namespace scribo /*! \brief Invalidate links between two objects if their center are not aligned. - \param[in] objects An object image. \param[in] links Object links information. \param[in] max_alpha Maximum angle value (degrees). + \return New link data. + \verbatim ------ ------ @@ -70,6 +72,7 @@ namespace scribo The angle between the two bottoms must be lower than \p max_alpha. + \ingroup grpalgofiltercomplink */ template <typename L> object_links<L> diff --git a/scribo/scribo/filter/object_links_left_aligned.hh b/scribo/scribo/filter/object_links_left_aligned.hh index 830678a..9a50a20 100644 --- a/scribo/scribo/filter/object_links_left_aligned.hh +++ b/scribo/scribo/filter/object_links_left_aligned.hh @@ -29,10 +29,10 @@ /// \file /// -/// Invalidate links between two objects if their left are not +/// \brief Invalidate links between two objects if their left are not /// aligned. /// -/// \fixme UPDATE DOC! +/// \todo UPDATE DOC! # include <mln/util/array.hh> @@ -49,8 +49,8 @@ namespace scribo using namespace mln; - /*! \brief Invalidate links between two objects if their left are not - aligned. + /*! \brief Invalidate links between two objects if their left are + not aligned. \param[in] links Object links information. \param[in] max_alpha Maximum angle value (degrees). @@ -77,6 +77,8 @@ namespace scribo \endverbatim The angle between the two lefts must be lower than \p max_alpha. + + \ingroup grpalgofiltercomplink */ template <typename L> object_links<L> diff --git a/scribo/scribo/filter/object_links_non_aligned_simple.hh b/scribo/scribo/filter/object_links_non_aligned_simple.hh index f8db5cf..77c5b1c 100644 --- a/scribo/scribo/filter/object_links_non_aligned_simple.hh +++ b/scribo/scribo/filter/object_links_non_aligned_simple.hh @@ -29,7 +29,7 @@ /// \file /// -/// Invalidate links between two non aligned components. +/// \brief Invalidate links between two non aligned components. # include <mln/util/array.hh> @@ -52,6 +52,7 @@ namespace scribo Alignment is based on a given anchor of object bounding boxes. \param[in] links Object links information. + \param[in] anchor Anchor from where the links are made. \param[in] max_alpha Maximum angle value (degrees). @@ -79,6 +80,7 @@ namespace scribo The angle between the two bottoms must be lower than \p alpha. + \ingroup grpalgofiltercomplink */ template <typename L> object_links<L> diff --git a/scribo/scribo/filter/object_links_right_aligned.hh b/scribo/scribo/filter/object_links_right_aligned.hh index 4f854e2..018cf97 100644 --- a/scribo/scribo/filter/object_links_right_aligned.hh +++ b/scribo/scribo/filter/object_links_right_aligned.hh @@ -29,7 +29,7 @@ /// \file /// -/// Invalidate links between two objects if their right are not +/// \brief Invalidate links between two objects if their right are not /// aligned. @@ -51,7 +51,6 @@ namespace scribo /*! \brief Invalidate links between two objects if their right are not aligned. - \param[in] objects An object image. \param[in] links Object links information. \param[in] max_alpha Maximum angle value (degrees). @@ -77,6 +76,8 @@ namespace scribo \endverbatim The angle between the two rights must be lower than \p max_alpha. + + \ingroup grpalgofiltercomplink */ template <typename L> object_links<L> diff --git a/scribo/scribo/filter/object_links_top_aligned.hh b/scribo/scribo/filter/object_links_top_aligned.hh index 48598c6..6489ea4 100644 --- a/scribo/scribo/filter/object_links_top_aligned.hh +++ b/scribo/scribo/filter/object_links_top_aligned.hh @@ -29,7 +29,7 @@ /// \file /// -/// Invalidate links between two objects if their top are not +/// \brief Invalidate links between two objects if their top are not /// aligned. @@ -48,8 +48,8 @@ namespace scribo using namespace mln; - /*! \brief Invalidate links between two objects if their top are not - aligned. + /*! \brief Invalidate links between two objects if their top are + not aligned. \param[in] links Object links information. \param[in] max_alpha Maximum angle value (degrees). @@ -77,6 +77,8 @@ namespace scribo \endverbatim The angle between the two tops must be lower than \p max_alpha. + + \ingroup grpalgofiltercomplink */ template <typename L> object_links<L> diff --git a/scribo/scribo/filter/objects_h_thick.hh b/scribo/scribo/filter/objects_h_thick.hh index 06b75dc..7dc7fa5 100644 --- a/scribo/scribo/filter/objects_h_thick.hh +++ b/scribo/scribo/filter/objects_h_thick.hh @@ -54,6 +54,8 @@ namespace scribo /// \param[in] max_thickness The maximum thickness value. /// /// \result A binary image without thick objects. + /// + /// \ingroup grpalgofiltercomp // template <typename I, typename N, typename V> inline @@ -70,6 +72,8 @@ namespace scribo /// \param[in] max_thickness The minimum thickness value. /// /// \result A component data set without too thick components. + /// + /// \ingroup grpalgofiltercomp // template <typename L> inline diff --git a/scribo/scribo/filter/objects_h_thin.hh b/scribo/scribo/filter/objects_h_thin.hh index 8caa2cc..7b1d18a 100644 --- a/scribo/scribo/filter/objects_h_thin.hh +++ b/scribo/scribo/filter/objects_h_thin.hh @@ -53,6 +53,8 @@ namespace scribo /// \param[in] min_thinness the minimum thinness value. /// /// \result A binary image without h_thin components. + /// + /// \ingroup grpalgofiltercomp // template <typename I, typename N, typename V> inline @@ -68,6 +70,8 @@ namespace scribo /// \param[in] min_thinness the minimum thinness value. /// /// \result An object image without too thin vertical components. + /// + /// \ingroup grpalgofiltercomp // template <typename L> inline diff --git a/scribo/scribo/filter/objects_large.hh b/scribo/scribo/filter/objects_large.hh index 8dfec9d..96d1817 100644 --- a/scribo/scribo/filter/objects_large.hh +++ b/scribo/scribo/filter/objects_large.hh @@ -1,5 +1,5 @@ -// 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. // @@ -29,7 +29,7 @@ /// \file /// -/// Remove large objects in a binary image. +/// \brief Remove large objects in a binary image. # include <mln/core/concept/image.hh> @@ -56,7 +56,8 @@ namespace scribo using namespace mln; - /// Remove large objects in a binary image. + /// \brief Remove large objects in a binary image. + /// /// Set to 'false' all the removed objects. /// /// \param[in] input_ A binary image. @@ -65,6 +66,9 @@ namespace scribo /// \param[in] max_size The minimum cardinality of an object. /// /// \return A binary image without large objects. + /// + /// \ingroup grpalgofiltercomp + // template <typename I, typename N, typename V> mln_concrete(I) components_large(const Image& input_, @@ -72,13 +76,16 @@ namespace scribo const V& label_type, unsigned max_size); - /// Remove too large components. + /// \brief Remove too large components. /// /// \param[in] components An object image. /// \param[in] max_size The maximum cardinality of an object. /// /// \return A component set with large components set to /// component::Ignored. + /// + /// \ingroup grpalgofiltercomp + // template <typename L> inline component_set<L> diff --git a/scribo/scribo/filter/objects_on_border.hh b/scribo/scribo/filter/objects_on_border.hh index d6c4cf5..55578a4 100644 --- a/scribo/scribo/filter/objects_on_border.hh +++ b/scribo/scribo/filter/objects_on_border.hh @@ -28,7 +28,7 @@ /// \file /// -/// Remove large objects in a binary image. +/// \brief Remove components located on image borders. # include <mln/core/concept/image.hh> @@ -55,13 +55,15 @@ namespace scribo using namespace mln; - /// Remove too large components. + /// \brief Remove components located on image borders. /// /// \param[in] components An object image. - /// \param[in] max_size The maximum cardinality of an object. /// /// \return A component set with large components set to /// component::Ignored. + /// + /// \ingroup grpalgofiltercomp + // template <typename L> inline component_set<L> diff --git a/scribo/scribo/filter/objects_size_ratio.hh b/scribo/scribo/filter/objects_size_ratio.hh index 6edb35f..9efa8bf 100644 --- a/scribo/scribo/filter/objects_size_ratio.hh +++ b/scribo/scribo/filter/objects_size_ratio.hh @@ -1,5 +1,5 @@ -// 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. // @@ -50,6 +50,8 @@ namespace scribo /// /// If the height/width ratio is lower than min_size_ratio then /// the component is invalidated. + /// + /// \ingroup grpalgofiltercomp // template <typename L> component_set<L> diff --git a/scribo/scribo/filter/objects_small.hh b/scribo/scribo/filter/objects_small.hh index c18c86f..921aea2 100644 --- a/scribo/scribo/filter/objects_small.hh +++ b/scribo/scribo/filter/objects_small.hh @@ -1,5 +1,5 @@ -// 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. // @@ -29,7 +29,7 @@ /// \file /// -/// Remove small components in a binary image. +/// \brief Remove small components in a binary image. # include <mln/core/concept/image.hh> @@ -57,7 +57,8 @@ namespace scribo using namespace mln; - /// Remove small components in a binary image. + /// \brief Remove small components in a binary image. + /// /// Set to 'false' all the removed components. /// /// \param[in] input_ A binary image. @@ -66,6 +67,9 @@ namespace scribo /// \param[in] min_size The minimum cardinality of an object. /// /// \return A binary image without small components. + /// + /// \ingroup grpalgofiltercomp + // template <typename I, typename N, typename V> mln_concrete(I) components_small(const Image& input_, @@ -74,13 +78,16 @@ namespace scribo unsigned min_size); - /// Remove too small components. + /// \brief Remove too small components. /// /// \param[in] components An object image. /// \param[in] min_size The minimum cardinality of an object. /// /// \return A component set with small components set to /// component::Ignored. + /// + /// \ingroup grpalgofiltercomp + // template <typename L> component_set<L> components_small(const component_set<L>& components, diff --git a/scribo/scribo/filter/objects_thick.hh b/scribo/scribo/filter/objects_thick.hh index faf13e7..8c3a03b 100644 --- a/scribo/scribo/filter/objects_thick.hh +++ b/scribo/scribo/filter/objects_thick.hh @@ -1,5 +1,5 @@ -// 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. // @@ -29,7 +29,7 @@ /// \file /// -/// Remove too thick components. +/// \brief Remove too thick components. # include <mln/core/concept/image.hh> # include <mln/core/concept/neighborhood.hh> @@ -49,7 +49,7 @@ namespace scribo using namespace mln; - /// Remove components thicker or equal to \p max_thickness. + /// \brief Remove components thicker or equal to \p max_thickness. /// /// \param[in] input_ A binary image. /// \param[in] nbh_ A neighborhood used in labeling algorithms. @@ -57,6 +57,8 @@ namespace scribo /// \param[in] max_thickness The maximum thickness value. /// /// \result A binary image without thick components. + /// + /// \ingroup grpalgofiltercomp // template <typename I, typename N, typename V> inline @@ -67,12 +69,14 @@ namespace scribo unsigned max_thickness); - /// Remove components thicker or equal to \p max_thickness. + /// \brief Remove components thicker or equal to \p max_thickness. /// /// \param[in] components An object image. /// \param[in] max_thickness The maximum thickness value. /// /// \result An object image without too thick components. + /// + /// \ingroup grpalgofiltercomp // template <typename L> inline diff --git a/scribo/scribo/filter/objects_thin.hh b/scribo/scribo/filter/objects_thin.hh index f58d0db..d376856 100644 --- a/scribo/scribo/filter/objects_thin.hh +++ b/scribo/scribo/filter/objects_thin.hh @@ -1,5 +1,5 @@ -// 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. // @@ -29,7 +29,7 @@ /// \file /// -/// Remove too thin components. +/// \brief Remove too thin components. # include <mln/core/concept/image.hh> # include <mln/core/concept/neighborhood.hh> @@ -52,7 +52,7 @@ namespace scribo using namespace mln; - /// Remove components thinner or equal to \p min_thickness. + /// \brief Remove components thinner or equal to \p min_thickness. /// /// \param[in] input_ a binary image. /// \param[in] nbh_ a neighborhood used in labeling algorithms. @@ -60,6 +60,8 @@ namespace scribo /// \param[in] min_thickness the minimum thickness value. /// /// \result A binary image without thin components. + /// + /// \ingroup grpalgofiltercomp // template <typename I, typename N, typename V> inline @@ -69,12 +71,15 @@ namespace scribo const V& label_type, unsigned min_thickness); - /// Remove lines of text thinner or equal to \p min_thickness. + /// \brief Remove lines of text thinner or equal to \p + /// min_thickness. /// /// \param[in] components An object image. /// \param[in] min_thickness the minimum thickness value. /// /// \result An object image without too thin components. + /// + /// \ingroup grpalgofiltercomp // template <typename L> inline diff --git a/scribo/scribo/filter/objects_v_thick.hh b/scribo/scribo/filter/objects_v_thick.hh index ad1a4df..e9e85a1 100644 --- a/scribo/scribo/filter/objects_v_thick.hh +++ b/scribo/scribo/filter/objects_v_thick.hh @@ -29,7 +29,7 @@ /// \file /// -/// Remove too verticaly thick components. +/// \brief Remove too verticaly thick components. # include <mln/core/concept/image.hh> # include <mln/core/concept/neighborhood.hh> @@ -46,7 +46,8 @@ namespace scribo using namespace mln; - /// Remove components verticaly thicker or equal to \p max_thickness. + /// \brief Remove components verticaly thicker or equal to \p + /// max_thickness. /// /// \param[in] input_ A binary image. /// \param[in] nbh_ A neighborhood used in labeling algorithms. @@ -54,6 +55,8 @@ namespace scribo /// \param[in] max_thickness The maximum thickness value. /// /// \result A binary image without thick components. + /// + /// \ingroup grpalgofiltercomp // template <typename I, typename N, typename V> inline @@ -64,12 +67,15 @@ namespace scribo unsigned max_thickness); - /// Remove components verticaly thicker or equal to \p max_thickness. + /// \brief Remove components verticaly thicker or equal to \p + /// max_thickness. /// /// \param[in] comps A component set. /// \param[in] max_thickness The maximum thickness value. /// /// \result An object image without too thick components. + /// + /// \ingroup grpalgofiltercomp // template <typename L> inline diff --git a/scribo/scribo/filter/objects_v_thin.hh b/scribo/scribo/filter/objects_v_thin.hh index f2280eb..c5364b3 100644 --- a/scribo/scribo/filter/objects_v_thin.hh +++ b/scribo/scribo/filter/objects_v_thin.hh @@ -29,7 +29,7 @@ /// \file /// -/// Remove too thin components. +/// \brief Remove too thin components. # include <mln/core/concept/image.hh> # include <mln/core/concept/neighborhood.hh> @@ -46,34 +46,39 @@ namespace scribo using namespace mln; - /// Remove components thinner or equal to \p min_thinness. + /// \brief Remove components thinner or equal to \p min_thinness. /// - /// \param[in] input_ a binary image. - /// \param[in] nbh_ a neighborhood used in labeling algorithms. + /// \param[in] input a binary image. + /// \param[in] nbh a neighborhood used in labeling algorithms. /// \param[in] label_type the label type used for labeling. /// \param[in] min_thinness the minimum thinness value. /// /// \result A binary image without v_thin components. + /// + /// \ingroup grpalgofiltercomp // template <typename I, typename N, typename V> inline mln_concrete(I) - objects_v_thin(const Image& input_, - const Neighborhood<N>& nbh_, + objects_v_thin(const Image& input, + const Neighborhood<N>& nbh, const V& label_type, unsigned min_thinness); - /// Remove lines of text thinner or equal to \p min_thinness. + /// \brief Remove lines of text thinner or equal to \p + /// min_thinness. /// /// \param[in] comps A component set. /// \param[in] min_thinness the minimum thinness value. /// /// \result An object image without too thin vertical components. + /// + /// \ingroup grpalgofiltercomp // template <typename L> inline component_set<L> - components_v_thin(const component_set<L>& text, + components_v_thin(const component_set<L>& comps, unsigned min_thinness); diff --git a/scribo/scribo/filter/objects_with_holes.hh b/scribo/scribo/filter/objects_with_holes.hh index 09eaad5..83b9755 100644 --- a/scribo/scribo/filter/objects_with_holes.hh +++ b/scribo/scribo/filter/objects_with_holes.hh @@ -1,5 +1,5 @@ -// 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. // @@ -81,8 +81,17 @@ namespace scribo /*! \brief Remove components having a minimum number of holes. + \param[in] components A component set. + \param[in] min_holes_count If a component have at least \p + min_holes_count holes it is + invalidated. + \param[in] min_size The minimum hole area to take a hole into + account. + \return A component where the component having too much holes + are invalidated. + \ingroup grpalgofiltercomp */ template <typename L> component_set<L> @@ -90,7 +99,20 @@ namespace scribo unsigned min_holes_count, unsigned min_size); + /*! \brief Remove components having at least two holes. + This is a fastest version since it is optimized for 2 holes + detection. + + \param[in] components A component set. + \param[in] min_size The minimum hole area to take a hole into + account. + + \return A component where the component having at least two + holes are invalidated. + + \ingroup grpalgofiltercomp + */ template <typename L> inline component_set<L> diff --git a/scribo/scribo/filter/paragraphs_bbox_overlap.hh b/scribo/scribo/filter/paragraphs_bbox_overlap.hh index 1cf9793..744b1ee 100644 --- a/scribo/scribo/filter/paragraphs_bbox_overlap.hh +++ b/scribo/scribo/filter/paragraphs_bbox_overlap.hh @@ -28,8 +28,8 @@ /// \file /// -/// Remove invalid paragraphs. -/// \fixme Share same test canvas as text::merging. +/// \brief Remove invalid paragraphs. +/// \todo Share same test canvas as text::merging. # include <mln/core/concept/image.hh> @@ -52,12 +52,15 @@ namespace scribo using namespace mln; - /// Remove invalid paragraphs. + /// \brief Remove invalid paragraphs. /// - /// \param[in] paragraphs A paragraph set. + /// \param[in] parset A paragraph set. /// /// \return A paragraph set with invalid paragraphs tag set to /// Paragraph::Ignored. + /// + /// \ingroup grpalgofilterpar + // template <typename L> paragraph_set<L> paragraphs_bbox_overlap(const paragraph_set<L>& parset); diff --git a/scribo/scribo/filter/paragraphs_in_borders.hh b/scribo/scribo/filter/paragraphs_in_borders.hh index 8953282..c3b9623 100644 --- a/scribo/scribo/filter/paragraphs_in_borders.hh +++ b/scribo/scribo/filter/paragraphs_in_borders.hh @@ -28,8 +28,8 @@ /// \file /// -/// Invalidate false positive paragraphs. -/// \fixme Share same test canvas as text::merging. +/// \brief Invalidate false positive paragraphs. +/// \todo Share same test canvas as text::merging. # include <mln/core/concept/image.hh> @@ -46,7 +46,7 @@ namespace scribo using namespace mln; - /// Invalidate paragraphs located close to the image borders. + /// \brief Invalidate paragraphs located close to the image borders. /// /// \param[in,out] doc A document structure. /// @@ -66,6 +66,8 @@ namespace scribo /// ----------- /// /// \endverbatim + /// + /// \ingroup grpalgofilterpar // template <typename L> void diff --git a/scribo/scribo/filter/paragraphs_in_image.hh b/scribo/scribo/filter/paragraphs_in_image.hh index be15b06..d95864d 100644 --- a/scribo/scribo/filter/paragraphs_in_image.hh +++ b/scribo/scribo/filter/paragraphs_in_image.hh @@ -28,8 +28,8 @@ /// \file /// -/// Remove invalid paragraphs. -/// \fixme Share same test canvas as text::merging. +/// \brief Remove invalid paragraphs. +/// \todo Share same test canvas as text::merging. # include <mln/core/concept/image.hh> @@ -59,12 +59,15 @@ namespace scribo using namespace mln; - /// Remove invalid paragraphs. + /// \brief Remove invalid paragraphs. /// - /// \param[in] paragraphs A paragraph set. + /// \param[in,out] doc A document structure. /// /// \return A paragraph set with invalid paragraphs tag set to /// Paragraph::Ignored. + /// + /// \ingroup grpalgofilterpar + // template <typename L> void paragraphs_in_image(document<L>& doc); diff --git a/scribo/scribo/filter/separators_in_borders.hh b/scribo/scribo/filter/separators_in_borders.hh index 8ccb6b1..f5048d2 100644 --- a/scribo/scribo/filter/separators_in_borders.hh +++ b/scribo/scribo/filter/separators_in_borders.hh @@ -28,8 +28,8 @@ /// \file /// -/// Invalidate false positive separators. -/// \fixme Share same test canvas as text::merging. +/// \brief Invalidate false positive separators. +/// \todo Share same test canvas as text::merging. # include <mln/core/concept/image.hh> @@ -46,9 +46,16 @@ namespace scribo using namespace mln; - /// Invalidate separators located close to the image borders. + /// \brief Invalidate separators located close to the image + /// borders. /// /// \param[in,out] doc A document structure. + /// \param[in] vratio Ratio to be used for evaluating the inner + /// border size in which vertical separators + /// will be invalidated. + /// \param[in] hratio Ratio to be used for evaluating the inner + /// border size in which horizontal separators + /// will be invalidated. /// /// Warning: it does not remove separators from separator /// image. It only invalidate separator components in their @@ -66,6 +73,8 @@ namespace scribo /// ----------- /// /// \endverbatim + /// + /// \ingroup grpalgofilterelt // template <typename L> void diff --git a/scribo/scribo/filter/separators_in_element.hh b/scribo/scribo/filter/separators_in_element.hh index 7e8a437..d4f587b 100644 --- a/scribo/scribo/filter/separators_in_element.hh +++ b/scribo/scribo/filter/separators_in_element.hh @@ -28,8 +28,8 @@ /// \file /// -/// Invalidate false positive separators. -/// \fixme Share same test canvas as text::merging. +/// \brief Invalidate false positive separators. +/// \todo Share same test canvas as text::merging. # include <mln/core/concept/image.hh> @@ -47,16 +47,16 @@ namespace scribo using namespace mln; - /// Invalidate false positive separators. + /// \brief Invalidate false positive separators. /// - /// \param[in] separators A paragraph set. - /// - /// \return A doc with invalidated separators. + /// \param[in,out] doc A document structure. /// /// Warning: it does not remove separators from separator /// image. It only invalidate separator components in their /// respective component_set. /// + /// \ingroup grpalgofilterelt + // template <typename L> void separators_in_element(document<L>& doc); diff --git a/scribo/scribo/filter/separators_in_paragraph.hh b/scribo/scribo/filter/separators_in_paragraph.hh index ac399c3..eae12e9 100644 --- a/scribo/scribo/filter/separators_in_paragraph.hh +++ b/scribo/scribo/filter/separators_in_paragraph.hh @@ -28,8 +28,8 @@ /// \file /// -/// Invalidate false positive separators. -/// \fixme Share same test canvas as text::merging. +/// \brief Invalidate false positive separators. +/// \todo Share same test canvas as text::merging. # include <mln/core/concept/image.hh> @@ -47,26 +47,32 @@ namespace scribo using namespace mln; - /// Invalidate false positive separators. + /// \brief Invalidate false positive separators. /// - /// \param[in] separators A paragraph set. - /// - /// \return A doc with invalidated separators. + /// \param[in,out] doc A document structure. + /// \param[in] hmin_size Minimum width of a line to be considered + /// as separators. + /// \param[in] vmin_size Minimum height of a line to be considered + /// as separators. /// /// Warning: it does not remove separators from separator /// image. It only invalidate separator components in their /// respective component_set. /// + /// \ingroup grpalgofilterelt + // template <typename L> void - separators_in_paragraph(document<L>& doc, unsigned hmax_size, unsigned vmax_size); + separators_in_paragraph(document<L>& doc, + unsigned hmin_size, unsigned vmin_size); # ifndef MLN_INCLUDE_ONLY template <typename L> void - separators_in_paragraph(document<L>& doc, unsigned hmax_size, unsigned vmax_size) + separators_in_paragraph(document<L>& doc, + unsigned hmin_size, unsigned vmin_size) { trace::entering("scribo::filter::separators_in_paragraph"); @@ -106,7 +112,7 @@ namespace scribo // This separator is included in an element (picture, drawing...) // => Ignore it. if (tl && tr && ml && mc && mr && bl && br - && hline(c).bbox().width() < hmax_size) + && hline(c).bbox().width() < hmin_size) hline(c).update_tag(component::Ignored); } @@ -135,7 +141,7 @@ namespace scribo // This separator is included in an element (picture, drawing...) // => Ignore it. if (tl && tr && ml && mc && mr && bl && br - && vline(c).bbox().height() < vmax_size) + && vline(c).bbox().height() < vmin_size) vline(c).update_tag(component::Ignored); } diff --git a/scribo/scribo/filter/separators_vert_in_borders.hh b/scribo/scribo/filter/separators_vert_in_borders.hh index 4a9e806..4f7c070 100644 --- a/scribo/scribo/filter/separators_vert_in_borders.hh +++ b/scribo/scribo/filter/separators_vert_in_borders.hh @@ -28,8 +28,9 @@ /// \file /// -/// Invalidate false positive separators. -/// \fixme Share same test canvas as text::merging. +/// \brief Invalidate vertical separators located close to the image +/// borders. +/// \todo Share same test canvas as text::merging. # include <mln/core/concept/image.hh> @@ -47,7 +48,8 @@ namespace scribo using namespace mln; - /// Invalidate separators located close to the image borders. + /// \brief Invalidate vertical separators located close to the image + /// borders. /// /// \param[in,out] doc A document structure. /// @@ -67,6 +69,8 @@ namespace scribo /// ----------- /// /// \endverbatim + /// + /// \ingroup grpalgofilterelt // template <typename L> void diff --git a/scribo/scribo/fun/v2b/objects_on_border_filter.hh b/scribo/scribo/fun/v2b/objects_on_border_filter.hh index e6f1738..60655ae 100644 --- a/scribo/scribo/fun/v2b/objects_on_border_filter.hh +++ b/scribo/scribo/fun/v2b/objects_on_border_filter.hh @@ -28,7 +28,7 @@ /// \file /// -/// Remove large components in a binary image. +/// \brief Remove components in image inner border. @@ -66,14 +66,13 @@ namespace scribo /// Constructor /// /// \param[in] components Component bounding boxes. - /// \param[in] max_size Maximum component size. // components_on_border_filter(const component_set<L>& components); /// Check if the component is large enough. /// - /// \param l A label. + /// \param[in] l A label. /// /// \return false if the component area is strictly inferion to /// \p max_size_. diff --git a/scribo/scribo/postprocessing/images_to_drop_capital.hh b/scribo/scribo/postprocessing/images_to_drop_capital.hh index f7d18a6..727f23c 100644 --- a/scribo/scribo/postprocessing/images_to_drop_capital.hh +++ b/scribo/scribo/postprocessing/images_to_drop_capital.hh @@ -28,8 +28,8 @@ /// \file /// -/// Set type for specific images to Drop Capital component. -/// \fixme Share same test canvas as text::merging. +/// \brief Set type for specific images to Drop Capital component. +/// \todo Share same test canvas as text::merging. # include <mln/core/concept/image.hh> @@ -47,12 +47,10 @@ namespace scribo using namespace mln; - /// Set type for specific images to Drop Capital component. + /// \brief Set type for specific images to Drop Capital component. /// - /// \param[in] separators A paragraph set. + /// \param[in] doc A document structure. /// - /// \return A doc with images tagged as dropped capital is such - /// images have been found. // template <typename L> void diff --git a/scribo/scribo/preprocessing/denoise.hh b/scribo/scribo/preprocessing/denoise.hh index 1877c06..115ac1d 100644 --- a/scribo/scribo/preprocessing/denoise.hh +++ b/scribo/scribo/preprocessing/denoise.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2010 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2010, 2011 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -48,10 +49,12 @@ namespace scribo /// \param[in] input A binary image. True for objects, False for /// background. /// \param[in] nbh Neighborhood to use for denoising. - /// \param[in] min_card Minimum component cardinality to not be - /// considered as noise. + /// \param[in] fg_min_card Minimum component cardinality to not be + /// considered as noise in the foreground. + /// \param[in] bg_min_card Minimum component cardinality to not be + /// considered as noise in the foreground. /// - /// \output A binary image with the same domain as \p input. All + /// \return A binary image with the same domain as \p input. All /// small components have been removed. // template <typename I, typename N> diff --git a/scribo/scribo/preprocessing/denoise_bg.hh b/scribo/scribo/preprocessing/denoise_bg.hh index eda3803..1c02f8e 100644 --- a/scribo/scribo/preprocessing/denoise_bg.hh +++ b/scribo/scribo/preprocessing/denoise_bg.hh @@ -29,7 +29,7 @@ /// \file /// -/// Denoise image background. +/// \brief Denoise image background. # include <mln/core/image/image2d.hh> # include <mln/core/concept/neighborhood.hh> @@ -57,7 +57,7 @@ namespace scribo using namespace mln; - /// Denoise image background. + /// \brief Denoise image background. /// /// \param[in] input A binary image. True for objects, False for /// background. @@ -65,7 +65,7 @@ namespace scribo /// \param[in] min_card Minimum component cardinality to not be /// considered as noise. /// - /// \output A binary image with the same domain as \p input. All + /// \return A binary image with the same domain as \p input. All /// small components have been removed and merged with the /// background. // diff --git a/scribo/scribo/preprocessing/denoise_fg.hh b/scribo/scribo/preprocessing/denoise_fg.hh index 9701d06..23b838e 100644 --- a/scribo/scribo/preprocessing/denoise_fg.hh +++ b/scribo/scribo/preprocessing/denoise_fg.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2010 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2010, 2011 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -28,7 +29,7 @@ /// \file /// -/// Denoise image foreground. +/// \brief Denoise image foreground. # include <mln/core/image/image2d.hh> # include <mln/core/concept/neighborhood.hh> @@ -56,7 +57,7 @@ namespace scribo using namespace mln; - /// Denoise image foreground. + /// \brief Denoise image foreground. /// /// \param[in] input A binary image. True for objects, False for /// background. @@ -64,7 +65,7 @@ namespace scribo /// \param[in] min_card Minimum component cardinality to not be /// considered as noise. /// - /// \output A binary image with the same domain as \p input. All + /// \return A binary image with the same domain as \p input. All /// small components have been removed and merged with the /// background. // diff --git a/scribo/scribo/preprocessing/deskew_crop.hh b/scribo/scribo/preprocessing/deskew_crop.hh index 988e803..2f35932 100644 --- a/scribo/scribo/preprocessing/deskew_crop.hh +++ b/scribo/scribo/preprocessing/deskew_crop.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2010 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2010, 2011 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -40,16 +41,14 @@ namespace scribo /*! \brief Deskew a region of interest. - \param[in] input_bin A binary image. - \param[in] input_gray A gray-level image. + \param[in] crop_gl A gray-level image. + \param[in] input_gl A gray-level image. \return A deskewed binary image. - - Handles skew angles from -25 to +25 degrees. - \p input_bin and \p input_gray must be 2D images and must be + \p crop_gl and \p input_gl must be 2D images and must be identical (e.g. only the value differs). This algorithm is designed for images created from a region of @@ -58,7 +57,7 @@ namespace scribo */ template <typename I, typename J> mln_concrete(I) - deskew(const Image& crop_gl_, const Image& input_gl_); + deskew(const Image& crop_gl, const Image& input_gl); # ifndef MLN_INCLUDE_ONLY diff --git a/scribo/scribo/preprocessing/homogeneous_contrast.hh b/scribo/scribo/preprocessing/homogeneous_contrast.hh index 82b2ac6..b510ecd 100644 --- a/scribo/scribo/preprocessing/homogeneous_contrast.hh +++ b/scribo/scribo/preprocessing/homogeneous_contrast.hh @@ -52,14 +52,14 @@ namespace scribo /// \param[in] input A gray-level image. /// \param[in] h Height attribute value for leveling closing. /// - /// \output A gray-level image with better contrast homogeneity. + /// \return A gray-level image with better contrast homogeneity. // template <typename I> mln_concrete(I) homogeneous_contrast(const Image& input, unsigned h); - /// \overload. + /// \overload /// Default height attribute value is set to 75. // template <typename I> diff --git a/scribo/scribo/preprocessing/split_bg_fg.hh b/scribo/scribo/preprocessing/split_bg_fg.hh index e1fae7d..b35d04c 100644 --- a/scribo/scribo/preprocessing/split_bg_fg.hh +++ b/scribo/scribo/preprocessing/split_bg_fg.hh @@ -1,5 +1,5 @@ -// 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. // @@ -30,7 +30,7 @@ /// \file /// -/// Split the background and the foreground. +/// \brief Split the background and the foreground. # include <mln/core/macros.hh> # include <mln/core/image/image2d.hh> @@ -89,7 +89,7 @@ namespace scribo */ template <typename I> mln::util::couple<mln_concrete(I), mln_concrete(I)> - split_bg_fg(const Image& input_, unsigned lambda, unsigned delta); + split_bg_fg(const Image& input, unsigned lambda, unsigned delta); diff --git a/scribo/scribo/primitive/extract/alignments.hh b/scribo/scribo/primitive/extract/alignments.hh index b2c7c0c..32285ea 100644 --- a/scribo/scribo/primitive/extract/alignments.hh +++ b/scribo/scribo/primitive/extract/alignments.hh @@ -26,6 +26,10 @@ #ifndef SCRIBO_PRIMITIVE_EXTRACT_ALIGNMENTS_HH # define SCRIBO_PRIMITIVE_EXTRACT_ALIGNMENTS_HH +/// \file +/// +/// + # include <iostream> # include <mln/core/image/image2d.hh> @@ -112,21 +116,24 @@ namespace scribo This method handles skewed alignments and draw skew lines if possible. Examples : + \verbatim |x |x | x \x | x -> \x | x \x + \endverbatim - - \fixme Because the first link step at step 2.a check aligment + \todo Because the first link step at step 2.a check aligment between only 2 components and not the whole group, we may retrieve alignment patterns such this one : + \verbatim |x | x | x | x |x + \endverbatim Here, the 'x' are aligned pair by pair but globally they are not. Here we cannot draw skewed lines without processing every @@ -137,12 +144,13 @@ namespace scribo with that line. Here, we would like to split links/alignement in two groups in order to get something like that : + \verbatim \x \x \x /x /x - + \endverbatim \param[in] doc A document information with text lines. diff --git a/scribo/scribo/primitive/extract/cells.hh b/scribo/scribo/primitive/extract/cells.hh index 08b3fd6..4ae3e49 100644 --- a/scribo/scribo/primitive/extract/cells.hh +++ b/scribo/scribo/primitive/extract/cells.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2011 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -60,19 +61,20 @@ namespace scribo using namespace mln; - /// Extract canvas cells from a binary image. + /// \brief Extract canvas cells from a binary image. /// Use arbitrary criterions. /// - /// \param[in] input_ A binary image. - /// \param[in,out] ncells Will store the number of cells found. + /// \param[in] input A binary image. + /// \param[in] nbh A neighborhood. + /// \param[in,out] label_type Type of the labeled image. /// /// \return A list of cell bounding boxes. // template <typename I, typename N, typename V> mln::util::couple<mln::util::array<box<mln_site(I)> >, mln::util::array<box<mln_site(I)> > > - cells(const Image& input_, - const Neighborhood<N>& nbh_, const V& label_type); + cells(const Image& input, + const Neighborhood<N>& nbh, const V& label_type); # ifndef MLN_INCLUDE_ONLY diff --git a/scribo/scribo/primitive/extract/components.hh b/scribo/scribo/primitive/extract/components.hh index fe2b523..851193e 100644 --- a/scribo/scribo/primitive/extract/components.hh +++ b/scribo/scribo/primitive/extract/components.hh @@ -29,7 +29,7 @@ /// \file /// -/// Extract components in a binary image. +/// \brief Extract components in a binary image. # include <mln/core/concept/neighborhood.hh> @@ -63,10 +63,10 @@ namespace scribo using namespace mln; - /// Extract components in a binary image. + /// \brief Extract components in a binary image. /// - /// \param[in] input A binary image. Components are must be set - /// to 'true' + /// \param[in] input A RGB image. + /// \param[in] binary_input A binary image. Components must be set to 'True'. /// and background to 'false'. /// \param[in] nbh A neighborhood to be used for labeling. /// \param[in,out] ncomponents Will store the numbers of components found. diff --git a/scribo/scribo/primitive/extract/lines_h_single.hh b/scribo/scribo/primitive/extract/lines_h_single.hh index 1bff2f4..7c9e556 100644 --- a/scribo/scribo/primitive/extract/lines_h_single.hh +++ b/scribo/scribo/primitive/extract/lines_h_single.hh @@ -1,5 +1,5 @@ -// 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. // @@ -29,7 +29,7 @@ /// \file /// -/// Fast Extraction of single horizontal thick lines. +/// \brief Fast Extraction of single horizontal thick lines. # include <mln/core/concept/image.hh> # include <mln/core/concept/neighborhood.hh> @@ -50,16 +50,16 @@ namespace scribo using namespace mln; - /// Fast Extraction of single horizontal thick lines. - /*! + /*! \brief Fast Extraction of single horizontal thick lines. + * * Only single non discontinued lines are correctly extracted * with this routine. * - * \param[in] input_ A binary image. - * \param[in] nbh_ The neighborhood used for labeling image + * \param[in] input A binary image. + * \param[in] nbh The neighborhood used for labeling image * components. * \param[in,out] nlines Type used for labeling. - * \param[in] line_length The minimum line length. + * \param[in] min_line_length The minimum line length. * \param[in] w_h_ratio The minimum ratio width/height object * bounding boxes to consider an * object as a single line. @@ -75,13 +75,13 @@ namespace scribo float w_h_ratio); - /// Fast Extraction of single horizontal thick lines. - /*! + /*! \brief Fast Extraction of single horizontal thick lines. + * * Only single non discontinued lines are correctly extracted * with this routine. * * \param[in] components A labeled image. - * \param[in] line_length The minimum line length. + * \param[in] min_line_length The minimum line length. * \param[in] w_h_ratio The minimum ratio width/height object * bounding boxes to consider an * object as a single line. diff --git a/scribo/scribo/primitive/extract/lines_h_thick_and_single.hh b/scribo/scribo/primitive/extract/lines_h_thick_and_single.hh index dd495a4..d0db15d 100644 --- a/scribo/scribo/primitive/extract/lines_h_thick_and_single.hh +++ b/scribo/scribo/primitive/extract/lines_h_thick_and_single.hh @@ -1,5 +1,5 @@ -// 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. // @@ -29,7 +29,7 @@ /// \file /// -/// Extract horizontal thick lines in a binary image. +/// \brief Extract horizontal thick lines in a binary image. # include <mln/core/concept/image.hh> @@ -56,18 +56,19 @@ namespace scribo using namespace mln; - /// Extract horizontal thick lines in a binary image. - /*! + + /*! \brief Extract horizontal thick lines in a binary image. + * * Only non discontinued lines are correctly extracted with this * routine. Only lines matching the given criterions are kept * in the result. * - * \param[in] input_ A binary image. - * \param[in] nbh_ The neighborhood used for labeling image + * \param[in] input A binary image. + * \param[in] nbh The neighborhood used for labeling image * components. * \param[in,out] nlines Type used for labeling. - * \param[in] line_length The minimum line length. - * \param[in] w_h_ratio The minimum ratio width/height object + * \param[in] min_line_length The minimum line length. + * \param[in] h_w_ratio The minimum ratio width/height object * bounding boxes to consider an * object as a single line. * @@ -75,8 +76,8 @@ namespace scribo */ template <typename I, typename N, typename V> component_set<mln_ch_value(I,V)> - lines_h_thick_and_single(const Image& input_, - const Neighborhood<N>& nbh_, + lines_h_thick_and_single(const Image& input, + const Neighborhood<N>& nbh, V& nlines, unsigned min_line_length, float h_w_ratio); diff --git a/scribo/scribo/primitive/extract/lines_v_pattern.hh b/scribo/scribo/primitive/extract/lines_v_pattern.hh index 2908c8b..bf0b1c0 100644 --- a/scribo/scribo/primitive/extract/lines_v_pattern.hh +++ b/scribo/scribo/primitive/extract/lines_v_pattern.hh @@ -29,7 +29,7 @@ /// \file /// -/// Extract vertical lines matching a specific pattern. +/// \brief Extract vertical lines matching a specific pattern. # include <cmath> @@ -56,10 +56,12 @@ namespace scribo using namespace mln; - /// Extract vertical lines matching a specific pattern. + /// \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. // diff --git a/scribo/scribo/primitive/extract/lines_v_single.hh b/scribo/scribo/primitive/extract/lines_v_single.hh index 67b9f9d..317bf22 100644 --- a/scribo/scribo/primitive/extract/lines_v_single.hh +++ b/scribo/scribo/primitive/extract/lines_v_single.hh @@ -1,5 +1,5 @@ -// 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. // @@ -29,7 +29,7 @@ /// \file /// -/// Fast Extraction of single vertical thick lines. +/// \brief Fast Extraction of single vertical thick lines. # include <mln/core/concept/image.hh> # include <mln/core/concept/neighborhood.hh> @@ -49,16 +49,16 @@ namespace scribo using namespace mln; - /// Fast Extraction of single vertical thick lines. - /*! + /*! \brief Fast Extraction of single vertical thick lines. + * * Only single non discontinued lines are correctly extracted * with this routine. * - * \param[in] input_ A binary image. - * \param[in] nbh_ The neighborhood used for labeling image + * \param[in] input A binary image. + * \param[in] nbh The neighborhood used for labeling image * components. * \param[in,out] nlines Type used for labeling. - * \param[in] line_length The minimum line length. + * \param[in] min_line_length The minimum line length. * \param[in] h_w_ratio The minimum ratio height/width object * bounding boxes to consider an * object as a single line. @@ -74,13 +74,13 @@ namespace scribo float h_w_ratio); - /// Fast Extraction of single vertical thick lines. - /*! + /*! \brief Fast Extraction of single vertical thick lines. + * * Only single non discontinued lines are correctly extracted * with this routine. * * \param[in] components A labeled image. - * \param[in] line_length The minimum line length. + * \param[in] min_line_length The minimum line length. * \param[in] h_w_ratio The minimum ratio height/width object * bounding boxes to consider an * object as a single line. diff --git a/scribo/scribo/primitive/extract/lines_v_thick_and_single.hh b/scribo/scribo/primitive/extract/lines_v_thick_and_single.hh index 44f7a9e..c3719cf 100644 --- a/scribo/scribo/primitive/extract/lines_v_thick_and_single.hh +++ b/scribo/scribo/primitive/extract/lines_v_thick_and_single.hh @@ -1,5 +1,5 @@ -// 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. // @@ -29,7 +29,7 @@ /// \file /// -/// Extract vertical thick lines in a binary image. +/// \brief Extract vertical thick lines in a binary image. # include <mln/core/concept/image.hh> @@ -55,17 +55,17 @@ namespace scribo using namespace mln; - /// Extract vertical thick lines in a binary image. - /*! + /*! \brief Extract vertical thick lines in a binary image. + * * Only non discontinued lines are correctly extracted with this * routine. Only lines matching the given criterions are kept * in the result. * - * \param[in] input_ A binary image. - * \param[in] nbh_ The neighborhood used for labeling image + * \param[in] input A binary image. + * \param[in] nbh The neighborhood used for labeling image * components. * \param[in,out] nlines Type used for labeling. - * \param[in] line_length The minimum line length. + * \param[in] min_line_length The minimum line length. * \param[in] h_w_ratio The minimum ratio height/width object * bounding boxes to consider an * object as a single line. @@ -74,8 +74,8 @@ namespace scribo */ template <typename I, typename N, typename V> component_set<mln_ch_value(I,V)> - lines_v_thick_and_single(const Image& input_, - const Neighborhood<N>& nbh_, + lines_v_thick_and_single(const Image& input, + const Neighborhood<N>& nbh, V& nlines, unsigned min_line_length, float h_w_ratio); diff --git a/scribo/scribo/primitive/group/from_double_link.hh b/scribo/scribo/primitive/group/from_double_link.hh index 260bfea..a4d97de 100644 --- a/scribo/scribo/primitive/group/from_double_link.hh +++ b/scribo/scribo/primitive/group/from_double_link.hh @@ -62,7 +62,6 @@ namespace scribo validate These links. A link must exist in both ways to be validated. - \param[in] components A component set. \param[in] left_link The left neighbor of each line of text. \param[in] right_link The right neighbor of each line of text. diff --git a/scribo/scribo/primitive/identify.hh b/scribo/scribo/primitive/identify.hh index 6aa6ad3..f4e115b 100644 --- a/scribo/scribo/primitive/identify.hh +++ b/scribo/scribo/primitive/identify.hh @@ -28,7 +28,7 @@ /*! \brief try to determine the type of a component. -\fixme Write it and add support for component type (graphic, images, +\todo Write it and add support for component type (graphic, images, ...) */ diff --git a/scribo/scribo/primitive/link/compute.hh b/scribo/scribo/primitive/link/compute.hh index 114971f..8c64171 100644 --- a/scribo/scribo/primitive/link/compute.hh +++ b/scribo/scribo/primitive/link/compute.hh @@ -1,5 +1,5 @@ -// 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. // @@ -50,6 +50,8 @@ namespace scribo /*! \brief Compute links between objects according a given functor. \param[in,out] functor Linking policy. + \param[in] anchor Lookup anchor. Starts looking for + neighbors from there. \return Object links. diff --git a/scribo/scribo/primitive/link/with_single_left_link.hh b/scribo/scribo/primitive/link/with_single_left_link.hh index cc94f93..c4b080f 100644 --- a/scribo/scribo/primitive/link/with_single_left_link.hh +++ b/scribo/scribo/primitive/link/with_single_left_link.hh @@ -1,5 +1,5 @@ -// 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. // @@ -29,7 +29,7 @@ /// \file /// -/// Link text components with their left neighbor. +/// \brief Link text components with their left neighbor. # include <mln/core/concept/image.hh> # include <mln/core/concept/neighborhood.hh> @@ -65,7 +65,8 @@ namespace scribo /// \brief Link components with their left neighbor if exists. /// /// \param[in] components A component set. - /// \param[in] The maximum distance allowed to seach a neighbor object. + /// \param[in] neighb_max_distance The maximum distance allowed + /// to seach a neighbor object. /// /// \return Object links data. // @@ -78,6 +79,7 @@ namespace scribo /// \overload /// Max distance is set to mln_max(unsigned). + // template <typename L> inline object_links<L> diff --git a/scribo/scribo/primitive/link/with_single_left_link_dmax_ratio_aligned.hh b/scribo/scribo/primitive/link/with_single_left_link_dmax_ratio_aligned.hh index 146ae17..9fdae67 100644 --- a/scribo/scribo/primitive/link/with_single_left_link_dmax_ratio_aligned.hh +++ b/scribo/scribo/primitive/link/with_single_left_link_dmax_ratio_aligned.hh @@ -29,8 +29,8 @@ /// \file /// -/// Link text objects with their left neighbor according to a maximum -/// distance. +/// \brief Link text objects with their left neighbor according to a +/// maximum distance. # include <mln/core/concept/image.hh> # include <mln/core/concept/neighborhood.hh> @@ -67,6 +67,10 @@ namespace scribo \param[in] components A component set. \param[in] dmax_ratio Size ratio defining the maximum lookup distance. + \param[in] min_angle Minimum difference allowed for + alignement angle. + \param[in] max_angle Maximum difference allowed for + alignement angle. \param[in] anchor Starting point for the neighbor lookup. \return Object links data. @@ -90,6 +94,7 @@ namespace scribo /// \overload /// anchor is set to MassCenter. + // template <typename L> inline object_links<L> @@ -102,6 +107,7 @@ namespace scribo /// \overload /// dmax_ratio is set to 3. /// anchor is set to MassCenter. + // template <typename L> inline object_links<L> diff --git a/scribo/scribo/primitive/link/with_single_right_link.hh b/scribo/scribo/primitive/link/with_single_right_link.hh index bc7942b..60bb4d1 100644 --- a/scribo/scribo/primitive/link/with_single_right_link.hh +++ b/scribo/scribo/primitive/link/with_single_right_link.hh @@ -29,7 +29,7 @@ /// \file /// -/// Link components with their right neighbor. +/// \brief Link components with their right neighbor. # include <mln/core/concept/image.hh> @@ -64,7 +64,10 @@ namespace scribo /// Lookup startup point is the object mass center. /// /// \param[in] components An object image. - /// \param[in] The maximum distance allowed to seach a neighbor object. + /// \param[in] neighb_max_distance The maximum distance allowed + /// to seach a neighbor object. + /// \param[in] anchor Anchor from where the neighbor lookup is + /// performed. /// /// \return Object links data. // @@ -78,6 +81,7 @@ namespace scribo /// \overload /// Max distance is set to mln_max(unsigned). + // template <typename L> inline object_links<L> diff --git a/scribo/scribo/primitive/link/with_single_right_link_bottom.hh b/scribo/scribo/primitive/link/with_single_right_link_bottom.hh index 85f6b50..9b76919 100644 --- a/scribo/scribo/primitive/link/with_single_right_link_bottom.hh +++ b/scribo/scribo/primitive/link/with_single_right_link_bottom.hh @@ -1,5 +1,5 @@ -// 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. // @@ -29,7 +29,7 @@ /// \file /// -/// Link text components with their right neighbor. +/// \brief Link text components with their right neighbor. # include <mln/core/concept/image.hh> @@ -63,7 +63,8 @@ namespace scribo /// Lookup startup point is the object bottom center. /// /// \param[in] components A component set. - /// \param[in] The maximum distance allowed to seach a neighbor object. + /// \param[in] neighb_max_distance The maximum distance allowed + /// to seach a neighbor object. /// /// \return Object links data. // @@ -76,6 +77,7 @@ namespace scribo /// \overload /// Max distance is set to mln_max(unsigned). + // template <typename L> inline object_links<L> diff --git a/scribo/scribo/primitive/link/with_single_right_link_dmax_ratio_aligned.hh b/scribo/scribo/primitive/link/with_single_right_link_dmax_ratio_aligned.hh index dcf804e..f7ed41e 100644 --- a/scribo/scribo/primitive/link/with_single_right_link_dmax_ratio_aligned.hh +++ b/scribo/scribo/primitive/link/with_single_right_link_dmax_ratio_aligned.hh @@ -29,8 +29,8 @@ /// \file /// -/// Link text objects with their right neighbor according to a maximum -/// distance. +/// \brief Link text objects with their right neighbor according to a +/// maximum distance. # include <mln/core/concept/image.hh> # include <mln/core/concept/neighborhood.hh> @@ -67,6 +67,10 @@ namespace scribo \param[in] components A component set. \param[in] dmax_ratio Size ratio defining the maximum lookup distance. + \param[in] min_angle Minimum difference allowed for + alignement angle. + \param[in] max_angle Maximum difference allowed for + alignement angle. \param[in] anchor Starting point for the neighbor lookup. \return Object links data. diff --git a/scribo/scribo/primitive/link/with_single_right_link_top.hh b/scribo/scribo/primitive/link/with_single_right_link_top.hh index ada6650..c8008fc 100644 --- a/scribo/scribo/primitive/link/with_single_right_link_top.hh +++ b/scribo/scribo/primitive/link/with_single_right_link_top.hh @@ -29,7 +29,7 @@ /// \file /// -/// Link components with their right neighbor. +/// \brief Link components with their right neighbor. # include <mln/core/concept/image.hh> @@ -64,7 +64,8 @@ namespace scribo /// Lookup startup point is the object top center. /// /// \param[in] components A component set. - /// \param[in] The maximum distance allowed to seach a neighbor object. + /// \param[in] neighb_max_distance The maximum distance allowed + /// to seach a neighbor object. /// /// \return Object links data. // @@ -77,6 +78,7 @@ namespace scribo /// \overload /// Max distance is set to mln_max(unsigned). + // template <typename L> inline object_links<L> diff --git a/scribo/scribo/table/align_lines_horizontaly.hh b/scribo/scribo/table/align_lines_horizontaly.hh index 25e4036..38d14ec 100644 --- a/scribo/scribo/table/align_lines_horizontaly.hh +++ b/scribo/scribo/table/align_lines_horizontaly.hh @@ -1,5 +1,5 @@ -// 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. // @@ -55,13 +55,16 @@ namespace scribo /// /// \param[in] input Image from which the line bboxes are /// extracted from. - /// \param[in, out] line_bboxes horizontal lines bounding boxes. + /// \param[in] lines Component set corresponding to table lines. + /// \param[in,out] aligned_lines Component set where aligned table + /// lines are stored. /// \param[in] max_alignment_diff max space between two lines to /// consider they are potentialy on the /// same line. /// /// \return A list of the resulting aligned rows. Each integer is actually /// a row number. + // template <typename I, typename L> mln::util::array<int> align_lines_horizontaly(const Image& input, diff --git a/scribo/scribo/table/rebuild.hh b/scribo/scribo/table/rebuild.hh index f593153..e433390 100644 --- a/scribo/scribo/table/rebuild.hh +++ b/scribo/scribo/table/rebuild.hh @@ -1,5 +1,5 @@ -// 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. // @@ -29,7 +29,7 @@ /// \file /// -/// Rebuild a table from its line bounding boxes. +/// \brief Rebuild a table from its line bounding boxes. # include <mln/core/concept/image.hh> # include <mln/core/alias/neighb2d.hh> @@ -57,11 +57,13 @@ namespace scribo { - /// Rebuild a table from its line bounding boxes. - /*! - ** \param[in] input_ A binary image. - ** \param[in] linebboxes_ A couple of vertical and horizontal - ** line bounding boxes. + /*! \brief Rebuild a table from its line bounding boxes. + ** + ** \param[in] input A binary image. + ** \param[in] vlines Component set corresponding to vertical + ** lines. + ** \param[in] hlines Component set corresponding to horizontal + ** lines. ** \param[in] max_dist_lines The maximum distance allowed between ** vertical and horizontal lines to connect ** them eachother. @@ -76,7 +78,7 @@ namespace scribo mln::util::couple<L, mln::util::couple<component_set<L>, component_set<L> > > - rebuild(const Image& input_, + rebuild(const Image& input, const component_set<L>& vlines, const component_set<L>& hlines, unsigned max_dist_lines, diff --git a/scribo/scribo/text/extract_lines.hh b/scribo/scribo/text/extract_lines.hh index 3e9254a..685079c 100644 --- a/scribo/scribo/text/extract_lines.hh +++ b/scribo/scribo/text/extract_lines.hh @@ -29,7 +29,7 @@ /// \file /// -/// Extract line of text bounding boxes. +/// \brief Extract line of text bounding boxes. # include <mln/core/concept/image.hh> @@ -62,17 +62,17 @@ namespace scribo using namespace mln; - /// Extract lines of text in a binary image. - /*! + /*! \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] seps A binary image with separator information. + ** \param[in] separators A binary image with separator information. ** ** \return A set of lines. */ template <typename I, typename N> line_set<mln_ch_value(I,scribo::def::lbl_type)> - extract_lines(const Image& input_, const Neighborhood<N>& nbh_, + extract_lines(const Image& input, const Neighborhood<N>& nbh, const mln_ch_value(I,bool)& separators); /// \overload diff --git a/scribo/scribo/text/extract_lines_wo_merge.hh b/scribo/scribo/text/extract_lines_wo_merge.hh index 0d90600..ea9e6cf 100644 --- a/scribo/scribo/text/extract_lines_wo_merge.hh +++ b/scribo/scribo/text/extract_lines_wo_merge.hh @@ -28,7 +28,7 @@ /// \file /// -/// Extract line of text bounding boxes. +/// \brief Extract line of text bounding boxes. # include <mln/core/concept/image.hh> @@ -62,17 +62,17 @@ namespace scribo using namespace mln; - /// Extract lines of text in a binary image. + /// \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] seps A binary image with separator information. + ** \param[in] separators A binary image with separator information. ** ** \return A set of lines. */ template <typename I, typename N> line_set<mln_ch_value(I,scribo::def::lbl_type)> - extract_lines_wo_merge(const Image& input_, const Neighborhood<N>& nbh_, + extract_lines_wo_merge(const Image& input, const Neighborhood<N>& nbh, const mln_ch_value(I,bool)& separators); /// \overload diff --git a/scribo/scribo/text/recognition.hh b/scribo/scribo/text/recognition.hh index 1e11a3e..5e0e7ab 100644 --- a/scribo/scribo/text/recognition.hh +++ b/scribo/scribo/text/recognition.hh @@ -29,7 +29,7 @@ /// \file /// -/// Passes the text bounding boxes to an OCR (Tesseract). +/// \brief Recognize text using an OCR (Tesseract). /// /// \todo For each text bbox, we create a new image. We may like to avoid that. /// \todo Do not store the result in an image? @@ -75,20 +75,25 @@ namespace scribo using namespace mln; - /// Passes the text bboxes to Tesseract (OCR). + /// \brief Passes the text bboxes to Tesseract (OCR). /// /// \param[in] lines The lines of text. /// \param[in] language The language which should be recognized by /// Tesseract. (fra, en, ...) - /// \param[in] output_file If set, store the recognized text in - /// this file. // template <typename L> void recognition(line_set<L>& lines, const char *language); - /// Recognize text from an image. + /// \brief Recognize text from an image. + /// + /// \param[in] line Image of text line. + /// \param[in] language The language which should be recognized by + /// Tesseract. (fra, en, ...) + /// \param[in] output_file If set, store the recognized text in + /// this file. + // template <typename I> void recognition(const Image& line, diff --git a/scribo/scribo/toolchain/content_in_doc.hh b/scribo/scribo/toolchain/content_in_doc.hh index 0d3430e..5ef6aa8 100644 --- a/scribo/scribo/toolchain/content_in_doc.hh +++ b/scribo/scribo/toolchain/content_in_doc.hh @@ -28,7 +28,7 @@ /// \file /// -/// Analyse a document. +/// \brief Analyse and extract document image content. # include <scribo/toolchain/internal/content_in_doc_functor.hh> @@ -41,6 +41,27 @@ namespace scribo using namespace mln; + /*! \brief Analyse and extract document image content. + + \input[in] input A RGB image. + \input[in] input_preproc A Binary image. + \param[in] denoise Remove too small components (<= 2 pixels). + \param[in] find_line_seps Enable/Disable lookup for + vertical/horizontal separators. + \param[in] find_whitespace_seps Enable/Disable lookup for + vertical alignments and + whitespaces. Helps finding text + layout. + \param[in] enable_ocr Enable/Disable text recognition. + \param[in] language Main language used in the input + document. (OCR settings) + \param[in] verbose Enable/Disable debug information printed on + std::cout. + + \return A document structure. + + \ingroup grptoolchaindocproc + */ template <typename I, typename J> document<mln_ch_value(I, def::lbl_type)> content_in_doc(const Image& input, const Image<J>& input_preproc, diff --git a/scribo/scribo/toolchain/content_in_hdoc.hh b/scribo/scribo/toolchain/content_in_hdoc.hh index 97233d5..1ffff09 100644 --- a/scribo/scribo/toolchain/content_in_hdoc.hh +++ b/scribo/scribo/toolchain/content_in_hdoc.hh @@ -28,7 +28,7 @@ /// \file /// -/// Analyse a document. +/// \brief Analyse a historical/degraded document. # include <scribo/toolchain/internal/content_in_hdoc_functor.hh> @@ -40,7 +40,26 @@ namespace scribo using namespace mln; - + /*! \brief Analyse and extract content in a historical/degraded + document. + + \input[in] input A RGB image. + \input[in] input_preproc A Binary image. + \param[in] denoise Remove too small components (<= 2 pixels). + \param[in] find_line_seps Enable/Disable lookup for + vertical/horizontal separators. + \param[in] find_whitespace_seps Enable/Disable lookup for + vertical alignments and + whitespaces. Helps finding text + layout. + \param[in] enable_ocr Enable/Disable text recognition. + \param[in] language Main language used in the input + document. (OCR settings) + + \return A document structure. + + \ingroup grptoolchaindocproc + */ template <typename I, typename J> document<mln_ch_value(I, def::lbl_type)> content_in_hdoc(const Image& input, const Image<J>& input_preproc, diff --git a/scribo/scribo/toolchain/internal/content_in_doc_functor.hh b/scribo/scribo/toolchain/internal/content_in_doc_functor.hh index 448ec24..066168a 100644 --- a/scribo/scribo/toolchain/internal/content_in_doc_functor.hh +++ b/scribo/scribo/toolchain/internal/content_in_doc_functor.hh @@ -27,6 +27,10 @@ #ifndef SCRIBO_TOOLCHAIN_INTERNAL_CONTENT_IN_DOC_FUNCTOR_HH # define SCRIBO_TOOLCHAIN_INTERNAL_CONTENT_IN_DOC_FUNCTOR_HH +/// \file +/// +/// \brief Functor analysing and extracting document image content. + # ifndef SCRIBO_NDEBUG # include <mln/util/timer.hh> # endif // ! SCRIBO_NDEBUG @@ -92,7 +96,9 @@ namespace scribo namespace internal { + /*! \brief Functor analysing and extracting document image content. + */ template <typename I> struct content_in_doc_functor : public Toolchain_Functor diff --git a/scribo/scribo/toolchain/internal/content_in_hdoc_functor.hh b/scribo/scribo/toolchain/internal/content_in_hdoc_functor.hh index bda31b3..4ffc9a7 100644 --- a/scribo/scribo/toolchain/internal/content_in_hdoc_functor.hh +++ b/scribo/scribo/toolchain/internal/content_in_hdoc_functor.hh @@ -27,6 +27,12 @@ #ifndef SCRIBO_TOOLCHAIN_INTERNAL_CONTENT_IN_HDOC_FUNCTOR_HH # define SCRIBO_TOOLCHAIN_INTERNAL_CONTENT_IN_HDOC_FUNCTOR_HH +/// \file +/// +/// \brief Functor analysing and extracting content in +/// degraded/historical documents. + + # ifndef SCRIBO_NDEBUG # include <mln/util/timer.hh> # endif // ! SCRIBO_NDEBUG @@ -103,6 +109,9 @@ namespace scribo { + /*! \brief Functor analysing and extracting content in + degraded/historical documents. + */ template <typename I> struct content_in_hdoc_functor : public Toolchain_Functor diff --git a/scribo/scribo/toolchain/internal/text_in_doc_functor.hh b/scribo/scribo/toolchain/internal/text_in_doc_functor.hh index edb170d..eeac1ea 100644 --- a/scribo/scribo/toolchain/internal/text_in_doc_functor.hh +++ b/scribo/scribo/toolchain/internal/text_in_doc_functor.hh @@ -27,6 +27,10 @@ #ifndef SCRIBO_TOOLCHAIN_INTERNAL_TEXT_IN_DOC_FUNCTOR_HH # define SCRIBO_TOOLCHAIN_INTERNAL_TEXT_IN_DOC_FUNCTOR_HH +/// \file +/// +/// \brief Functor extracting text lines from a document image. + # ifndef SCRIBO_NDEBUG # include <mln/util/timer.hh> # endif // ! SCRIBO_NDEBUG @@ -76,7 +80,9 @@ namespace scribo namespace internal { + /*! \brief Functor extracting text lines from a document image. + */ template <typename I> struct text_in_doc_functor : public Toolchain_Functor diff --git a/scribo/scribo/toolchain/internal/text_in_doc_preprocess_functor.hh b/scribo/scribo/toolchain/internal/text_in_doc_preprocess_functor.hh index d58b4b2..12dc834 100644 --- a/scribo/scribo/toolchain/internal/text_in_doc_preprocess_functor.hh +++ b/scribo/scribo/toolchain/internal/text_in_doc_preprocess_functor.hh @@ -27,6 +27,11 @@ #ifndef SCRIBO_TOOLCHAIN_INTERNAL_TEXT_IN_DOC_PREPROCESS_FUNCTOR_HH # define SCRIBO_TOOLCHAIN_INTERNAL_TEXT_IN_DOC_PREPROCESS_FUNCTOR_HH +/// \file +/// +/// \brief Functor performing custom preprocessing algorithms on +/// documents. + #include <mln/core/concept/image.hh> #include <mln/data/transform.hh> #include <mln/data/convert.hh> diff --git a/scribo/scribo/toolchain/internal/text_in_picture_functor.hh b/scribo/scribo/toolchain/internal/text_in_picture_functor.hh index 5178a82..8d12612 100644 --- a/scribo/scribo/toolchain/internal/text_in_picture_functor.hh +++ b/scribo/scribo/toolchain/internal/text_in_picture_functor.hh @@ -29,7 +29,7 @@ /// \file /// -/// Localize text in a picture. +/// \brief Localize text in a picture. # include <libgen.h> @@ -107,7 +107,7 @@ namespace scribo using namespace mln; - + /// \brief Localize text in a picture. template <typename I> struct text_in_picture_functor : public Toolchain_Functor diff --git a/scribo/scribo/toolchain/internal/toolchain_functor.hh b/scribo/scribo/toolchain/internal/toolchain_functor.hh index fbf1702..835cbbd 100644 --- a/scribo/scribo/toolchain/internal/toolchain_functor.hh +++ b/scribo/scribo/toolchain/internal/toolchain_functor.hh @@ -27,6 +27,10 @@ #ifndef SCRIBO_TOOLCHAIN_INTERNAL_TOOLCHAIN_FUNCTOR_HH # define SCRIBO_TOOLCHAIN_INTERNAL_TOOLCHAIN_FUNCTOR_HH +/// \file +/// +/// \brief Base class for toolchain functors. + # include <unistd.h> # include <iostream> @@ -39,6 +43,7 @@ namespace scribo namespace internal { + /// \brief Base class for toolchain functors. class Toolchain_Functor { public: diff --git a/scribo/scribo/toolchain/nepomuk/text_extraction.hh b/scribo/scribo/toolchain/nepomuk/text_extraction.hh index 2534ce8..705787a 100644 --- a/scribo/scribo/toolchain/nepomuk/text_extraction.hh +++ b/scribo/scribo/toolchain/nepomuk/text_extraction.hh @@ -65,7 +65,10 @@ namespace scribo This is a convenient routine to be used in Nepomuk. - \param[in] ima A document image. The + \param[in] input A document image. + \param[in] language The main language used in the input + document image. Improve text recognition + quality if accurate. \return A set of recognized words. @@ -76,6 +79,7 @@ namespace scribo Depending on your version of Tesseract (OCR) you may define HAVE_TESSERACT_2 or HAVE_TESSERACT_3 . + \ingroup grptoolchain */ QSet<QString> text_extraction(const QImage& input, const QString& language); diff --git a/scribo/scribo/toolchain/text_in_doc.hh b/scribo/scribo/toolchain/text_in_doc.hh index 960a22a..b1fb511 100644 --- a/scribo/scribo/toolchain/text_in_doc.hh +++ b/scribo/scribo/toolchain/text_in_doc.hh @@ -29,7 +29,7 @@ /// \file /// -/// Extract text from a document. +/// \brief Extract text from a document. # include <scribo/toolchain/internal/text_in_doc_functor.hh> @@ -42,6 +42,26 @@ namespace scribo using namespace mln; + /*! \brief Extract text lines from a document image. + + \param[in] input A RGB image. + \param[in] denoise Remove too small components (<= 2 pixels). + \param[in] language Main language used in the input + document. (OCR settings) + \param[in] find_line_seps Enable/Disable lookup for + vertical/horizontal separators. + \param[in] find_whitespace_seps Enable/Disable lookup for + vertical alignments and + whitespaces. Helps finding text + layout. + \param[in] verbose Enable/Disable debug information printed on + std::cout. + + \return A line set including text information and recognized + text. + + \ingroup grptoolchaindocproc + */ template <typename I> line_set<mln_ch_value(I, def::lbl_type)> text_in_doc(const Image& input, bool denoise, diff --git a/scribo/scribo/toolchain/text_in_doc_preprocess.hh b/scribo/scribo/toolchain/text_in_doc_preprocess.hh index 0a99487..e94af6f 100644 --- a/scribo/scribo/toolchain/text_in_doc_preprocess.hh +++ b/scribo/scribo/toolchain/text_in_doc_preprocess.hh @@ -55,12 +55,16 @@ namespace scribo \param[in] input An image. \param[in] enable_fg_bg Enable/Disable background removal. + \param[in] lambda Parameter to the background removal. Maximum + area of foreground objects. \param[in] K Binarization threshold parameter. (Default 0.34) + \param[in] verbose Enable/Disable debug output on std::cout. If \p enable_fg_bg is set to 'True' then a background removal is performed. Its parameter lambda is automatically set according to the input image size. + \ingroup grptoolchaindocpreproc */ template <typename I> mln_ch_value(I,bool) @@ -70,6 +74,8 @@ namespace scribo /*! \overload K is set to 0.34. + + \ingroup grptoolchaindocpreproc */ template <typename I> mln_ch_value(I,bool) @@ -81,11 +87,14 @@ namespace scribo \param[in] input An image. \param[in] lambda Parameter to the background removal. + \param[in] verbose Enable/Disable debug information printed on + std::cout. If lambda is set to '0' no background removal is performed. Otherwise, a background removal is performed with the given \p lambda value. + \ingroup grptoolchaindocpreproc */ template <typename I> mln_ch_value(I,bool) @@ -97,12 +106,17 @@ namespace scribo \param[in] input An image. \param[in] lambda Parameter to the background removal. \param[in] K Binarization threshold parameter. (Default 0.34) + \param[in] enable_fg_bg If set to True tries to identify + background components and remove them. \param[in,out] fg The foreground layer of \p input. + \param[in] verbose Enable/Disable debug information printed on + std::cout. If lambda is set to '0' no background removal is performed. Otherwise, a background removal is performed with the given \p lambda value. + \ingroup grptoolchaindocpreproc */ template <typename I> mln_ch_value(I,bool) diff --git a/scribo/scribo/toolchain/text_in_picture.hh b/scribo/scribo/toolchain/text_in_picture.hh index 8d05158..0580ec6 100644 --- a/scribo/scribo/toolchain/text_in_picture.hh +++ b/scribo/scribo/toolchain/text_in_picture.hh @@ -30,7 +30,7 @@ /// \file /// -/// Localize text in a picture. +/// \brief Localize text in a picture. # include <scribo/toolchain/internal/text_in_picture_functor.hh> @@ -42,7 +42,26 @@ namespace scribo using namespace mln; - + /*! \brief Localize text in pictures. + + \param[in] input_rgb_orig A RGB image. + \param[in] bg_removal If set to True tries to identify + background components and remove them. + \param[in] multi_scale_bin Sauvola's binarization is used. Tells + whether to use a multi-scale version + or not. + \param[in] max_dim_size The maximum height or width allowed for + the input image. If larger, it is + resized. + \param[in] lambda Maximum area of components considered as + foreground objects. If set to '0' (default), + it is fixed automatically. + \param[in] verbose Enable/Disable debug output on std::cout. + + \return A component set corresponding to the text components. + + \ingroup grptoolchainpicproc + */ template <typename I> component_set<mln_ch_value(I, def::lbl_type)> text_in_picture(const Image& input_rgb_orig, -- 1.7.2.5

1 0

olena-2.0-16-gc3282fa Add support for bibliography generation and Improve scribo doc rendering.
by Guillaume Lazzara 29 Nov '11

29 Nov '11

--- AUTHORS | 201 ++- doc/Doxyfile.in | 10 +- doc/DoxygenLayout.xml | 2 +- doc/Makefile.am | 46 +- doc/bibliography.dox | 37 + doc/bibliography.hh | 19 - doc/contributors.dox | 5 + doc/lrde.bib | 3856 +++++++++++++++++++++++++++++ doc/{mainpage.hh => mainpage.dox} | 6 +- doc/{modules_list.hh => modules_list.dox} | 0 doc/olena.qhcp | 12 - scribo/doc/Doxyfile.in | 13 +- scribo/doc/groups.dox | 19 + scribo/scribo/core/component_set.hh | 4 + scribo/scribo/core/document.hh | 7 +- scribo/scribo/core/line_links.hh | 4 +- scribo/scribo/core/line_set.hh | 7 +- scribo/scribo/core/object_groups.hh | 2 + scribo/scribo/core/object_links.hh | 4 +- scribo/scribo/core/paragraph_set.hh | 1 + 20 files changed, 4141 insertions(+), 114 deletions(-) create mode 100644 doc/bibliography.dox delete mode 100644 doc/bibliography.hh create mode 100644 doc/contributors.dox create mode 100644 doc/lrde.bib rename doc/{mainpage.hh => mainpage.dox} (80%) rename doc/{modules_list.hh => modules_list.dox} (100%) delete mode 100644 doc/olena.qhcp create mode 100644 scribo/doc/groups.dox diff --git a/AUTHORS b/AUTHORS index f12b60e..9bea227 100644 --- a/AUTHORS +++ b/AUTHORS @@ -5,7 +5,8 @@ This package was written by and with the assistance of Active LRDE Staff. ================== -* Thierry Géraud theo(a)lrde.epita.fr +* **Thierry Géraud** <theo(a)lrde.epita.fr> + - Management of the project in the first place. - Type system. - Revamp of Metalic (Olena pre-1.0). @@ -14,11 +15,15 @@ Active LRDE Staff. - Olena 1.0 core. - Numerous hours spent thinking about Olena. -* Guillaume Lazzara z(a)lrde.epita.fr + +* **Guillaume Lazzara** <z(a)lrde.epita.fr> + - SCRIBO module main author and maintainer. - Library improvements. -* Roland Levillain roland(a)lrde.epita.fr + +* **Roland Levillain** <roland(a)lrde.epita.fr> + - Project manager. - Theoretical mentor. - Renovation of Swilena (Olena 0.10a). @@ -32,30 +37,41 @@ Active LRDE Staff. Past contributors of LRDE Staff. ================================ -* Jérôme Darbon jerome(a)lrde.epita.fr +* **Jérôme Darbon** <jerome(a)lrde.epita.fr> + - Image morphology and Olena morpho. -* Réda Dehak reda(a)lrde.epita.fr + +* **Réda Dehak** <reda(a)lrde.epita.fr> + - Management of the project. - Color conversions. - Cleanup the sources. -* Akim Demaille akim(a)lrde.epita.fr + +* **Akim Demaille** <akim(a)lrde.epita.fr> + - Configuration system. - Maintenance of code's clearness. -* Alexandre Duret-Lutz adl(a)lrde.epita.fr + +* **Alexandre Duret-Lutz** <adl(a)lrde.epita.fr> + - Maintenance of the source tree for several years. - Type system. - Test system. - First documentation system. - Numerous hours spent on Olena to make it better. -* Fabien Freling fabien.freling(a)lrde.epita.fr + +* **Fabien Freling** <fabien.freling(a)lrde.epita.fr> + - Work on Melimage with IGR. - Library improvements. -* Yann Jacquelet jacquelet(a)lrde.epita.fr + +* **Yann Jacquelet** <jacquelet(a)lrde.epita.fr> + - SCRIBO-related work. @@ -63,20 +79,25 @@ Past contributors of LRDE Staff. Interns. ======== -* Arthur Crépin-Leblond +* **Arthur Crépin-Leblond** + - SCRIBO structured outputs (XML, HTML, PDF). -* Raphaël Boissel + +* **Raphaël Boissel** - Graph implementation of a DIA toolchain in SCRIBO. ========================= Students from Class 2012. ========================= -* Frédéric Bour frederic.bour(a)lrde.epita.fr +* **Frédéric Bour** <frederic.bour(a)lrde.epita.fr> + - Prototype of the upcoming functions system. -* Julien Marquegnies julien.marquegnies(a)lrde.epita.fr + +* **Julien Marquegnies** <julien.marquegnies(a)lrde.epita.fr> + - Fast implementation of the Hough transform. - Many improvements in SCRIBO layout analysis. @@ -84,7 +105,8 @@ Students from Class 2012. Students from Class 2011. ========================= -* Edwin Carlinet edwin.carlinet(a)lrde.epita.fr +* **Edwin Carlinet** <edwin.carlinet(a)lrde.epita.fr> + - Accumulators. - Morphological connected filters. @@ -92,32 +114,44 @@ Students from Class 2011. Students from Class 2010. ========================= -* Florent D'Halluin +* **Florent D'Halluin** + - Document layout viewer. -* Etienne Folio + +* **Etienne Folio** + - Color type traits. ========================= Students from Class 2009. ========================= -* Alexandre Abraham +* **Alexandre Abraham** + - R/W functions. - Topological watershed transform. -* Nicolas Ballas + +* **Nicolas Ballas** + - Image properties. - Data routines. -* Vivien Delmon + +* **Vivien Delmon** + - Misc. corrections. -* Matthieu Garrigues + +* **Matthieu Garrigues** + - Value types and I/Os. - Draft of the FLLT. -* Ugo Jardonnet + +* **Ugo Jardonnet** + - Geometrical transforms. - ICP registration algorithm. @@ -125,24 +159,32 @@ Students from Class 2009. Students from Class 2008. ========================= -* Tristan Croiset +* **Tristan Croiset** + - Dynamic (Dyn) (Olena proto-1.0) -* Quentin Hocquet + +* **Quentin Hocquet** + - SCOOL -* Thomas Moulard + +* **Thomas Moulard** + - SCOOL ========================= Students from Class 2007. ========================= -* Christophe Berger +* **Christophe Berger** + - Connected filters (Olena proto-1.0, Olena pre-1.0). - SCOOP 2 (Olena proto-1.0). -* Nicolas Widynski + +* **Nicolas Widynski** + - Connected filters (Olena proto-1.0). - Inpainting (Olena proto-1.0). - Segmentation (watershed transform, watersnake, snakes) (Olena proto-1.0) @@ -151,16 +193,21 @@ Students from Class 2007. Students from Class 2006. ========================= -* Simon Odou +* **Simon Odou** + - Contributions to document the code. - Deconvolution. - Generic morphers. - SCOOP 2 (Olena proto-1.0). -* Nicolas Pouillard + +* **Nicolas Pouillard** + - Dynamic-static bridge prototype (Dyn) (Olena proto-1.0). -* Damien Thivolle + +* **Damien Thivolle** + - Contributions to document the code. - Generic morphers. - Configuration system. @@ -174,14 +221,17 @@ Students from Class 2006. Students from Class 2005. ========================= -* Giovanni Palma +* **Giovanni Palma** + - Color conversion. - Attribute opening and closing algorithms. - New documentation system. - Document the code. - Cleanup the sources. -* Niels Van Vliet + +* **Niels Van Vliet** + - Color conversion. - Attribute opening and closing algorithms. - Contributions to document the code. @@ -191,21 +241,28 @@ Students from Class 2005. Students from Class 2004. ========================= -* Sylvain Berlemont +* **Sylvain Berlemont** + - Combinatorial maps. - Cleanup the sources. -* Nicolas Burrus + +* **Nicolas Burrus** + - Integre. - Olena I/O. - Source tree. -* David Lesage + +* **David Lesage** + - Type system. - New paradigm. - Cleanup the sources. -* Astrid Wang + +* **Astrid Wang** + - New documentation system. - Static arrays implementation. @@ -213,25 +270,36 @@ Students from Class 2004. Students from Class 2003. ========================= -* Ignacy Gawedzki +* **Ignacy Gawedzki** + - Color system. -* Jean-Sébastien Mouret + +* **Jean-Sébastien Mouret** + - Image I/O. - Source tree and configuration system. - Fast morphological operators. -* Quôc Peyrot + +* **Quôc Peyrot** + - Watershed algorithm. -* Raphaël Poss + +* **Raphaël Poss** + - Source tree and configuration system. - Documentation. -* Yann Régis-Gianas + +* **Yann Régis-Gianas** + - Type system. -* Emmanuel Turquin + +* **Emmanuel Turquin** + - Implementation of transforms. - Integre. @@ -239,22 +307,29 @@ Students from Class 2003. Students from Class 2002. ========================= -* Jean Chalard +* **Jean Chalard** + - Colors. - Vectors and matrices implementation. - Olena iterators implementation. - Wavelets. -* Rémi Coupet + +* **Rémi Coupet** + - Olena morpho. - Data types (pre-0.6). - Olena core. - Bibliographical research. -* Ludovic Perrine + +* **Ludovic Perrine** + - Fuzzy types. -* Pierre-Yves Strub + +* **Pierre-Yves Strub** + - Olena morpho. - Source tree and configuration system. - Type system. @@ -263,20 +338,28 @@ Students from Class 2002. Students from Class 2001. ========================= -* Alexis Angelidis +* **Alexis Angelidis** + - Olena logo. -* Vincent Berruchon -* Renaud François +* **Vincent Berruchon** + + +* **Renaud François** + - Bibliographical research. -* Anthony Pinagot + +* **Anthony Pinagot** + - Olena I/O. - Statistical operators. - FFT algorithm. -* Michaël Strauss + +* **Michaël Strauss** + - Image morphology. - Watershed algorithms. - Olena I/O. @@ -285,7 +368,8 @@ Students from Class 2001. Students from Class 2000. ========================= -* Yoann Fabre +* **Yoann Fabre** + - Type system. @@ -293,17 +377,24 @@ Students from Class 2000. Other Contributors. =================== -* Guillaume Duhamel +* **Guillaume Duhamel** + - Low-level routines. -* Simon Nivault + +* **Simon Nivault** + - Lemming object. - Many cleanups. -* Dimitri Papadopoulos-Orfanos + +* **Dimitri Papadopoulos-Orfanos** + - Type system. -* Heru Xue + +* **Heru Xue** + - Color system. diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index a0fcf00..86377ef 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -40,7 +40,7 @@ MULTILINE_CPP_IS_BRIEF = NO INHERIT_DOCS = YES SEPARATE_MEMBER_PAGES = NO TAB_SIZE = 8 -ALIASES = +ALIASES = " " OPTIMIZE_OUTPUT_FOR_C = NO OPTIMIZE_OUTPUT_JAVA = NO BUILTIN_STL_SUPPORT = YES @@ -92,17 +92,15 @@ WARN_LOGFILE = # configuration options related to the input files #--------------------------------------------------------------------------- INPUT = @top_srcdir@/doc -FILE_PATTERNS = *.cc \ - *.hh \ - *.hxx \ - *.hcc +FILE_PATTERNS = *.dox RECURSIVE = YES EXCLUDE = @top_srcdir@/milena/ \ @top_srcdir@/scribo/ EXCLUDE_SYMLINKS = YES EXCLUDE_PATTERNS = *spe.hh EXCLUDE_SYMBOLS = *::internal* *_ mln::trait::* -EXAMPLE_PATH = +EXAMPLE_PATH = @top_srcdir@/doc/ \ + @builddir@ EXAMPLE_PATTERNS = *.cc \ *.cc.raw \ *.txt diff --git a/doc/DoxygenLayout.xml b/doc/DoxygenLayout.xml index a279910..0dbf0d7 100644 --- a/doc/DoxygenLayout.xml +++ b/doc/DoxygenLayout.xml @@ -2,7 +2,7 @@  <navindex> <tab type="mainpage" visible="yes" title="Home"/> - <tab type="pages" visible="no" title=""/> + <tab type="pages" visible="yes" title=""/> <tab type="modules" visible="no" title=""/> <tab type="namespaces" visible="no" title=""> <tab type="namespaces" visible="no" title=""/> diff --git a/doc/Makefile.am b/doc/Makefile.am index e733ab9..1bf95d5 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -53,13 +53,17 @@ regen-doc: DOXYFILE_USER = Doxyfile_user -REFMAN_deps = $(srcdir)/footer.html \ - $(srcdir)/header.html \ - $(srcdir)/doxygen.css \ - $(srcdir)/mainpage.hh \ - $(srcdir)/DoxygenLayout.xml \ - $(srcdir)/modules_list.hh \ - $(srcdir)/olena.bib +REFMAN_deps = $(srcdir)/footer.html \ + $(srcdir)/header.html \ + $(srcdir)/doxygen.css \ + $(srcdir)/mainpage.dox \ + $(srcdir)/DoxygenLayout.xml \ + $(srcdir)/modules_list.dox \ + $(srcdir)/olena.bib \ + $(srcdir)/contributors.dox \ + $(srcdir)/bibliography.dox \ + contributors.html \ + lrde_olena.html # Sed is used to generate Doxyfile from Doxyfile.in instead of # configure, because the former is way faster than the latter. @@ -113,8 +117,36 @@ $(srcdir)/$(USER_REFMAN): $(srcdir)/user-refman.stamp EXTRA_DIST += $(USER_REFMAN) +## -------------- ## +## Contributors. ## +## -------------- ## + +contributors.html: $(top_srcdir)/AUTHORS + rst2html --stylesheet-path=$(srcdir)/doxygen.css --link-stylesheet \ + --input-encoding=latin1 --output-encoding=latin1 \ + $(top_srcdir)/AUTHORS > contributors.html + + +## -------------- ## +## Bibliography. ## +## -------------- ## + +# Warning: also generate lrde_olena.cite +lrde_olena.bib: + bib2bib -s plain -oc lrde_olena.cite -ob lrde_olena.bib -c \ + 'project = "Image" or project = "Olena"' \ + -s year -r $(srcdir)/lrde.bib + +# Warning: also generate lrde_olena_bib.html +lrde_olena.html: lrde_olena.bib + bibtex2html -s plain -nokeywords -citefile lrde_olena.cite \ + -noabstract -nofooter -labelname -nodoc -linebreak -nf urllrde PDF lrde_olena.bib +MAINTAINERCLEANFILES += lrde_olena.cite \ + lrde_olena.bib \ + lrde_olena_bib.html \ + lrde_olena.html ## ---------- ## ## Cleaning. ## diff --git a/doc/bibliography.dox b/doc/bibliography.dox new file mode 100644 index 0000000..59518cb --- /dev/null +++ b/doc/bibliography.dox @@ -0,0 +1,37 @@ +/** \page bibliography Bibliography + + In this page, all publications used to implement Olena or related to Olena itself are referenced. + + Summary: + \li \ref olnpublis + \li \ref olnpublisjournals + \li \ref olnpublisconfs + \li \ref olnpublisposters + \li \ref olnpublistechreps + + \li \ref{burrus.03.mpool} + \li \ref{darbon.02.ismm} + \li \ref{darbon.04.ecoopphd} + \li \cite duret.00.gcse + \li \cite geraud.00.icpr + \li \cite geraud.01.ai + \li \cite geraud.08.mpool + \li \cite geraud.99.gretsi + \li \cite lazzara.11.icdar + \li \cite levillain.09.ismm + \li \cite levillain.10.icip + \li \cite levillain.10.wadgmm + \li \cite levillain.11.gretsi + + \section olnpublis Olena Publications + + \subsection olnpublisjournals In Journals + + \subsection olnpublisconfs In Conferences + \htmlinclude lrde_olena.html + + \subsection olnpublisposters Posters + + \subsection olnpublistechreps Student Technical Reports + + */ diff --git a/doc/bibliography.hh b/doc/bibliography.hh deleted file mode 100644 index 841372b..0000000 --- a/doc/bibliography.hh +++ /dev/null @@ -1,19 +0,0 @@ -/** \page bibliography Bibliography - - Here you can find all the articles related to the Olena platform. - - \li \cite burrus.03.mpool - \li \cite darbon.02.ismm - \li \cite darbon.04.ecoopphd - \li \cite duret.00.gcse - \li \cite geraud.00.icpr - \li \cite geraud.01.ai - \li \cite geraud.08.mpool - \li \cite geraud.99.gretsi - \li \cite lazzara.11.icdar - \li \cite levillain.09.ismm - \li \cite levillain.10.icip - \li \cite levillain.10.wadgmm - \li \cite levillain.11.gretsi - - */ diff --git a/doc/contributors.dox b/doc/contributors.dox new file mode 100644 index 0000000..82b35c6 --- /dev/null +++ b/doc/contributors.dox @@ -0,0 +1,5 @@ +/** \page Contributors List of contributors + + \htmlinclude contributors.html + + */ diff --git a/doc/lrde.bib b/doc/lrde.bib new file mode 100644 index 0000000..c1d6a03 --- /dev/null +++ b/doc/lrde.bib @@ -0,0 +1,3856 @@ + %% ----------------------- %% + %% The LRDE Bibliography. %% + %% ----------------------- %% + +%% This document lists all the publications by members of the LRDE. +%% $Id: lrde.bib 4195 2011-10-11 10:08:20Z levill_r $ +%% +%% See +%% +%% - http://www.lrde.epita.fr +%% for more information about the LRDE +%% +%% - http://publis.lrde.epita.fr +%% for more information about these publications +%% +%% - http://www.lrde.epita.fr/dload/papers/lrde.bib +%% for the most recent version of this BibTeX file + +@InProceedings{ angelidis.01.wscg, + author = {Alexis Angelidis and Geoffroy Fouquier}, + title = {Visualization issues in virtual environments: from + computer graphics techniques to intentional visualization}, + booktitle = {Proceedings of the 9th International Conference in Central + Europe on Computer Graphics, Visualization and Computer + Vision (WSCG)}, + year = 2001, + editor = {V. Skala}, + volume = 3, + pages = {90--98}, + address = {Plzen, Czech Republic}, + month = feb, + isbn = {80-7082-713-0}, + project = {Urbi}, + urllrde = {200102-Wscg}, + abstract = {Rendering efficiently large virtual environment scenes + composed of many elements, dynamic objects, and a highly + moving viewpoint is a major issue. This paper focuses on + the first of the two viewing stage operations: required + elements determination, the second being shading/filtering. + We propose a classification, extending the existing + computer graphic techniques toward display scalability + requirements, that distinguishes two key points: keeping + only required elements (culling), and keeping only required + details (which includes traditional LODs). The mechanisms + needed for display scalability are presented.} +} + +@InProceedings{ baillard.05.adass, + author = {Anthony Baillard and Emmanuel Bertin and Yannic Mellier + and Henry Joy {McCracken} and {\relax Th}ierry G\'eraud and + Roser Pell\'o and Jean-Fran{\,c}ois {LeBorgne} and Pascal + Fouqu\'e}, + title = {Project {EFIGI}: Automatic classification of galaxies}, + year = 2005, + booktitle = {Astronomical Data Analysis Software and Systems XV}, + volume = 351, + pages = {236--239}, + publisher = {Astronomical Society of the Pacific}, + series = {Conference}, + url = {http://www.aspbooks.org/custom/publications/paper/index.phtml?paper_id=3398} + , + editor = {Carlos Gabriel and {\relax Ch}ristophe Arviset and Daniel + Ponz and Enrique Solano}, + isbn = {1-58381-219-9}, + project = {Image}, + urllrde = {200512-ADASS}, + abstract = {We propose an automatic system to classify images of + galaxies with varying resolution. Morphologically typing + galaxies is a difficult task in particular for distant + galaxies convolved by a point-spread function and suffering + from a poor signal-to-noise ratio. In the context of the + first phase of the project EFIGI (extraction of the + idealized shapes of galaxies in imagery), we present the + three steps of our software: cleaning, dimensionality + reduction and supervised learning. We present preliminary + results derived from a subset of 774 galaxies from the + Principal Galaxies Catalog and compare them to human + classifications made by astronomers. We use g-band images + from the Sloan Digital Sky Survey. Finally, we discuss + future improvements which we intend to implement before + releasing our tool to the community.} +} + +@InProceedings{ baillard.07.gretsi, + author = {Anthony Baillard and {\relax Ch}ristophe Berger and + Emmanuel Bertin and {\relax Th}ierry G\'eraud and Roland + Levillain and Nicolas Widynski}, + title = {Algorithme de calcul de l'arbre des composantes avec + applications \`a la reconnaissance des formes en imagerie + satellitaire}, + booktitle = {Proceedings of the 21st Symposium on Signal and Image + Processing (GRETSI)}, + category = {national}, + year = 2007, + address = {Troyes, France}, + month = sep, + project = {Image}, + urllrde = {200705-GRETSI}, + abstract = {In this paper a new algorithm to compute the component + tree is presented. As compared to the state-of-the-art, + this algorithm does not use excessive memory and is able to + work efficiently on images whose values are highly + quantized or even with images having floating values. We + also describe how it can be applied to astronomical data to + identify relevant objects.} +} + +@InProceedings{ bensalem.11.sumo, + author = {Ala Eddine Ben{ S}alem and Alexandre Duret-Lutz and + Fabrice Kordon}, + title = {Generalized {B\"u}chi Automata versus Testing Automata for + Model Checking}, + booktitle = {Proceedings of the second International Workshop on + Scalable and Usable Model Checking for Petri Net and other + models of Concurrency (SUMO'11)}, + address = {Newcastle, UK}, + series = {Workshop Proceedings}, + year = 2011, + month = jun, + volume = 626, + publisher = {CEUR}, + urllrde = {201106-SUMO}, + url = {http://ftp.informatik.rwth-aachen.de/Publications/CEUR-WS/Vol-726/} + +} + +@InProceedings{ berger.07.icip, + author = {{\relax Ch}ristophe Berger and {\relax Th}ierry G\'eraud + and Roland Levillain and Nicolas Widynski and Anthony + Baillard and Emmanuel Bertin}, + title = {Effective Component Tree Computation with Application to + Pattern Recognition in Astronomical Imaging}, + booktitle = {Proceedings of the IEEE International Conference on Image + Processing (ICIP)}, + pages = {IV-41--IV-44}, + volume = 4, + year = 2007, + address = {San Antonio, TX, USA}, + month = sep, + project = {Image}, + urllrde = {200705-ICIP}, + abstract = {In this paper a new algorithm to compute the component + tree is presented. As compared to the state of the art, + this algorithm does not use excessive memory and is able to + work efficiently on images whose values are highly + quantized or even with images having floating values. We + also describe how it can be applied to astronomical data to + identify relevant objects.} +} + +@Article{ bloch.03.ai, + author = {Isabelle Bloch and {\relax Th}ierry G\'eraud and Henri + Ma\^itre}, + title = {Representation and fusion of heterogeneous fuzzy + information in the {3D} space for model-based structural + recognition---application to {3D} brain imaging}, + journal = {Artificial Intelligence}, + month = aug, + year = 2003, + volume = 148, + number = {1-2}, + pages = {141--175}, + project = {Image}, + urllrde = {200308-AI}, + abstract = {We present a novel approach of model-based pattern + recognition where structural information and spatial + relationships have a most important role. It is illustrated + in the domain of 3D brain structure recognition using an + anatomical atlas. Our approach performs simultaneously + segmentation and recognition of the scene and the solution + of the recognition task is progressive, processing + successively different objects, using different of + knowledge about the object and about relationships between + objects. Therefore the core of the approach is the + representation part, and constitutes the main contribution + of this paper. We make use of a spatial representation of + each piece of information, as a spatial set representing a + constraint to be satisfied by the searched object, thanks + in particular to fuzzy mathematical operations. Fusion of + these constraints allows to, segment and recognize the + desired object.} +} + +@Article{ bloch.05.prl, + author = {Isabelle Bloch and Olivier Colliot and Oscar Camara and + {\relax Th}ierry G\'eraud}, + title = {Fusion of spatial relationships for guiding recognition, + example of brain structure recognition in {3D} {MRI}}, + journal = {Pattern Recognition Letters}, + year = 2005, + volume = 26, + number = 4, + month = mar, + pages = {449--457}, + project = {Image}, + urllrde = {200407-PRL}, + abstract = {Spatial relations play an important role in recognition of + structures embedded in a complex environment and for + reasoning under imprecision. Several types of relationships + can be modeled in a unified way using fuzzy mathematical + morphology. Their combination benefits from the powerful + framework of fuzzy set theory for fusion tasks and decision + making. This paper presents several methods of fusion of + information about spatial relationships and illustrates + them on the example of model-based recognition of brain + structures in 3D magnetic resonance imaging.} +} + +@Article{ borghi.06.crossroads, + author = {Alexandre Borghi and Valentin David and Akim Demaille}, + title = {{C}-{T}ransformers --- {A} Framework to Write {C} Program + Transformations}, + journal = {ACM Crossroads}, + year = 2006, + volume = 12, + number = 3, + month = {Spring}, + project = {Transformers}, + note = {\url{http://www.acm.org/crossroads/xrds12-3/contractc.html}} + , + urllrde = {200510-Crossroads}, + abstract = {Program transformation techniques have reached a maturity + level that allows processing high-level language sources in + new ways. Not only do they revolutionize the implementation + of compilers and interpreters, but with modularity as a + design philosophy, they also permit the seamless extension + of the syntax and semantics of existing programming + languages. The C-Transformers project provides a + transformation environment for C, a language that proves to + be hard to transform. We demonstrate the effectiveness of + C-Transformers by extending C's instructions and control + flow to support Design by Contract. C-Transformers is + developed by members of the LRDE: EPITA undergraduate + students.} +} + +@InProceedings{ burrus.03.mpool, + author = {Nicolas Burrus and Alexandre Duret-Lutz and {\relax + Th}ierry G\'eraud and David Lesage and Rapha\"el Poss}, + title = {A static {C++} object-oriented programming ({SCOOP}) + paradigm mixing benefits of traditional {OOP} and generic + programming}, + booktitle = {Proceedings of the Workshop on Multiple Paradigm with + Object-Oriented Languages (MPOOL)}, + year = 2003, + address = {Anaheim, CA, USA}, + month = oct, + project = {Olena}, + urllrde = {200310-MPOOL}, + abstract = {Object-oriented and generic programming are both supported + in C++. OOP provides high expressiveness whereas GP leads + to more efficient programs by avoiding dynamic typing. This + paper presents SCOOP, a new paradigm which enables both + classical OO design and high performance in C++ by mixing + OOP and GP. We show how classical and advanced OO features + such as virtual methods, multiple inheritance, argument + covariance, virtual types and multimethods can be + implemented in a fully statically typed model, hence + without run-time overhead.} +} + +@InProceedings{ cadilhac.06.avocs, + author = {Micha\"el Cadilhac and {\relax Th}omas H\'erault and + Richard Lassaigne and Sylvain Peyronnet and Sebastien + Tixeuil}, + title = {Evaluating complex {MAC} protocols for sensor networks + with {APMC}}, + booktitle = {Proceedings of the 6th International Workshop on Automated + Verification of Critical Systems (AVoCS)}, + year = 2006, + series = {Electronic Notes in Theoretical Computer Science Series}, + pages = {33--46}, + volume = 185, + project = {APMC}, + urllrde = {200606-Avocs}, + abstract = {In this paper we present an analysis of a MAC (Medium + Access Control) protocol for wireless sensor networks. The + purpose of this protocol is to manage wireless media access + by constructing a Time Division Media Access (TDMA) + schedule. APMC (Approximate Probabilistic Model Checker) is + a tool that uses approximation-based verification + techniques in order to analyse the behavior of complex + probabilistic systems. Using APMC, we approximately + computed the probabilities of several properties of the MAC + protocol being studied, thus giving some insights about its + performance.} +} + +@InProceedings{ carlier.02.itrs, + author = {S\'ebastien Carlier}, + title = {Polar type inference with intersection types and $\omega$}, + booktitle = {Proceedings of the 2nd Workshop on Intersection Types and + Related Systems (ITRS), published in: Electronic Notes in + Theoretical Computer Science}, + volume = 70, + issue = 1, + publisher = {Elsevier}, + year = 2002, + address = {Copenhagen, Denmark}, + month = jul, + project = {Software}, + urllrde = {200207-ITRS}, + abstract = {We present a type system featuring intersection types and + omega, a type constant which is assigned to unused terms. + We exploit and extend the technology of expansion variables + from the recently developed System I, with which we believe + our system shares many interesting properties, such as + strong normalization, principal typings, and compositional + analysis. Our presentation emphasizes a polarity discipline + and shows its benefits. We syntactically distinguish + positive and negative types, and give them different + interpretations. We take the point of view that the + interpretation of a type is intrinsic to it, and should not + change implicitly when it appears at the opposite polarity. + Our system is the result of a process which started with an + extension of Trevor Jim's Polar Type System.} +} + +@InProceedings{ chekroun.06.iciar, + author = {Mickael Chekroun and J\'er\^ome Darbon and Igor Ciril}, + title = {On a Polynomial Vector Field Model for Shape + Representation}, + booktitle = {Proceedings of the International Conference on Image + Analysis and Recognition (ICIAR)}, + publisher = {Springer-Verlag}, + year = 2006, + address = {Povoa de Varzim, Portugal}, + month = sep, + project = {Image}, + urllrde = {200609-ICIAR}, + abstract = {In this paper we propose an efficient algorithm to perform + a polynomial approximation of the vector field derived from + the usual distance mapping method. The main ingredients + consist of minimizing a quadratic functional and + transforming this problem in an appropriate setting for + implementation. With this approach, we reduce the problem + of obtaining an approximating polynomial vector field to + the resolution of a not expansive linear algebraic system. + By this procedure, we obtain an analytical shape + representation that relies only on some coefficients. + Fidelity and numerical efficiency of our approach are + presented on illustrative examples.} +} + +@InProceedings{ claveirole.05.ciaa, + author = {{\relax Th}omas Claveirole and Sylvain Lombardy and Sarah + O'Connor and Louis-No\"el Pouchet and Jacques Sakarovitch}, + title = {Inside {V}aucanson}, + booktitle = {Proceedings of Implementation and Application of Automata, + 10th International Conference (CIAA)}, + year = 2005, + pages = {117--128}, + editor = {Springer-Verlag}, + volume = 3845, + series = {Lecture Notes in Computer Science Series}, + address = {Sophia Antipolis, France}, + month = jun, + urllrde = {200506-Ciaa}, + project = {Vaucanson}, + abstract = {This paper presents some features of the Vaucanson + platform. We describe some original algorithms on weighted + automata and transducers (computation of the quotient, + conversion of a regular expression into a weighted + automaton, and composition). We explain how complex + declarations due to the generic programming are masked from + the user and finally we present a proposal for an XML + format that allows implicit descriptions for simple types + of automata.} +} + +@TechReport{ clouard.99.tr, + author = {R\'egis Clouard and Abderrahim Elmoataz and Fran\c{c}ois + Angot and Olivier Lezoray and Alexandre Duret-Lutz}, + title = {Une biblioth\`eque et un environnement de programmation + d'op\'erateurs de traitement d'images}, + institution = {GREYC-ISMRA}, + year = 1999, + number = 99008, + address = {Caen, France}, + month = nov, + url = {http://www.greyc.ismra.fr/~regis/Pandore/}, + project = {Olena}, + urllrde = {199911-TR} +} + +@InProceedings{ darbon.01.ei, + author = {J\'er\^ome Darbon and Bulent Sankur and Henri Ma\^{\i}tre}, + title = {Error correcting code performance for watermark + protection}, + booktitle = {Proceedings of the 13th Symposium SPIE on Electronic + Imaging----Security and Watermarking of Multimedia Contents + III (EI27)}, + year = 2001, + address = {San Jose, CA, USA}, + month = jan, + volume = 4314, + editors = {P.W. Wong and E.J. Delp III}, + pages = {663--672}, + project = {Image}, + urllrde = {200101-Ei}, + abstract = {The watermark signals are weakly inserted in images due to + imperceptibility constraints which makes them prone to + errors in the extraction stage. Although the error + correcting codes can potentially improve their performance + one must pay attention to the fact that the watermarking + channel is in general very noisy. We have considered the + trade-off of the BCH codes and repetition codes in various + concatenation modes. At the higher rates that can be + encountered in watermarking channels such as due to + low-quality JPEG compression, codes like the BCH codes + cease being useful. Repetition coding seems to be the last + resort at these error rates of 25\% and beyond. It has been + observed that there is a zone of bit error rate where their + concatenation turns out to be more useful. In fact the + concatenation of repetition and BCH codes judiciously + dimensioned, given the available number of insertion sites + and the payload size, achieves a higher reliability level.} +} + +@InProceedings{ darbon.02.ismm, + author = {J\'er\^ome Darbon and {\relax Th}ierry G\'eraud and + Alexandre Duret-Lutz}, + title = {Generic implementation of morphological image operators}, + booktitle = {Mathematical Morphology, Proceedings of the 6th + International Symposium (ISMM)}, + pages = {175--184}, + year = 2002, + address = {Sydney, Australia}, + month = apr, + publisher = {CSIRO Publishing}, + project = {Olena}, + urllrde = {200204-Ismm}, + abstract = {Several libraries dedicated to mathematical morphology + exist. But they lack genericity, that is to say, the + ability for operators to accept input of different natures + ---2D binary images, graphs enclosing floating values, etc. + We describe solutions which are integrated in Olena, a + library providing morphological operators. We demonstrate + with some examples that translating mathematical formulas + and algorithms into source code is made easy and safe with + Olena. Moreover, experimental results show that no extra + costs at run-time are induced.} +} + +@InProceedings{ darbon.04.ecoopphd, + author = {J\'er\^ome Darbon and {\relax Th}ierry G\'eraud and + Patrick Bellot}, + title = {Generic algorithmic blocks dedicated to image processing}, + booktitle = {Proceedings of the ECOOP Workshop for PhD Students}, + year = 2004, + address = {Oslo, Norway}, + month = jun, + project = {Olena}, + urllrde = {200406-ECOOPPHD}, + abstract = {This paper deals with the implementation of algorithms in + the specific domain of image processing. Although many + image processing libraries are available, they generally + lack genericity and flexibility. Many image processing + algorithms can be expressed as compositions of elementary + algorithmic operations referred to as blocks. Implementing + these compositions is achieved using generic programming. + Our solution is compared to previous ones and we + demonstrate it on a class image processing algorithms.} +} + +@InProceedings{ darbon.04.iwcia, + author = {J\'er\^ome Darbon and Marc Sigelle}, + title = {Exact optimization of discrete constrained total variation + minimization problems}, + booktitle = {Proceedings of the 10th International Workshop on + Combinatorial Image Analysis (IWCIA)}, + year = 2004, + address = {Auckland, New Zealand}, + month = dec, + pages = {548--557}, + editors = {R. Klette and J. Zunic}, + series = {Lecture Notes in Computer Science Series}, + publisher = {Springer-Verlag}, + volume = 3322, + project = {Image}, + urllrde = {200412-IWCIA}, + abstract = {This paper deals with the total variation minimization + problem when the fidelity is either the $L^2$-norm or the + $L^1$-norm. We propose an algorithm which computes the + exact solution of these two problems after discretization. + Our method relies on the decomposition of an image into its + level sets. It maps the original problems into independent + binary Markov Random Field optimization problems associated + with each level set. Exact solutions of these binary + problems are found thanks to minimum-cut techniques. We + prove that these binary solutions are increasing and thus + allow to reconstruct the solution of the original + problems.} +} + +@TechReport{ darbon.04.tr, + author = {J\'er\^ome Darbon and Marc Sigelle}, + title = {Exact optimization of discrete constrained total variation + minimization problems}, + institution = {ENST}, + year = 2004, + number = {2004C004}, + address = {Paris, France}, + month = oct, + project = {Image}, + annote = {This technical report corresponds to the publication + darbon.04.iwcia. ; 200412-IWCIA}, + urllrde = {200410-TR}, + abstract = {This paper deals with the total variation minimization + problem when the fidelity is either the $L^2$-norm or the + $L^1$-norm. We propose an algorithm which computes the + exact solution of these two problems after discretization. + Our method relies on the decomposition of an image into its + level sets. It maps the original problems into independent + binary Markov Random Field optimization problems associated + with each level set. Exact solutions of these binary + problems are found thanks to minimum-cut techniques. We + prove that these binary solutions are increasing and thus + allow to reconstruct the solution of the original + problems.} +} + +@InProceedings{ darbon.05.eusipco, + author = {J\'er\^ome Darbon and Ceyhun Burak Akg\"ul}, + title = {An efficient algorithm for attribute openings and + closings}, + booktitle = {Proceedings of the 13th European Signal Processing + Conference (EUSIPCO)}, + year = 2005, + address = {Antalya, Turkey}, + month = sep, + project = {Image}, + urllrde = {200509-Eusipco}, + abstract = {In this paper, we present fast algorithms for area opening + and closing on grayscale images. Salembier's max-tree based + algorithm is one of the well known methods to perform area + opening. It makes use of a special representation where + each node in the tree stands for a flat region and the tree + itself is oriented towards the maxima of the grayscale + image. Pruning the tree with respect to some attribute, + e.g., the area, boils down to attribute opening. Following + the same approach, we propose an algorithm for area opening + (closing) without building the max-tree (min-tree). Our + algorithm exhibit considerable performance compared to the + state-of-the art in this domain.} +} + +@InProceedings{ darbon.05.ibpria, + author = {J\'er\^ome Darbon and Marc Sigelle}, + title = {A Fast and Exact Algorithm for Total Variation + Minimization}, + booktitle = {Proceedings of the 2nd Iberian Conference on Pattern + Recognition and Image Analysis (IbPRIA)}, + publisher = {Springer-Verlag}, + volume = 3522, + pages = {351--359}, + year = 2005, + address = {Estoril, Portugal}, + month = jun, + project = {Image}, + urllrde = {200506-IbPria}, + abstract = {This paper deals with the minimization of the total + variation under a convex data fidelity term. We propose an + algorithm which computes an exact minimizer of this + problem. The method relies on the decomposition of an image + into its level sets. Using these level sets, we map the + problem into optimizations of independent binary Markov + Random Fields. Binary solutions are found thanks to + graph-cut techniques and we show how to derive a fast + algorithm. We also study the special case when the fidelity + term is the $L^1$-norm. Finally we provide some + experiments.} +} + +@InProceedings{ darbon.05.ispa, + author = {J\'er\^ome Darbon}, + title = {Total Variation Minimization with $L^1$ Data Fidelity as a + Contrast Invariant Filter}, + booktitle = {Proceedings of the 4th International Symposium on Image + and Signal Processing and Analysis (ISPA 2005)}, + year = 2005, + address = {Zagreb, Croatia}, + month = sep, + pages = {221--226}, + project = {Image}, + urllrde = {200509-Ispa}, + abstract = {This paper sheds new light on minimization of the total + variation under the $L^1$-norm as data fidelity term + ($L^1+TV$) and its link with mathematical morphology. It is + well known that morphological filters enjoy the property of + being invariant with respect to any change of contrast. + First, we show that minimization of $L^1+TV$ yields a + self-dual and contrast invariant filter. Then, we further + constrain the minimization process by only optimizing the + grey levels of level sets of the image while keeping their + boundaries fixed. This new constraint is maintained thanks + to the Fast Level Set Transform which yields a complete + representation of the image as a tree. We show that this + filter can be expressed as a Markov Random Field on this + tree. Finally, we present some results which demonstrate + that these new filters can be particularly useful as a + preprocessing stage before segmentation.} +} + +@InProceedings{ darbon.05.isvc, + author = {J\'er\^ome Darbon and Sylvain Peyronnet}, + title = {A Vectorial Self-Dual Morphological Filter based on Total + Variation Minimization}, + booktitle = {Proceedings of the First International Conference on + Visual Computing}, + year = 2005, + address = {Lake Tahoe, Nevada, USA}, + month = dec, + project = {Image}, + pages = {388--395}, + series = {Lecture Notes in Computer Science Series}, + publisher = {Springer-Verlag}, + volume = 3804, + urllrde = {200512-Isvc}, + abstract = {We present a vectorial self dual morphological filter. + Contrary to many methods, our approach does not require the + use of an ordering on vectors. It relies on the + minimization of the total variation with $L^1$ norm as data + fidelity on each channel. We further constraint this + minimization in order not to create new values. It is shown + that this minimization yields a self-dual and contrast + invariant filter. Although the above minimization is not a + convex problem, we propose an algorithm which computes a + global minimizer. This algorithm relies on minimum cost + cut-based optimizations.} +} + +@PhDThesis{ darbon.05.phd, + author = {J\'er\^ome Darbon}, + title = {Composants logiciels et algorithmes de minimisation exacte + d'\'energies d\'edid\'ees au traitement d'images}, + school = {\'Ecole Nationale Sup\'erieure des T\'el\'ecommunications + de Paris (ENST)}, + address = {Paris, France}, + year = 2005, + month = oct, + number = {XXX}, + note = {In French}, + urllrde = {200510-PhD}, + abstract = {Dans cette th\`ese nous \'etudions la minimisation + d'\'energies markoviennes rencontr\'ees dans les domaines + du traitement des images et de la vision par ordinateur. + Nous proposons des algorithmes de minimisation exacte pour + diff\'erents types d'\'energies. Ces algorithmes ont + l'int\'er\^et de fournir un minimum global quand bien + m\^eme l'\'energie n'est pas convexe. Enfin, nous mettons + en \'evidence quelques liens entre les champs de Markov + binaires et la morphologie math\'ematique. La version + finale de ce manuscrit suit les recommandations des rapporteurs.} +} + +@TechReport{ darbon.05.tr, + author = {J\'er\^ome Darbon and Marc Sigelle}, + title = {A fast and exact algorithm for total variation + minimization}, + institution = {ENST}, + year = 2005, + number = {2005D002}, + address = {Paris, France}, + month = jan, + project = {Image}, + annote = {This technical report corresponds to the publication + darbon.05.ibpria.}, + urllrde = {200501-TR}, + abstract = {This paper deals with the minimization of the total + variation under a convex data fidelity term. We propose an + algorithm which computes an exact minimizer of this + problem. The method relies on the decomposition of an image + into its level sets. Using these level sets, we map the + problem into optimizations of independent binary Markov + Random Fields. Binary solutions are found thanks to + graph-cut techniques and we show how to derive a fast + algorithm. We also study the special case when the fidelity + term is the $L^1$-norm. Finally we provide some + experiments.} +} + +@InProceedings{ darbon.06.iccp, + author = {J\'er\^ome Darbon and Richard Lassaigne and Sylvain + Peyronnet}, + title = {Approximate Probabilistic Model Checking for Programs}, + booktitle = {Proceedings of the {IEEE} 2nd International Conference on + Intelligent Computer Communication and Processing + ({ICCP'06)}}, + year = 2006, + address = {Technical University of Cluj-Napoca, Romania}, + month = sep, + urllrde = {200606-Iccp2}, + abstract = {In this paper we deal with the problem of applying model + checking to real programs. We verify a program without + constructing the whole transition system using a technique + based on Monte-Carlo sampling, also called ``approximate + model checking''. This technique combines model checking + and randomized approximation. Thus, it avoids the so called + state space explosion phenomenon. We propose a prototype + implementation that works directly on C source code. It + means that, contrary to others approaches, we do not need + to use a specific language nor specific data structures in + order to describe the system we wish to verify. Finally, we + present experimental results that show the effectiveness of + the approach applied to finding bugs in real programs.} +} + +@Article{ darbon.06.jmiv, + author = {J\'er\^ome Darbon and Marc Sigelle}, + title = {Image restoration with discrete constrained {T}otal + {Variation}---Part~{I}: Fast and exact optimization}, + journal = {Journal of Mathematical Imaging and Vision}, + year = 2006, + volume = 26, + number = 3, + month = dec, + pages = {261--276}, + project = {Image}, + urllrde = {2006XXX-JMIVa}, + abstract = {This paper deals with the total variation minimization + problem in image restoration for convex data fidelity + functionals. We propose a new and fast algorithm which + computes an exact solution in the discrete framework. Our + method relies on the decomposition of an image into its + level sets. It maps the original problems into independent + binary Markov Random Field optimization problems at each + level. Exact solutions of these binary problems are found + thanks to minimum cost cut techniques in graphs. These + binary solutions are proved to be monotone increasing with + levels and yield thus an exact solution of the discrete + original problem. Furthermore we show that minimization of + total variation under $L^1$ data fidelity term yields a + self-dual contrast invariant filter. Finally we present + some results.} +} + +@Article{ darbon.06.jmivb, + author = {J\'er\^ome Darbon and Marc Sigelle}, + title = {Image restoration with discrete constrained {T}otal + {Variation}---Part~{II}: Levelable functions, convex priors + and non-convex case}, + journal = {Journal of Mathematical Imaging and Vision}, + year = 2006, + volume = 26, + number = 3, + month = dec, + pages = {277--291}, + project = {Image}, + urllrde = {2006XXX-JMIVb}, + abstract = {In Part II of this paper we extend the results obtained in + Part I for total variation minimization in image + restoration towards the following directions: first we + investigate the decomposability property of energies on + levels, which leads us to introduce the concept of + levelable regularization functions (which TV is the + paradigm of). We show that convex levelable posterior + energies can be minimized exactly using the + level-independant cut optimization scheme seen in part I. + Next we extend this graph cut scheme optimization scheme to + the case of non-convex levelable energies. We present + convincing restoration results for images corrupted with + impulsive noise. We also provide a minimum-cost based + algorithm which computes a global minimizer for Markov + Random Field with convex priors. Last we show that + non-levelable models with convex local conditional + posterior energies such as the class of generalized + gaussian models can be exactly minimized with a generalized + coupled Simulated Annealing.} +} + +@InProceedings{ darbon.06.siam, + author = {J\'er\^ome Darbon and Marc Sigelle}, + title = {Fast and Exact Discrete Image Restoration Based on Total + Variation and on Its Extensions to Levelable Potentials}, + booktitle = {SIAM Conference on Imaging Sciences}, + year = 2006, + address = {Minneapolis, USA}, + month = may, + project = {Image}, + urllrde = {200605-SIAM}, + abstract = {We investigate the decomposition property of posterior + restoration energies on level sets in a discrete Markov + Random Field framework. This leads us to the concept of + 'levelable' potentials (which TV is shown to be the + paradigm of). We prove that convex levelable posterior + energies can be minimized exactly with level-independant + binary graph cuts. We extend this scheme to the case of + non-convex levelable energies, and present convincing + restoration results for images degraded by impulsive + noise.} +} + +@TechReport{ darbon.06.tr, + author = {J\'er\^ome Darbon and Marc Sigelle and Florence Tupin}, + title = {A note on nice-levelable {MRFs} for {SAR} image denoising + with contrast preservation}, + institution = {Signal and Image Processing Group, Ecole Nationale + Sup\'erieure des T\'el\'ecommunications}, + year = 2006, + number = {2006D006}, + address = {Paris, France}, + month = sep, + project = {Image}, + annote = {On this technical report is based the publication + darbon.07.ei ; 200701-SPIE}, + urllrde = {200701-SPIE} +} + +@InProceedings{ darbon.07.ei, + author = {J\'er\^ome Darbon and Marc Sigelle and Florence Tupin}, + title = {The use of levelable regularization functions for {MRF} + restoration of {SAR} images}, + booktitle = {Proceedings of the 19th Symposium SPIE on Electronic + Imaging}, + year = 2007, + address = {San Jose, CA, USA}, + month = jan, + project = {Image}, + urllrde = {200701-SPIE}, + abstract = {It is well-known that Total Variation (TV) minimization + with L2 data fidelity terms (which corresponds to white + Gaussian additive noise) yields a restored image which + presents some loss of contrast. The same behavior occurs + for TVmodels with non-convex data fidelity terms that + represent speckle noise. In this note we propose a new + approach to cope with the restoration of Synthetic Aperture + Radar images while preserving the contrast.} +} + +@InProceedings{ darbon.07.mirage, + author = {J\'er\^ome Darbon}, + title = {A Note on the Discrete Binary {Mumford-Shah} Model}, + booktitle = {Proceedings of the international Computer Vision / + Computer Graphics Collaboration Techniques and Applications + (MIRAGE 2007)}, + year = 2007, + address = {Paris, France}, + month = mar, + project = {Image}, + urllrde = {200703-MIRAGE}, + abstract = {This paper is concerned itself with the analysis of the + two-phase Mumford-Shah model also known as the active + contour without edges model introduced by Chan and Vese. It + consists of approximating an observed image by a piecewise + constant image which can take only two values. First we + show that this model with the $L^1$-norm as data fidelity + yields a contrast invariant filter which is a well known + property of morphological filters. Then we consider a + discrete version of the original problem. We show that an + inclusion property holds for the minimizers. The latter is + used to design an efficient graph-cut based algorithm which + computes an exact minimizer. Some preliminary results are + presented.} +} + +@InProceedings{ darbon.08.iwcia, + author = {J\'er\^ome Darbon}, + title = {Global Optimization for First Order {Markov} Random Fields + with Submodular Priors}, + booktitle = {Proceedings of the twelfth International Workshop on + Combinatorial Image Analysis (IWCIA'08) }, + year = 2008, + address = {Buffalo, New York, USA}, + month = apr, + project = {Image}, + urllrde = {200801-IWCIA}, + abstract = {This paper copes with the optimization of Markov Random + Fields with pairwise interactions defined on arbitrary + graphs. The set of labels is assumed to be linearly ordered + and the priors are supposed to be submodular. Under these + assumptions we propose an algorithm which computes an exact + minimizer of the Markovian energy. Our approach relies on + mapping the original into a combinatorial one which + involves only binary variables. The latter is shown to be + exactly solvable via computing a maximum flow. The + restatement into a binary combinatorial problem is done by + considering the level-sets of the labels instead of the + label values themselves. The submodularity of the priors is + shown to be a necessary and sufficient condition for the + applicability of the proposed approach.} +} + +@Misc{ david.05.sud, + author = {Valentin David and Akim Demaille and Renaud Durlin and + Olivier Gournet}, + title = {{C}/{C++} Disambiguation Using Attribute Grammars}, + year = 2005, + note = {Communication to Stratego Users Day 2005}, + address = {Utrecht {U}niversity, {N}etherland}, + month = may, + project = {Transformers}, + urllrde = {200505-SUD-disamb}, + abstract = {We propose a novel approach to semantics driven + disambiguation based on Attribute Grammars (AGs). AGs share + the same modularity model as its host grammar language, + here Syntax Definition Formalism (SDF), what makes them + particularly attractive for working on unstable grammars, + or grammar extensions. The framework we propose is + effective, since a full ISO-C99 disambiguation chain + already works, and the core of the hardest ambiguities of + C++ is solved. This requires specific techniques, and some + extensions to the stock AG model.} +} + +@InProceedings{ david.06.iccp, + author = {Valentin David and Akim Demaille and Olivier Gournet}, + title = {Attribute Grammars for Modular Disambiguation}, + booktitle = {Proceedings of the {IEEE} 2nd International Conference on + Intelligent Computer Communication and Processing + ({ICCP'06)}}, + year = 2006, + address = {Technical University of Cluj-Napoca, Romania}, + month = sep, + urllrde = {200606-ICCP}, + abstract = {To face the challenges to tomorrow's software engineering + tools, powerful language-generic program-transformation + components are needed. We propose the use of attribute + grammars (AGs) to generate language specific disambiguation + filters. In this paper, a complete implementation of a + language-independent AGs system is presented. As a full + scale experiment, we present an implementation of a + flexible C front-end. Its specifications are concise, + modular, and the result is efficient. On top of it, + transformations such as software renovation, code metrics, + domain specific language embedding can be implemented.}, + project = {Transformers} +} + +@Article{ dehak.05.pami, + author = {R\'eda Dehak and Isabelle Bloch and Henri Ma{\^\i}tre}, + title = {Spatial reasoning with relative incomplete information on + relative positioning}, + journal = {IEEE Transactions on Pattern Analysis and Machine + Intelligence}, + year = 2005, + pages = {1473--1484}, + volume = 27, + month = sep, + number = 9, + project = {Image}, + urllrde = {200509-PAMI}, + abstract = {This paper describes a probabilistic method of inferring + the position of a point with respect to a reference point + knowing their relative spatial position to a third point. + We address this problem in the case of incomplete + information where only the angular spatial relationships + are known. The use of probabilistic representations allows + us to model prior knowledge. We derive exact formulae + expressing the conditional probability of the position + given the two known angles, in typical cases: uniform or + Gaussian random prior distributions within rectangular or + circular regions. This result is illustrated with respect + to two different simulations: The first is devoted to the + localization of a mobile phone using only angular + relationships, the second, to geopositioning within a city. + This last example uses angular relationships and some + additional knowledge about the position.} +} + +@InProceedings{ dehak.06.nist, + author = {R\'eda Dehak and Charles-Alban Deledalle and Najim Dehak}, + title = {{LRDE} System description}, + booktitle = {NIST SRE'06 Workshop: speaker recognition evaluation + campaign}, + year = 2006, + address = {San Juan, Puerto Rico}, + month = jun, + urllrde = {200606-NIST-A} +} + +@InProceedings{ dehak.07.interspeech, + author = {R\'eda Dehak and Najim Dehak and Patrick Kenny and Pierre + Dumouchel}, + title = {Linear and Non Linear Kernel {GMM} SuperVector Machines + for Speaker Verification}, + booktitle = {Proceedings of the European Conference on Speech + Communication and Technologies (Interspeech'07)}, + year = 2007, + address = {Antwerp, Belgium}, + month = aug, + urllrde = {200708-INTERSPEECH}, + abstract = {This paper presents a comparison between Support Vector + Machines (SVM) speaker verification systems based on linear + and non linear kernels defined in GMM supervector space. We + describe how these kernel functions are related and we show + how the nuisance attribute projection (NAP) technique can + be used with both of these kernels to deal with the session + variability problem. We demonstrate the importance of GMM + model normalization (M-Norm) especially for the non linear + kernel. All our experiments were performed on the core + condition of NIST 2006 speaker recognition evaluation (all + trials). Our best results (an equal error rate of 6.3\%) + were obtained using NAP and GMM model normalization with + the non linear kernel.} +} + +@InProceedings{ dehak.08.nist, + author = {R\'eda Dehak and Najim Dehak and Patrick Kenny}, + title = {The {LRDE} Systems for the 2008 {NIST} Speaker Recognition + Evaluation}, + booktitle = {NIST-SRE 2008}, + year = 2008, + address = {Montr\'eal, Canada}, + month = jun +} + +@InProceedings{ dehak.08.odysseya, + author = {R\'eda Dehak and Najim Dehak and Patrick Kenny and Pierre + Dumouchel}, + title = {Kernel Combination for {SVM} Speaker Verification}, + booktitle = {Proceedings of the Speaker and Language Recognition + Workshop (IEEE-Odyssey 2008)}, + year = 2008, + address = {Stellenbosch, South Africa}, + month = jan, + urllrde = {200709-ODYSSEY-A}, + abstract = {We present a new approach for constructing the kernels + used to build support vector machines for speaker + verification. The idea is to construct new kernels by + taking linear combination of many kernels such as the GLDS + and GMM supervector kernels. In this new kernel + combination, the combination weights are speaker dependent + rather than universal weights on score level fusion and + there is no need for extra-data to estimate them. An + experiment on the NIST 2006 speaker recognition evaluation + dataset (all trial) was done using three different kernel + functions (GLDS kernel, linear and Gaussian GMM supervector + kernels). We compared our kernel combination to the optimal + linear score fusion obtained using logistic regression. + This optimal score fusion was trained on the same test + data. We had an equal error rate of $\simeq 5,9\%$ using + the kernel combination technique which is better than the + optimal score fusion system ($\simeq 6,0\%$).} +} + +@InProceedings{ dehak.08.odysseyb, + author = {Najim Dehak and R\'eda Dehak and Patrick Kenny and Pierre + Dumouchel}, + title = {Comparison Between Factor Analysis and {GMM} Support + Vector Machines for Speaker Verification}, + booktitle = {Proceedings of the Speaker and Language Recognition + Workshop (IEEE-Odyssey 2008)}, + year = 2008, + address = {Stellenbosch, South Africa}, + month = jan, + urllrde = {200709-ODYSSEY-B}, + abstract = {We present a comparison between speaker verification + systems based on factor analysis modeling and support + vector machines using GMM supervectors as features. All + systems used the same acoustic features and they were + trained and tested on the same data sets. We test two types + of kernel (one linear, the other non-linear) for the GMM + support vector machines. The results show that factor + analysis using speaker factors gives the best results on + the core condition of the NIST 2006 speaker recognition + evaluation. The difference is particularly marked on the + English language subset. Fusion of all systems gave an + equal error rate of 4.2\% (all trials) and 3.2\% (English + trials only).} +} + +@InProceedings{ dehak.09.icassp, + author = {Najim Dehak and Patrick Kenny and R\'eda Dehak and Ondrej + Glember and Pierre Dumouchel and Lukas Burget and + Valiantsina Hubeika and Fabio Castaldo}, + title = {Support Vector Machines and Joint Factor Analysis for + Speaker Verification}, + booktitle = {IEEE-ICASSP}, + year = 2009, + address = {Taipei - Taiwan}, + month = apr, + urllrde = {200904-ICASSP}, + abstract = {This article presents several techniques to combine + between Support vector machines (SVM) and Joint Factor + Analysis (JFA) model for speaker verification. In this + combination, the SVMs are applied on different sources of + information produced by the JFA. These informations are the + Gaussian Mixture Model supervectors and speakers and Common + factors. We found that the use of JFA factors gave the best + results especially when within class covariance + normalization method is applied in the speaker factors + space, in order to compensate for the channel effect. The + new combination results are comparable to other classical + JFA scoring techniques.} +} + +@InProceedings{ dehak.09.interspeech, + author = {Najim Dehak and R\'eda Dehak and Patrick Kenny and Niko + Brummer and Pierre Ouellet and Pierre Dumouchel}, + title = {Support Vector Machines versus Fast Scoring in the + Low-Dimensional Total Variability Space for Speaker + Verification}, + booktitle = {Interspeech}, + year = 2009, + month = sep, + urllrde = {200909-INTERSPEECH-B}, + abstract = {This paper presents a new speaker verification system + architecture based on Joint Factor Analysis (JFA) as + feature extractor. In this modeling, the JFA is used to + define a new low-dimensional space named the total + variability factor space, instead of both channel and + speaker variability spaces for the classical JFA. The main + contribution in this approach, is the use of the cosine + kernel in the new total factor space to design two + different systems: the first system is Support Vector + Machines based, and the second one uses directly this + kernel as a decision score. This last scoring method makes + the process faster and less computation complex compared to + others classical methods. We tested several intersession + compensation methods in total factors, and we found that + the combination of Linear Discriminate Analysis and Within + Class Covariance Normalization achieved the best + performance.} +} + +@InProceedings{ dehak.09.interspeechb, + author = {Pierre Dumouchel and Najim Dehak and Yazid Attabi and + R\'eda Dehak and Narj\`es Boufaden}, + title = {Cepstral and Long-Term Features for Emotion Recognition}, + booktitle = {Interspeech}, + year = 2009, + month = sep, + note = {Open Performance Sub-Challenge Prize}, + urllrde = {200909-INTERSPEECH-A}, + abstract = {In this paper, we describe systems that were developed for + the Open Performance Sub-Challenge of the INTERSPEECH 2009 + Emotion Challenge. We participate to both two-class and + five-class emotion detection. For the two-class problem, + the best performance is obtained by logistic regression + fusion of three systems. Theses systems use short- and + long-term speech features. This fusion achieved an absolute + improvement of 2,6\% on the unweighted recall value + compared with [6]. For the five-class problem, we submitted + two individual systems: cepstral GMM vs. long-term GMM-UBM. + The best result comes from a cepstral GMM and produced an + absolute improvement of 3,5\% compared to [6].} +} + +@InProceedings{ dehak.10.nist, + author = {R. Dehak and N.Dehak}, + title = {LRDE {S}peaker {R}ecognition {S}ystem for {NIST-SRE} + 2010}, + booktitle = {NIST 2010 Speaker Recognition Evaluation}, + year = 2010, + address = {Brno, CZ} +} + +@InProceedings{ dehak.10.odyssey, + author = {N. Dehak and R. Dehak and J. Glass and D. Reynolds and P. + Kenny}, + title = {Cosine {S}imilarity {S}coring without {S}core + {N}ormalization {T}echniques}, + booktitle = {Odyssey The Speaker and Language Recognition}, + year = 2010, + address = {Brno, Czech Republic} +} + +@InProceedings{ dehak.10.odyssey2, + author = {S. Shum and N. Dehak and R. Dehak and J. Glass}, + title = {Unsupervised {S}peaker {A}daptation based on the {C}osine + {S}imilarity for {T}ext-{I}ndependent {S}peaker + {V}erification}, + booktitle = {Odyssey The Speaker and Language Recognition}, + year = 2010, + address = {Brno, Czech Republic} +} + +@InProceedings{ dehak.11.icassp, + author = {N. Dehak and Z. Karam and D. Reynolds and R. Dehak and W. + Campbell and J. Glass}, + title = {A {C}hannel-{B}lind {S}ystem for {S}peaker + {V}erification}, + booktitle = {International Conference on Acoustics, Speech and Signal + Processing (ICASSP)}, + pages = {4536--4539}, + year = 2011, + address = {Prage, Czech Republic}, + month = may +} + +@InProceedings{ dehak.11.interspeech, + author = {Najim Dehak and Pedro A. Torres-Carrasquillo and Douglas + Reynolds and Reda Dehak}, + title = {Language {R}ecognition via {I}-{V}ectors and + {D}imensionality {R}eduction}, + booktitle = {INTERSPEECH 2011}, + pages = {857--860}, + year = 2011, + address = {Florence, Italy}, + month = aug +} + +@Article{ dehak.11.taslp, + author = {N. Dehak and P. Kenny and R. Dehak and P. Dumouchel and P. + Ouellet}, + title = {Front-{E}nd {F}actor {A}nalysis {F}or {S}peaker + {V}erification}, + year = 2011, + journal = {IEEE Transactions on Audio, Speech, and Language + Processing}, + volume = 13, + number = 4, + pages = {788--798}, + month = may +} + +@InProceedings{ demaille.05.iticse, + author = {Akim Demaille}, + title = {Making Compiler Construction Projects Relevant to Core + Curriculums}, + booktitle = {Proceedings of the Tenth Annual Conference on Innovation + and Technology in Computer Science Education + ({ITICSE'05})}, + year = 2005, + address = {Universidade Nova de {L}isboa, {M}onte da {P}acarita, + {P}ortugal}, + month = jun, + project = {Tiger}, + urllrde = {200506-ITICSE}, + isbn = {1-59593-024-8}, + pages = {266--270}, + abstract = {Having 300 students a year implement a compiler is a + debatable enterprise, since the industry will certainly + \emph{not} recruit them for this competence. Yet we made + that decision five years ago, for reasons not related to + compiler construction. We detail these motivations, the + resulting compiler design, and how we manage the + assignment. The project meets its goals, since the majority + of former students invariably refer to it as \emph{the} + project that taught them the most.} +} + +@InProceedings{ demaille.06.isola, + author = {Akim Demaille and Sylvain Peyronnet and Beno\^it Sigoure}, + title = {Modeling of Sensor Networks Using {XRM}}, + booktitle = {Proceedings of the 2nd International Symposium on + Leveraging Applications of Formal Methods, Verification and + Validation ({ISoLA'06})}, + year = 2006, + address = {Coral Beach Resort, {P}aphos, {C}yprus}, + month = nov, + project = {Transformers}, + abstract = {Sensor networks are composed of small electronic devices + that embed processors, sensors, batteries, memory and + communication capabilities. One of the main goal in the + design of such systems is the handling of the inherent + complexity of the nodes, strengthened by the huge number of + nodes in the network. For these reasons, it becomes very + difficult to model and verify such systems. In this paper, + we investigate the main characteristics of sensor nodes, + discuss about the use of a language derived from Reactive + Modules for their modeling and propose a language (and a + tool set) that ease the modeling of this kind of systems.}, + urllrde = {200609-ISOLA} +} + +@InProceedings{ demaille.06.rivf, + author = {Akim Demaille and Sylvain Peyronnet and {\relax Th}omas + H\'erault}, + title = {Probabilistic Verification of Sensor Networks}, + booktitle = {Proceedings of the Fourth International Conference on + Computer Sciences, Research, Innovation and Vision for the + Future (RIVF'06)}, + year = 2006, + address = {Ho Chi Minh City, Vietnam}, + isbn = {1-4244-0316-2}, + month = feb, + project = {APMC}, + urllrde = {200602-rivf}, + abstract = {Sensor networks are networks consisting of miniature and + low-cost systems with limited computation power and energy. + Thanks to the low cost of the devices, one can spread a + huge number of sensors into a given area to monitor, for + example, physical change of the environment. Typical + applications are in defense, environment, and design of + ad-hoc networks areas. In this paper, we address the + problem of verifying the correctness of such networks + through a case study. We modelize a simple sensor network + whose aim is to detect the apparition of an event in a + bounded area (such as a fire in a forest). The behaviour of + the network is probabilistic, so we use APMC, a tool that + allows to approximately check the correctness of extremely + large probabilistic systems, to verify it.} +} + +@InProceedings{ demaille.08.fsmnlp, + author = {Akim Demaille and Alexandre Duret-Lutz and Florian Lesaint + and Sylvain Lombardy and Jacques Sakarovitch and Florent + Terrones}, + title = {An {XML} format proposal for the description of weighted + automata, transducers, and regular expressions}, + booktitle = {Proceedings of the seventh international workshop on + Finite-State Methods and Natural Language Processing + (FSMNLP'08)}, + year = 2008, + address = {Ispra, Italia}, + month = sep, + abstract = {We present an XML format that allows to describe a large + class of finite weighted automata and transducers. Our + design choices stem from our policy of making the + implementation as simple as possible. This format has been + tested for the communication between the modules of our + automata manipulation platform Vaucanson, but this document + is less an experiment report than a position paper intended + to open the discussion among the community of automata + software writers.}, + urllrde = {200809-FSMNLP} +} + +@InProceedings{ demaille.08.iticse, + author = {Akim Demaille and Roland Levillain and Beno\^it Perrot}, + title = {A Set of Tools to Teach Compiler Construction}, + booktitle = {Proceedings of the Thirteenth Annual Conference on + Innovation and Technology in Computer Science Education + ({ITICSE'08})}, + pages = {68--72}, + year = 2008, + address = {Universidad Polit\'ecnica de Madrid, Spain}, + month = jun, + project = {Tiger}, + urllrde = {200806-ITICSE}, + abstract = {Compiler construction is a widely used software + engineering exercise, but because most students will not be + compiler writers, care must be taken to make it relevant in + a core curriculum. Auxiliary tools, such as generators and + interpreters, often hinder the learning: students have to + fight tool idiosyncrasies, mysterious errors, and other + poorly educative issues. We introduce a set of tools + especially designed or improved for compiler construction + educative projects in \Cxx. We also provide suggestions + about new approaches to compiler construction. We draw + guidelines from our experience to make tools suitable for + education purposes.} +} + +@Misc{ demaille.08.kex, + author = {Akim Demaille and Roland Levillain}, + title = {Compiler Construction as an Effective Application to Teach + Object-Oriented Programming}, + howpublished = {The seventh ``Killer Examples'' workshop, Worked Examples + for Sound OO Pedagogy, at OOPSLA'08.}, + address = {Nashville, USA}, + month = oct, + year = 2008, + note = {Oral presentation}, + project = {Tiger}, + urllrde = {200810-KEX}, + abstract = {Compiler construction, a course feared by most students, + and a competence seldom needed in the industry. Yet we + claim that compiler construction is wonderful topic that + benefits from virtually all the computer-science topics. In + this paper we show in particular why compiler construction + is a killer example for Object-Oriented Programming, + providing a unique opportunity for students to understand + what it is, what it can be used for, and how it works.} +} + +@InProceedings{ demaille.08.ldta, + oldkeys = {durlin.08.seminar}, + author = {Akim Demaille and Renaud Durlin and Nicolas Pierron and + Beno\^it Sigoure}, + title = {{Semantics driven disambiguation: A comparison of + different approaches}}, + booktitle = {Proceedings of the 8th workshop on Language Descriptions, + Tools and Applications (LDTA'08)}, + year = 2008, + urllrde = {200802-LDTA}, + abstract = {Context-sensitive languages such as \C or \Cxx can be + parsed using a context-free but ambiguous grammar, which + requires another stage, disambiguation, in order to select + the single parse tree that complies with the language's + semantical rules. Naturally, large and complex languages + induce large and complex disambiguation stages. If, in + addition, the parser should be extensible, for instance to + enable the embedding of domain specific languages, the + disambiguation techniques should feature traditional + software-engineering qualities: modularity, extensibility, + scalability and expressiveness. \\ We evaluate three + approaches to write disambiguation filters for \acs{sdf} + grammars: algebraic equations with \acs{asf}, rewrite-rules + with programmable traversals for \stratego, and attribute + grammars with \acr{tag}, our system. To this end we + introduce \phenix, a highly ambiguous language. Its + ``standard'' grammar exhibits ambiguities inspired by those + found in the \C and \Cxx standard grammars. To evaluate + modularity, the grammar is layered: it starts with a small + core language, and several layers add new features, new + production rules, and new ambiguities.}, + project = {Transformers}, + keywords = {Transformers, context-free grammar, attribute grammar, + Stratego, ASF, SDF, disambiguation, parsing, program + transformation, term rewriting} +} + +@InProceedings{ demaille.09.sac, + author = {Akim Demaille and Roland Levillain and Beno\^it Sigoure}, + title = {{TWEAST}: A Simple and Effective Technique to Implement + Concrete-Syntax {AST} Rewriting Using Partial Parsing}, + booktitle = {Proceedings of the 24th Annual ACM Symposium on Applied + Computing (SAC'09)}, + pages = {1924--1929}, + year = 2009, + address = {Waikiki Beach, Honolulu, Hawaii, USA}, + month = mar, + project = {Tiger}, + urllrde = {200903-SAC}, + abstract = {ASTs are commonly used to represent an input/output + program in compilers and language processing tools. Many of + the tasks of these tools consist in generating and + rewriting ASTs. Such an approach can become tedious and + hard to maintain for complex operations, namely program + transformation, optimization, instrumentation, etc. On the + other hand, \emph{concrete syntax} provides a natural and + simpler representation of programs, but it is not usually + available as a direct feature of the aforementioned tools. + We propose a simple technique to implement AST generation + and rewriting in general purpose languages using concrete + syntax. Our approach relies on extensions made in the + scanner and the parser and the use of objects supporting + partial parsing called Text With Embedded Abstract Syntax + Trees (TWEASTS). A compiler for a simple language (Tiger) + written in \Cxx serves as an example, featuring + transformations in concrete syntax: syntactic desugaring, + optimization, code instrumentation such as bounds-checking, + etc. Extensions of this technique to provide a full-fledged + concrete-syntax rewriting framework are presented as well.} +} + +@InProceedings{ denise.06.rt, + author = {Alain Denise and Marie-Claude Gaudel and + Sandrine-Dominique Gouraud and Richard Lassaigne and + Sylvain Peyronnet}, + title = {Uniform Random Sampling of Traces in Very Large Models}, + booktitle = {Proceedings of the 1st international workshop on Random + Testing 2006 (RT06)}, + year = 2006, + series = {ACM digital library}, + pages = {10--19}, + project = {APMC}, + urllrde = {200606-RT}, + abstract = {This paper presents some first results on how to perform + uniform random walks (where every trace has the same + probability to occur) in very large models. The models + considered here are described in a succinct way as a set of + communicating reactive modules. The method relies upon + techniques for counting and drawing uniformly at random + words in regular languages. Each module is considered as an + automaton defining such a language. It is shown how it is + possible to combine local uniform drawings of traces, and + to obtain some global uniform random sampling, without + construction of the global model.} +} + +@Article{ dolstra.10.jfp, + author = {Eelco Dolstra and Andres L\"oh and Nicolas Pierron}, + title = {{NixOS}: A purely functional {Linux} distribution}, + journal = {Journal of Functional Programming}, + year = 2010, + note = {Published online by Cambridge University Press 15 Oct + 2010}, + urllrde = {201010-JFP}, + doi = {10.1017/S0956796810000195} +} + +@InProceedings{ duflot.04.avocs, + author = {Marie Duflot and Laurent Fribourg and {\relax Th}omas + Herault and Richard Lassaigne and Fr\'ed\'eric Magniette + and Stephane Messika and Sylvain Peyronnet and Claudine + Picaronny}, + title = {Probabilistic model checking of the {CSMA/CD}, protocol + using {PRISM} and {APMC}}, + booktitle = {Proceedings of the 4th International Workshop on Automated + Verification of Critical Systems (AVoCS)}, + year = 2004, + series = {Electronic Notes in Theoretical Computer Science Series}, + volume = 128, + issue = 6, + pages = {195--214}, + project = {APMC}, + urllrde = {200409-AVOCS}, + abstract = {Carrier Sense Multiple Access/Collision Detection + (CSMA/CD) is the protocol for carrier transmission access + in Ethernet networks (international standard IEEE 802.3). + On Ethernet, any Network Interface Card (NIC) can try to + send a packet in a channel at any time. If another NIC + tries to send a packet at the same time, a collision is + said to occur and the packets are discarded. The CSMA/CD + protocol was designed to avoid this problem, more precisely + to allow a NIC to send its packet without collision. This + is done by way of a randomized exponential backoff process. + In this paper, we analyse the correctness of the CSMA/CD + protocol, using techniques from probabilistic model + checking and approximate probabilistic model checking. The + tools that we use are PRISM and APMC. Moreover, we provide + a quantitative analysis of some CSMA/CD properties.} +} + +@InCollection{ duflot.06.book, + author = {Marie Duflot and Marta Kwiatkowska and Gethin Norman and + Dave Parker and Sylvain Peyronnet and Claudine Picaronny + and Jeremy Sproston}, + title = {Practical Application of Probabilistic Model Checking to + Communication Protocols}, + booktitle = {FMICS Handbook on Industrial Critical Systems}, + year = 2006, + editor = {Stefania Gnesi and Tiziana Margaria}, + chapter = 7, + note = {To appear}, + project = {APMC}, + urllrde = {200600-BOOK} +} + +@InProceedings{ duret.00.gcse, + author = {Alexandre Duret-Lutz}, + title = {Olena: a component-based platform for image processing, + mixing generic, generative and {OO} programming}, + booktitle = {Proceedings of the 2nd International Symposium on + Generative and Component-Based Software Engineering + (GCSE)---Young Researchers Workshop; published in + ``Net.ObjectDays2000''}, + pages = {653--659}, + year = 2000, + address = {Erfurt, Germany}, + month = oct, + isbn = {3-89683-932-2}, + project = {Olena}, + urllrde = {200010-NetObjectDays}, + abstract = {This paper presents Olena, a toolkit for programming and + designing image processing chains in which each processing + is a component. But since there exist many image types + (different structures such as 2D images, 3D images or + graphs, as well as different value types) the platform has + been designed with genericity and reusability in mind: each + component is written as a generic C++ procedure, \`a la + STL. Other libraries, such as Khoros [Kon94] have a + different approach where a processing component contains an + implementation for each type supported by the library. This + makes code maintenance hard and prevents easy addition of + new image types. Still, Olena is not only a generic + component library [Jaz95], it shall contain additional + tools such as a visual programming environment (VPE). Those + tools may be programmed in a classical object-oriented + fashion (using operation and inclusion polymorphism) which + may seems antagonist with the generic programming paradigm + used in the library. Section 2 outlines the architecture of + Olena and elaborates more on the design problems resulting + from the use of generic components. Section 3 presents the + solution chosen to address these problems.} +} + +@InProceedings{ duret.01.ae, + author = {Alexandre Duret-Lutz}, + title = {Expression templates in {A}da~95}, + booktitle = {Proceedings of the 6th International Conference on + Reliable Software Technologies (Ada-Europe)}, + year = 2001, + series = {Lecture Notes in Computer Science Series}, + volume = 2043, + address = {Leuven, Belgium}, + month = may, + publisher = {Springer-Verlag}, + pages = {191--202}, + note = {Best Paper Award.}, + project = {Software}, + urllrde = {200105-Ae}, + abstract = {High-order matrix or vector expressions tend to be + penalized by the use of huge temporary variables. + Expression templates is a C++ technique which can be used + to avoid these temporaries, in a way that is transparent to + the user. We present an Ada adaptation of this technique + which - while not transparent - addresses the same + efficiency issue as the original. We make intensive use of + the signature idiom to combine packages together, and + discuss its importance in generic programming. Finally, we + express some concerns about generic programming in Ada.} +} + +@InProceedings{ duret.01.coots, + author = {Alexandre Duret-Lutz and {\relax Th}ierry G\'eraud and + Akim Demaille}, + title = {Generic design patterns in {C++}}, + booktitle = {Proceedings of the 6th USENIX Conference on + Object-Oriented Technologies and Systems (COOTS)}, + year = 2001, + address = {San Antonio, TX, USA}, + pages = {189--202}, + month = {January-February}, + publisher = {USENIX Association}, + project = {Software}, + urllrde = {200102-Coots}, + abstract = {Generic programming is a paradigm whose wide adoption by + the C++ community is quite recent. In this approach most + classes and procedures are parameterized, leading to the + construction of general and efficient software components. + In this paper, we show how some design patterns from Gamma + et al. can be adapted to this paradigm. Although these + patterns rely highly on dynamic binding. We show that, by + making intensive use of parametric polymorphism in the + context of generic programming, the method calls in these + patterns can be resolved at compile-time. The speed-up + achieved using these patterns is significant.} +} + +@InProceedings{ duret.09.atva, + author = {Alexandre Duret-Lutz and Denis Poitrenaud and Jean-Michel + Couvreur}, + title = {On-the-fly Emptiness Check of Transition-based {S}treett + Automata}, + booktitle = {Proceedings of the 7th International Symposium on + Automated Technology for Verification and Analysis + (ATVA'09)}, + year = 2009, + editor = {Zhiming Liu and Anders P. Ravn}, + series = {Lecture Notes in Computer Science}, + publisher = {Springer-Verlag}, + pages = {213--227}, + volume = 5799, + abstract = {In the automata theoretic approach to model checking, + checking a state-space $S$ against a linear-time property + $\varphi$ can be done in $\RO(|S|\times + 2^{\RO(|\varphi|)})$ time. When model checking under $n$ + strong fairness hypotheses expressed as a Generalized + B\"uchi automaton, this complexity becomes $\RO(|S|\times + 2^{\RO(|\varphi|+n)})$.\par Here we describe an algorithm + to check the emptiness of Streett automata, which allows + model checking under $n$ strong fairness hypotheses in + $\RO(|S|\times 2^{\RO(|\varphi|)}\times n)$. We focus on + transition-based Streett automata, because it allows us to + express strong fairness hypotheses by injecting Streett + acceptance conditions into the state-space without any blowup.}, + urllrde = {200910-ATVA} +} + +@TechReport{ duret.11.arxiv, + author = {Alexandre Duret-Lutz and Kais Klai and Denis Poitrenaud + and Yann Thierry-Mieg}, + title = {Combining Explicit and Symbolic Approaches for Better + On-the-Fly {LTL} Model Checking}, + institution = {arXiv}, + year = 2011, + number = {1106.5700}, + month = jun, + note = {Extended version of our ATVA'11 paper, presenting two new + techniques instead of one.}, + url = {http://arxiv.org/abs/1106.5700}, + urllrde = {201106-ARXIV}, + abstract = {We present two new hybrid techniques that replace the + synchronized product used in the automata-theoretic + approach for LTL model checking. The proposed products are + explicit graphs of aggregates (symbolic sets of states) + that can be interpreted as B\"uchi automata. These hybrid + approaches allow on the one hand to use classical + emptiness-check algorithms and build the graph on-the-fly, + and on the other hand, to have a compact encoding of the + state space thanks to the symbolic representation of the + aggregates. The \emph{Symbolic Observation Product} assumes + a globally stuttering property (e.g., LTL$\setminus \X$) to + aggregate states. The \emph{Self-Loop Aggregation Product} + does not require the property to be globally stuttering + (i.e., it can tackle full LTL), but dynamically detects and + exploits a form of stuttering where possible. Our + experiments show that these two variants, while + incomparable with each other, can outperform other existing + approaches.} +} + +@InProceedings{ duret.11.atva, + author = {Alexandre Duret-Lutz and Kais Klai and Denis Poitrenaud + and Yann Thierry-Mieg}, + title = {Self-Loop Aggregation Product --- A New Hybrid Approach to + On-the-Fly {LTL} Model Checking}, + booktitle = {Proceedings of the 9th International Symposium on + Automated Technology for Verification and Analysis + (ATVA'11)}, + year = 2011, + series = {Lecture Notes in Computer Science}, + volume = {6996}, + pages = {336--350}, + address = {Taipei, Taiwan}, + month = oct, + publisher = {Springer}, + urllrde = {201110-ATVA}, + abstract = {We present the \emph{Self-Loop Aggregation Product} + (SLAP), a new hybrid technique that replaces the + synchronized product used in the automata-theoretic + approach for LTL model checking. The proposed product is an + explicit graph of aggregates (symbolic sets of states) that + can be interpreted as a B\"uchi automata. The criterion + used by SLAP to aggregate states from the Kripke structure + is based on the analysis of self-loops that occur in the + B\"uchi automaton expressing the property to verify. Our + hybrid approach allows on the one hand to use classical + emptiness-check algorithms and build the graph on-the-fly, + and on the other hand, to have a compact encoding of the + state space thanks to the symbolic representation of the + aggregates. Our experiments show that this technique often + outperforms other existing (hybrid or fully symbolic) + approaches.} +} + +@Misc{ duret.11.sumo, + author = {Alexandre Duret-Lutz}, + title = {Building {LTL} Model Checkers using {T}ransition-based + {G}eneralized {B\"u}chi {A}utomata}, + howpublished = {Invited talk to SUMo'11}, + month = jun, + year = 2011 +} + +@InProceedings{ duret.11.vecos, + author = {Alexandre Duret-Lutz}, + title = {{LTL} Translation Improvements in {Spot}}, + booktitle = {Proceedings of the 5th International Workshop on + Verification and Evaluation of Computer and Communication + Systems (VECoS'11)}, + year = {2011}, + series = {Electronic Workshops in Computing}, + address = {Tunis, Tunisia}, + month = sep, + publisher = {British Computer Society}, + abstract = {Spot is a library of model-checking algorithms. This paper + focuses on the module translating LTL formul{\ae} into + automata. We discuss improvements that have been + implemented in the last four years, we show how Spot's + translation competes on various benchmarks, and we give + some insight into its implementation.}, + url = {http://ewic.bcs.org/category/15853}, + urllrde = {201109-VECOS} +} + +@InProceedings{ fabre.00.egve, + author = {Yoann Fabre and Guillaume Pitel and Laurent Soubrevilla + and Emmanuel Marchand and {\relax Th}ierry G\'eraud and + Akim Demaille}, + title = {An asynchronous architecture to manage communication, + display, and user interaction in distributed virtual + environments}, + booktitle = {Virtual Environments 2000, Proceedings of the 6th + Eurographics Workshop on Virtual Environments (EGVE)}, + year = 2000, + address = {Amsterdam, The Netherlands}, + month = jun, + pages = {105--113}, + series = {Computer Science / Eurographics Series}, + editor = {J.D. Mulder and R. van Liere}, + publisher = {Springer-Verlag WienNewYork}, + project = {Urbi}, + urllrde = {200006-Egve}, + abstract = {In Distributed Virtual Environments, each machine runs the + same software, which is in charge of handling the + communications over the network, providing the user with a + view of the world, and processing his requests. A major + issue in the design of such a software is to ensure that + network communication does not degrade the interactivity + between the machine and the user. In this paper, we present + a software designed to achieve this goal, based on tools + rarely used in this area.} +} + +@InProceedings{ fabre.00.vsmm, + author = {Yoann Fabre and Guillaume Pitel and Didier Verna}, + title = {Urbi et {O}rbi: unusual design and implementation choices + for distributed virtual environments}, + booktitle = {Proceedings of the 6th International Conference on Virtual + Systems and MultiMedia (VSMM)---Intelligent Environments + Workshop}, + pages = {714--724}, + year = 2000, + address = {Gifu, Japan}, + month = oct, + publisher = {IOS Press, USA}, + isbn = {1-58603-108-2}, + project = {Urbi}, + urllrde = {200010-Vsmm}, + abstract = {This paper describes Urbi et Orbi, a distributed virtual + environment (DVE) project that is being conducted in the + Research and Development Laboratory at EPITA. Our ultimate + goal is to provide support for large scale multi-user + virtual worlds on end-user machines. The incremental + development of this project led us to take unusual design + and implementation decisions that we propose to relate in + this paper. Firstly, a general overview of the project is + given, along with the initial requirements we wanted to + meet. Then, we go on with a description of the system's + architecture. Lastly, we describe and justify the unusual + choices we have made in the project's internals.} +} + +@InProceedings{ fabre.00.vw, + author = {Yoann Fabre and Guillaume Pitel and Laurent Soubrevilla + and Emmanuel Marchand and {\relax Th}ierry G\'eraud and + Akim Demaille}, + title = {A framework to dynamically manage distributed virtual + environments}, + booktitle = {Proceedings of the 2nd International Conference on Virtual + Worlds (VW)}, + year = 2000, + address = {Paris, France}, + month = jul, + pages = {54--64}, + editor = {J.-C. Heudin}, + publisher = {Springer Verlag}, + series = {Lecture Notes in Computer Science Series}, + volume = {LNAI 1834}, + project = {Urbi}, + urllrde = {200007-VW}, + abstract = {In this paper, we present the project urbi, a framework to + dynamically manage distributed virtual environments (DVEs). + This framework relies on a dedicated scripting language, + goal, which is typed, object-oriented and dynamically + bound. goal is interpreted by the application hosted by + each machine and is designed to handle efficiently both + network communications and interactivity. Finally, we have + made an unusual design decision: our project is based on a + functional programming language, ocaml.} +} + +@InProceedings{ fouquier.07.gbr, + author = {Geoffroy Fouquier and Jamal Atif and Isabelle Bloch}, + title = {Local reasoning in fuzzy attribute graphs for optimizing + sequential segmentation}, + booktitle = {Proceedings of the 6th IAPR TC-15 Workshop on Graph-based + Representations in Pattern Recognition (GBR)}, + year = 2007, + month = jun, + address = {Alicante, Spain}, + volume = {LNCS 4538}, + editor = {F. Escolano and M. Vento}, + publisher = {Springer Verlag}, + isbn = {978-3-540-72902-0}, + pages = {138--147}, + urllrde = {200706-GBR}, + abstract = {Spatial relations play a crucial role in model-based image + recognition and interpretation due to their stability + compared to many other image appearance characteristics. + Graphs are well adapted to represent such information. + Sequential methods for knowledge-based recognition of + structures require to define in which order the structures + have to be recognized. We propose to address this problem + of order definition by developing algorithms that + automatically deduce sequential segmentation paths from + fuzzy spatial attribute graphs. As an illustration, these + algorithms are applied on brain image understanding.} +} + +@InProceedings{ fouquier.07.icassp, + author = {Geoffroy Fouquier and Laurence Likforman and J\'er\^ome + Darbon and Bulent Sankur}, + title = {The Biosecure Geometry-based System for Hand Modality}, + booktitle = {Proceedings of the 32nd IEEE International Conference on + Acoustics, Speech, and Signal Processing (ICASSP)}, + year = 2007, + month = apr, + address = {Honolulu, Hawaii, USA}, + volume = {I}, + pages = {801--804}, + isbn = {1-4244-0728-1}, + urllrde = {200704-ICASSP}, + abstract = {We present an identification and authentification system + based on hand modality which is part of a reference system + for all modalities developed within the Biosecure + consortium. It relies on simple geometric features + extracted from hand boundary. The different steps of this + system are detailed, namely: pre-processing, feature + extraction and hand matching. This system has been tested + on the Biosecure hand database which consists of 4500 hand + images of 750 individuals. Results are detailed with + respect to different enrolment conditions such as + population size, enrolment size, and image resolution.} +} + +@InProceedings{ geraud.00.europlop, + author = {{\relax Th}ierry G\'eraud and Alexandre Duret-Lutz}, + title = {Generic programming redesign of patterns}, + booktitle = {Proceedings of the 5th European Conference on Pattern + Languages of Programs (EuroPLoP)}, + year = 2000, + month = jul, + address = {Irsee, Germany}, + pages = {283--294}, + editors = {M. Devos and A. R\"uping}, + publisher = {UVK, Univ. Verlag, Konstanz}, + project = {Software}, + urllrde = {200007-EuroPlop}, + abstract = {This pattern faces the problem of improving the + performances of design patterns when they are involved in + intensive algorithms. Generic programming is a paradigm in + which most classes and procedures are parameterized, thus + leading to the construction of general and efficient + software components. We demonstrate that some design + patterns from Gamma et al. can be translated into this + paradigm while handling operation polymorphism by + parametric polymorphism. We thus preserve their modularity + and reusability properties but we avoid the performance + penalty due to their dynamic behavior, which is a critical + issue in numerical computing.} +} + +@InProceedings{ geraud.00.icpr, + author = {{\relax Th}ierry G\'eraud and Yoann Fabre and Alexandre + Duret-Lutz and Dimitri Papadopoulos-Orfanos and + Jean-Fran\c{c}ois Mangin}, + title = {Obtaining genericity for image processing and pattern + recognition algorithms}, + booktitle = {Proceedings of the 15th International Conference on + Pattern Recognition (ICPR)}, + year = 2000, + month = sep, + address = {Barcelona, Spain}, + volume = 4, + pages = {816--819}, + publisher = {IEEE Computer Society}, + project = {Olena}, + urllrde = {200009-Icpr}, + abstract = {Algorithm libraries dedicated to image processing and + pattern recognition are not reusable; to run an algorithm + on particular data, one usually has either to rewrite the + algorithm or to manually ``copy, paste, and modify''. This + is due to the lack of genericity of the programming + paradigm used to implement the libraries. In this paper, we + present a recent paradigm that allows algorithms to be + written once and for all and to accept input of various + types. Moreover, this total reusability can be obtained + with a very comprehensive writing and without significant + cost at execution, compared to a dedicated algorithm. This + new paradigm is called ``generic programming'' and is fully + supported by the C++ language. We show how this paradigm + can be applied to image processing and pattern recognition + routines. The perspective of our work is the creation of a + generic library.} +} + +@InProceedings{ geraud.00.rfia, + author = {{\relax Th}ierry G\'eraud and Isabelle Bloch and Henri + Ma{\^\i}tre}, + title = {Reconnaissance de structures c\'er\'ebrales \`a l'aide + d'un atlas et par fusion d'informations structurelles floues}, + booktitle = {Actes du 12\`eme Congr\`es Francophone AFRIF-AFIA de + Reconnaissance des Formes et Intelligence Artificielle + (RFIA)}, + year = 2000, + address = {Paris, France}, + month = feb, + volume = 1, + pages = {287--295}, + note = {EPITA as current address.}, + category = {national}, + project = {Image}, + urllrde = {200002-RFIA}, + abstract = {Nous proposons une proc\'edure automatique de + reconnaissance progressive des structures internes du + cerveau guid\'ee par un atlas anatomique. L'originalit\'e + de notre proc\'edure est multiple. D'une part, elle prend + en compte des informations structurelles sous la forme de + contraintes spatiales flexibles, en utilisant les + formalismes de la th\'eorie des ensembles flous et de la + fusion d'informations. D'autre part, le calcul de la + correspondance entre volume IRM et atlas que nous proposons + permet d'inf\'erer un champ de d\'eformations discret, + respectant des contraintes sur la surface des objets. + Enfin, le caract\`ere s\'equentiel de la proc\'edure permet + de s'appuyer sur la connaissance des objets d\'ej\`a + segment\'es pour acc\'eder \`a des objets dont l'obtention + est a priori de plus en plus difficile.} +} + +@InProceedings{ geraud.01.ai, + author = {{\relax Th}ierry G\'eraud and Yoann Fabre and Alexandre + Duret-Lutz}, + title = {Applying generic programming to image processing}, + booktitle = {Proceedings of the IASTED International Conference on + Applied Informatics (AI)---Symposium on Advances in + Computer Applications}, + year = 2001, + publisher = {ACTA Press}, + editor = {M.H.~Hamsa}, + address = {Innsbruck, Austria}, + pages = {577--581}, + month = feb, + project = {Olena}, + urllrde = {200102-Ai}, + abstract = {This paper presents the evolution of algorithms + implementation in image processing libraries and discusses + the limits of these implementations in terms of + reusability. In particular, we show that in C++, an + algorithm can have a general implementation; said + differently, an implementation can be generic, i.e., + independent of both the input aggregate type and the type + of the data contained in the input aggregate. A total + reusability of algorithms can therefore be obtained; + moreover, a generic implementation is more natural and does + not introduce a meaningful additional cost in execution + time as compared to an implementation dedicated to a + particular input type.} +} + +@InProceedings{ geraud.01.icip, + author = {{\relax Th}ierry G\'eraud and Pierre-Yves Strub and + J\'er\^ome Darbon}, + title = {Color image segmentation based on automatic morphological + clustering}, + booktitle = {Proceedings of the IEEE International Conference on Image + Processing (ICIP)}, + year = 2001, + volume = 3, + pages = {70--73}, + address = {Thessaloniki, Greece}, + month = oct, + project = {Image}, + urllrde = {200110-Icip}, + abstract = {We present an original method to segment color images + using a classification in the 3-D color space. In the case + of ordinary images, clusters that appear in 3-D histograms + usually do not fit a well-known statistical model. For that + reason, we propose a classifier that relies on mathematical + morphology, and more precisely on the watershed algorithm. + We show on various images that the expected color clusters + are correctly identified by our method. Last, to segment + color images into coherent regions, we perform a Markovian + labeling that takes advantage of the morphological + classification results.} +} + +@InProceedings{ geraud.01.icisp, + author = {{\relax Th}ierry G\'eraud and Pierre-Yves Strub and + J\'er\^ome Darbon}, + title = {Segmentation d'images en couleur par classification + morphologique non supervis\'ee}, + booktitle = {Proceedings of the International Conference on Image and + Signal Processing (ICISP)}, + year = 2001, + pages = {387--394}, + address = {Agadir, Morocco}, + month = may, + publisher = {Faculty of Sciences at Ibn Zohr University, Morocco}, + note = {In French}, + project = {Image}, + urllrde = {200105-Icisp}, + abstract = {In this paper, we present an original method to segment + color images using a classification of the image histogram + in the 3D color space. As color modes in natural images + usually do not fit a well-known statistical model, we + propose a classifier that rely on mathematical morphology + and, more particularly, on the watershed algorithm. We show + on various images that the expected color modes are + correctly identified and, in order to obtain coherent + region, we extend the method to make the segmentation + contextual.} +} + +@InProceedings{ geraud.03.grec, + author = {{\relax Th}ierry G\'eraud and Geoffroy Fouquier and Quoc + Peyrot and Nicolas Lucas and Franck Signorile}, + title = {Document type recognition using evidence theory}, + booktitle = {Proceedings of the 5th IAPR International Workshop on + Graphics Recognition (GREC)}, + year = 2003, + pages = {212--221}, + editors = {Josep Llad\`os}, + address = {Computer Vision Center, UAB, Barcelona, Spain}, + month = jul, + project = {Image}, + urllrde = {200307-Grec}, + abstract = {This paper presents a method to recognize the type of a + document when a database of models (document types) is + given. For instance, when every documents are forms and + when we know every different types of forms, we want to be + able to assign to an input document its type of form. To + that aim, we define each model by a set of characteristics + whose nature can vary from one to another. For instance, a + characteristic can be having a flower-shaped logo on + top-left as well as having about 12pt fonts. This paper + does not intent to explain how to extract such knowledge + from documents but it describes how to use such information + to decide what the type of a given document is when + different document types are described by + characteristics.} +} + +@InProceedings{ geraud.03.ibpria, + author = {{\relax Th}ierry G\'eraud}, + title = {Segmentation of curvilinear objects using a + watershed-based curve adjacency graph}, + booktitle = {Proceedings of the 1st Iberian Conference on Pattern + Recognition and Image Analysis (IbPRIA)}, + pages = {279--286}, + year = 2003, + editor = {Springer-Verlag}, + volume = 2652, + series = {Lecture Notes in Computer Science Series}, + address = {Mallorca, Spain}, + month = jun, + publisher = {Springer-Verlag}, + project = {Image}, + urllrde = {200306-Ibpria}, + abstract = {This paper presents a general framework to segment + curvilinear objects in 2D images. A pre-processing step + relies on mathematical morphology to obtain a connected + line which encloses curvilinear objects. Then, a graph is + constructed from this line and a Markovian Random Field is + defined to perform objects segmentation. Applications of + our framework are numerous: they go from simple surve + segmentation to complex road network extraction in + satellite images.} +} + +@InProceedings{ geraud.03.icisp, + author = {{\relax Th}ierry G\'eraud}, + title = {Segmentation d'objets curvilignes \`a l'aide des champs de + Markov sur un graphe d'adjacence de courbes issu de + l'algorithme de la ligne de partage des eaux}, + booktitle = {Proceedings of the International Conference on Image and + Signal Processing (ICISP)}, + year = 2003, + volume = 2, + pages = {404--411}, + address = {Agadir, Morocco}, + month = jun, + publisher = {Faculty of Sciences at Ibn Zohr University, Morocco}, + note = {In French}, + project = {Image}, + urllrde = {200306-Icisp}, + abstract = {This paper presents a general framework to segment + curvilinear objects in 2D images. A pre-processing step + relies on mathematical morphology to obtain a connected + line which encloses curvilinear objects. Then, a graph is + constructed from this line and a Markovian Random Field is + defined to perform objects segmentation. Applications of + our framework are numerous: they go from simple surve + segmentation to complex road network extraction in + satellite images.} +} + +@InProceedings{ geraud.03.nsip, + author = {{\relax Th}ierry G\'eraud}, + title = {Fast Road Network Extraction in Satellite Images using + Mathematical Morphology and {MRF}}, + booktitle = {Proceedings of the EURASIP Workshop on Nonlinear Signal + and Image Processing (NSIP)}, + year = 2003, + address = {Trieste, Italy}, + month = jun, + project = {Image}, + urllrde = {200306-Nsip}, + abstract = {This paper presents a fast method to extract road network + in satellite images. A pre-processing stage relies on + mathematical morphology to obtain a connected line which + encloses road network. Then, a graph is constructed from + this line and a Markovian Random Field is defined to + perform road extraction.} +} + +@InProceedings{ geraud.04.iccvg, + author = {{\relax Th}ierry G\'eraud and Giovanni Palma and Niels + {Van Vliet}}, + title = {Fast color image segmentation based on levellings in + feature Space}, + booktitle = {Computer Vision and Graphics---International Conference on + Computer Vision and Graphics (ICCVG), Warsaw, Poland, + September 2004}, + year = 2004, + series = {Computational Imaging and Vision}, + volume = 32, + editor = {Kluwer Academic Publishers}, + pages = {800--807}, + note = {On CD.}, + project = {Image}, + urllrde = {200408-ICCVG}, + abstract = {This paper presents a morphological classifier with + application to color image segmentation. The basic idea of + a morphological classifier is to consider that a color + histogram is a 3D gray-level image and that morphological + operators can be applied to modify this image. The final + objective is to extract clusters in color space, that is, + identify regions in the 3D image. In this paper, we + particularly focus on a powerful class of morphology-based + filters called levellings to transform the 3D + histogram-image to identify clusters. We also show that our + method gives better results than the ones of + state-of-the-art methods.} +} + +@Article{ geraud.04.jasp, + author = {{\relax Th}ierry G\'eraud and Jean-Baptiste Mouret}, + title = {Fast road network extraction in satellite images using + mathematical morphology and {M}arkov random fields}, + journal = {EURASIP Journal on Applied Signal Processing}, + year = 2004, + number = 16, + volume = 2004, + pages = {2503--2514}, + month = nov, + note = {Special issue on Nonlinear Signal and Image Processing - + Part II}, + project = {Image}, + doi = {http://doi.acm.org/10.1155/S1110865704409093}, + urllrde = {200409-JASP}, + abstract = {This paper presents a fast method for road network + extraction in satellite images. It can be seen as a + transposition of the segmentation scheme "watershed + transform + region adjacency graph + Markov random fields" + to the extraction of curvilinear objects. Many road + extractors can be found in the literature which are + composed of two stages. The first one acts like a filter + that can decide from a local analysis, at every image + point, if there is a road or not. The second stage aims at + obtaining the road network structure. In the method we + propose, we rely on a "potential" image, that is, + unstructured image data that can be derived from any road + extractor filter. In such a potential image, the value + assigned to a point is a measure of its likelihood to be + located in the middle of a road. A filtering step applied + on the potential image relies on the area closing operator + followed by the watershed transform to obtain a connected + line which encloses the road network. Then a graph + describing adjacency relationships between watershed lines + is built. Defining Markov random fields upon this graph, + associated with an energetic model of road networks, leads + to the expression of road network extraction as a global + energy minimization problem. This method can easily be + adapted to other image processing fields where the + recognition of curvilinear structures is involved.} +} + +@InProceedings{ geraud.05.ismm, + author = {{\relax Th}ierry G\'eraud}, + title = {Ruminations on {T}arjan's {U}nion-{F}ind algorithm and + connected operators}, + booktitle = ismm05, + year = 2005, + address = {Paris, France}, + month = apr, + pages = {105--116}, + publisher = {Springer}, + series = {Computational Imaging and Vision}, + volume = 30, + project = {Image}, + urllrde = {200504-ISMM}, + abstract = {This papers presents a comprehensive and general form of + the Tarjan's union-find algorithm dedicated to connected + operators. An interesting feature of this form is to + introduce the notion of separated domains. The properties + of this form and its flexibility are discussed and + highlighted with examples. In particular, we give clues to + handle correctly the constraint of domain-disjointness + preservation and, as a consequence, we show how we can rely + on ``union-find'' to obtain algorithms for self-dual + filters approaches and levelings with a marker function.} +} + +@InProceedings{ geraud.08.mpool, + author = {{\relax Th}ierry G\'eraud and Roland Levillain}, + title = {Semantics-Driven Genericity: A Sequel to the Static {C++} + Object-Oriented Programming Paradigm ({SCOOP 2})}, + booktitle = {Proceedings of the 6th International Workshop on + Multiparadigm Programming with Object-Oriented Languages + (MPOOL)}, + year = 2008, + address = {Paphos, Cyprus}, + month = jul, + project = {Olena}, + urllrde = {200807-MPOOL}, + abstract = {Classical (unbounded) genericity in \Cxx{}03 defines the + interactions between generic data types and algorithms in + terms of concepts. Concepts define the requirements over a + type (or a parameter) by expressing constraints on its + methods and dependent types (typedefs). The upcoming + \Cxx{}0x standard will promote concepts from abstract + entities (not directly enforced by the tools) to language + constructs, enabling compilers and tools to perform + additional checks on generic constructs as well as enabling + new features (e.g., concept-based overloading). Most modern + languages support this notion of signature on generic + types. However, generic types built on other types and + relying on concepts to both ensure type conformance and + drive code specialization, restrain the interface and the + implementation of the newly created type: specific methods + and associated types not mentioned in the concept will not + be part of the new type. The paradigm of concept-based + genericity lacks the required semantics to transform types + while retaining or adapting their intrinsic capabilities. + We present a new form of semantically-enriched genericity + allowing static generic type transformations through a + simple form of type introspection based on type metadata + called properties. This approach relies on a new Static + \Cxx Object-Oriented Programming (SCOOP) paradigm, and is + adapted to the creation of generic and efficient libraries, + especially in the field of scientific computing. Our + proposal uses a metaprogramming facility built into a \Cxx + library called Static, and doesn't require any language + extension nor additional processing (preprocessor, + transformation tool).} +} + +@InCollection{ geraud.10.book, + author = {{\relax Th}ierry G\'eraud and Hugues Talbot and Marc Van + Droogenbroeck}, + title = {Algorithms for Mathematical Morphology}, + booktitle = {Mathematical Morphology---From Theory to Applications}, + pages = {323--353}, + publisher = {Wiley-ISTE}, + year = 2010, + editor = {Laurent Najman and Hugues Talbot}, + isbn = {978-1-84821-215-2}, + month = jul, + url = {http://eu.wiley.com/WileyCDA/WileyTitle/productCd-1848212151.html} + , + urllrde = {201007-BOOK} +} + +@InCollection{ geraud.10.livre, + author = {{\relax Th}ierry G\'eraud and Hugues Talbot and Marc Van + Droogenbroeck}, + title = {Morphologie et algorithmes}, + booktitle = {Morphologie math\'ematique 2~: estimation, choix et mise + en {\oe}uvre}, + pages = {151--180}, + publisher = {Herm\`es Science Publications}, + year = 2010, + series = {IC2 signal et image}, + chapter = 6, + editor = {Laurent Najman and Hugues Talbot}, + month = sep, + urllrde = {201009-LIVRE} +} + +@InProceedings{ geraud.99.cimaf, + author = {{\relax Th}ierry G\'eraud and Isabelle Bloch and Henri + Ma\^tre}, + title = {Atlas-guided recognition of cerebral structures in {MRI} + using fusion of fuzzy structural information}, + booktitle = {Proceeding of CIMAF Symposium on Artificial Intelligence}, + pages = {99--106}, + year = 1999, + address = {La Havana, Cuba}, + note = {EPITA as current address.}, + project = {Image}, + urllrde = {199900-CIMAF} +} + +@InProceedings{ geraud.99.gretsi, + author = {{\relax Th}ierry G\'eraud and Yoann Fabre and Dimitri + Papadopoulos-Orfanos and Jean-Fran\c{c}ois Mangin}, + title = {Vers une r\'eutilisabilit\'e totale des algorithmes de + traitement d'images}, + booktitle = {Proceedings of the 17th Symposium on Signal and Image + Processing (GRETSI)}, + category = {national}, + pages = {331--334}, + volume = 2, + year = 1999, + address = {Vannes, France}, + month = sep, + note = {In French}, + project = {Olena}, + urllrde = {199909-Gretsi}, + abstract = {Cet article pr\'esente l'\'evolution des techniques de + programmation d'algorithmes de traitement d'images et + discute des limites de la r\'eutilisabilit\'e de ces + algorithmes. En particulier, nous montrons qu'en C++ un + algorithme peut s'\'ecrire sous une forme g\'en\'erale, + ind\'ependante aussi bien du type des donn\'ees que du type + des structures de donn\'ees sur lesquelles il peut + s'appliquer. Une r\'eutilisabilit\'e totale des algorithmes + peut donc \^etre obtenue ; mieux, leur \'ecriture est plus + naturelle et elle n'introduit pas de surco\^ut significatif + en temps d'ex\'ecution.} +} + +@Misc{ gournet.05.sud, + author = {Alexandre Borghi and Valentin David and Akim Demaille and + Olivier Gournet}, + title = {Implementing attributes in {SDF}}, + year = 2005, + address = {Utrecht {U}niversity, {N}etherland}, + note = {Communication to Stratego Users Day 2005}, + month = may, + project = {Transformers}, + urllrde = {200505-SUD-ag}, + abstract = {Attribute Grammars (AGs) provide a very convenient means + to bind semantics to syntax. They enjoy an extensive + bibliography and are used in several types of applications. + Yet, to our knowledge, their use to disambiguate is novel. + We present our implementation of an evaluator of attributes + for ambiguous AGs, tailored to ambiguous parse trees + disambiguation. This paper focuses on its implementation + that heavily relies on Stratego/XT, which is also used as + language to express the attribute rules. A companion paper + presents the disambiguation process in details + 200505-SUD-disamb.} +} + +@InProceedings{ grosicki.04.icc, + author = {Emmanuel Grosicki and Karim Abed-Meraim and R\'eda Dehak}, + title = {A novel method to fight the non line of sight error in + {AOA} measurements for mobile location}, + booktitle = {Proceedings of the IEEE International Conference on + Communications (ICC)}, + year = 2004, + volume = 5, + pages = {2794--2798}, + address = {Paris, France}, + month = jun, + project = {Image}, + urllrde = {200406-ICC}, + abstract = {In this contribution, a mobile location method is provided + using measurements from two different Base-Stations. + Although computationally from two different Base-Stations. + Although based on a simple trilateration and takes into + account error measurements caused by Non-Line-Of-Sight + (NLOS) and near-far effect. The new method attributes an + index of confidence for each measure, in order to allow the + mobile to select the two most reliable measures and not to + use all measures, equally.} +} + +@InProceedings{ guirado.05.pdmc, + author = {Guillaume Guirado and {\relax Th}omas Herault and Richard + Lassaigne and Sylvain Peyronnet}, + title = {Distribution, approximation and probabilistic model + checking}, + booktitle = {Proceedings of the 4th international workshop on Parallel + and Distributed Model Checking (PDMC)}, + year = 2005, + project = {APMC}, + urllrde = {200507-Pdmc}, + abstract = {APMC is a model checker dedicated to the quantitative + verification of fully probabilistic systems against LTL + formulas. Using a Monte-Carlo method in order to + efficiently approximate the verification of probabilistic + specifications, it could be used naturally in a distributed + framework. We present here the tool and his distribution + scheme, together with extensive performance evaluation, + showing the scalability of the method, even on clusters + containing 500+ heterogeneous workstations.} +} + +@InProceedings{ hamez.07.pohll, + author = {Alexandre Hamez and Fabrice Kordon and Yann Thierry-Mieg}, + title = {{libDMC}: a library to Operate Efficient Distributed Model + Checking}, + booktitle = {Workshop on Performance Optimization for High-Level + Languages and Libraries --- associated to IPDPS'2007}, + year = 2007, + project = {Verification}, + urllrde = {200703-POHLL}, + abstract = {Model checking is a formal verification technique that + allows to automatically prove that a system's behavior is + correct. However it is often prohibitively expensive in + time and memory complexity, due to the so-called state + space explosion problem. We present a generic + multi-threaded and distributed infrastructure library + designed to allow distribution of the model checking + procedure over a cluster of machines. This library is + generic, and is designed to allow encapsulation of any + model checker in order to make it distributed. Performance + evaluations are reported and clearly show the advantages of + multi-threading to occupy processors while waiting for the + network, with linear speedup over the number of + processors.} +} + +@InProceedings{ hamez.08.atpn, + author = {Alexandre Hamez and Yann Thierry-Mieg and Fabrice Kordon}, + title = {Hierarchical Set Decision Diagrams and Automatic + Saturation}, + booktitle = {Petri Nets and Other Models of Concurrency --ICATPN 2008}, + year = 2008, + project = {Verification}, + urllrde = {200806-ATPN}, + abstract = {Shared decision diagram representations of a state-space + have been shown to provide efficient solutions for + model-checking of large systems. However, decision diagram + manipulation is tricky, as the construction procedure is + liable to produce intractable intermediate structures + (a.k.a peak effect). The definition of the so-called + saturation method has empirically been shown to mostly + avoid this peak effect, and allows verification of much + larger systems. However, applying this algorithm currently + requires deep knowledge of the decision diagram + data-structures, of the model or formalism manipulated, and + a level of interaction that is not offered by the API of + public DD packages. + + Hierarchical Set Decision Diagrams (SDD) are decision + diagrams in which arcs of the structure are labeled with + sets, themselves stored as SDD. This data structure offers + an elegant and very efficient way of encoding structured + specifications using decision diagram technology. It also + offers, through the concept of inductive homomorphisms, + unprecedented freedom to the user when defining the + transition relation. Finally, with very limited user input, + the SDD library is able to optimize evaluation of a + transition relation to produce a saturation effect at + runtime. We further show that using recursive folding, SDD + are able to offer solutions in logarithmic complexity with + respect to other DD. We conclude with some performances on + well known examples.} +} + +@Article{ hamez.09.fi, + abstract = {Shared decision diagram representations of a state-space + provide efficient solutions for model-checking of large + systems. However, decision diagram manipulation is tricky, + as the construction procedure is liable to produce + intractable intermediate structures (a.k.a peak effect). + The definition of the so-called saturation method has + empirically been shown to mostly avoid this peak effect, + and allows verification of much larger systems. However, + applying this algorithm currently requires deep knowledge + of the decision diagram data-structures. + + Hierarchical Set Decision Diagrams (SDD) are decision + diagrams in which arcs of the structure are labeled with + sets, themselves stored as SDD. This data structure offers + an elegant and very efficient way of encoding structured + specifications using decision diagram technology. It also + offers, through the concept of inductive homomorphisms, + flexibility to a user defining a transition relation. We + show in this paper how, with very limited user input, the + SDD library is able to optimize evaluation of a transition + relation to produce a saturation effect at runtime. + + We build as an example an SDD model-checker for a + compositional formalism: Instantiable Petri Nets (IPN). IPN + define a \emph{type} as an abstract contract. Labeled P/T + nets are used as an elementary type. A composite type is + defined to hierarchically contain instances (of elementary + or composite type). To compose behaviors, IPN use classic + label synchronization semantics from process calculi. + + With a particular recursive folding SDD are able to offer + solutions for symmetric systems in logarithmic complexity + with respect to other DD. Even in less regular cases, the + use of hierarchy in the specification is shown to be well + supported by SDD. Experimentations and performances are + reported on some well known examples. }, + author = {Alexandre Hamez and Yann Thierry-Mieg and Fabrice Kordon}, + date-added = {2009-05-06 16:39:07 +0200}, + date-modified = {2009-05-06 16:48:10 +0200}, + journal = {Fundamenta Informaticae}, + title = {Building Efficient Model checkers using Hierarchical Set + Decision Diagrams and automatic Saturation}, + year = 2009, + urllrde = {2009-FI} +} + +@InProceedings{ hemon.08.sagt, + author = {S\'ebastien H\'emon and Michel de Rougemont and Miklos + Santha}, + title = {Approximate {N}ash Equilibria for Multi-Player Games}, + titre = {\'Equilibres de Nash approch\'es dans les jeux + multi-joueurs}, + booktitle = {1st International Symposium on Algorithmic Games Theory}, + year = 2008, + address = {Paderborn, Germany}, + month = apr, + urllrde = {2008-01-18-SAGT}, + resume = {Les \'equilibres de Nash sont des positions-cl\'es de tout + jeu admettant une repr\'esentation finie : en effet, quel + que soit le nombre de joueurs et de strat\'egies, une telle + position existe toujours. Lorsqu'elle est atteinte, elle + dissuade tout joueur de vouloir se d\'etourner de sa + strat\'egie actuelle, d'o\`u la notion d'\'equilibre. De + nombreux probl\`emes y font appel mais calculer de + fa\c{c}on effective l'\'equilibre demeure un probl\`eme + difficile. En effet, le meilleur algorithme connu pour, + dans le cas g\'en\'eral, calculer un \'equilibre est + exponentiel en le nombre de strat\'egies. + + Nous pr\'esenterons ici la notion d'\'equilibres + approch\'es, et donnerons des r\'esultats concernant leur + calcul. Nous montrerons qu'il ne saurait exister + d'algorithmes pouvant calculer un \'equilibre, m\^eme + approch\'e, sans utiliser au moins, pour un joueur, un + nombre logarithmique de strat\'egies. Nous montrerons + comment calculer un \'equilibre approch\'e en temps + sub-exponentiel $n^{\mathcal{O}(\frac{\ln + n}{\varepsilon^2})}$, ce qui demeure actuellement, pour le + cas g\'en\'eral, la meilleure complexit\'e en pire cas. + + Enfin, nous pr\'esenterons une approche inductive de + transfert d'approximation d'une position d'un jeu \`a deux + joueurs en une approximation pour un jeu \`a $r$ joueurs, + ce qui conf\`ere des r\'esultats novateurs dans le domaine.} +} + +@InProceedings{ herault.06.qest, + author = {Thomas H\'erault and Richard Lassaigne and Sylvain + Peyronnet}, + title = {{APMC 3.0}: Approximate verification of Discrete and + Continuous Time Markov Chains}, + booktitle = {Proceedings of Qest 2006}, + year = 2006, + pages = {129--130}, + project = {APMC}, + urllrde = {200606-Qest}, + abstract = {In this paper, we give a brief overview of APMC + (Approximate Probabilistic Model Checker). APMC is a model + checker that implements approximate probabilistic + verification of probabilistic systems. It is based on + Monte-Carlo method and the theory of randomized + approximation schemes and allows to verify extremely large + models without explicitly representing the global + transition system. To avoid the state-space explosion + phenomenon, APMC gives an accurate approximation of the + satisfaction probability of the property instead of the + exact value, but using only a very small amount of memory. + The version of APMC we present in this paper can now handle + efficiently both discrete and continuous time probabilistic + systems.} +} + +@InProceedings{ kenny.08.odyssey, + author = {Patrick Kenny and Najim Dehak and R\'eda Dehak and Vishwa + Gupta and Pierre Dumouchel}, + title = {The Role of Speaker Factors in the {NIST} Extended Data + Task}, + booktitle = {Proceedings of the Speaker and Language Recognition + Workshop (IEEE-Odyssey 2008)}, + year = 2008, + address = {Stellenbosch, South Africa}, + month = jan, + urllrde = {200709-ODYSSEY-C}, + abstract = {We tested factor analysis models having various numbers of + speaker factors on the core condition and the extended data + condition of the 2006 NIST speaker recognition evaluation. + In order to ensure strict disjointness between training and + test sets, the factor analysis models were trained without + using any of the data made available for the 2005 + evaluation. The factor analysis training set consisted + primarily of Switchboard data and so was to some degree + mismatched with the 2006 test data (drawn from the Mixer + collection). Consequently, our initial results were not as + good as those submitted for the 2006 evaluation. However we + found that we could compensate for this by a simple + modification to our score normalization strategy, namely by + using 1000 z-norm utterances in zt-norm. Our purpose in + varying the number of speaker factors was to evaluate the + eigenvoiceMAP and classicalMAP components of the + inter-speaker variability model in factor analysis. We + found that on the core condition (i.e. 2--3 minutes of + enrollment data), only the eigenvoice MAP component plays a + useful role. On the other hand, on the extended data + condition (i.e. 15--20 minutes of enrollment data) both the + classical MAP component and the eigenvoice component proved + to be useful provided that the number of speaker factors + was limited. Our best result on the extended data condition + (all trials) was an equal error rate of 2.2\% and a + detection cost of 0.011. } +} + +@Article{ laplante.07.tocl, + author = {Sophie Laplante and Richard Lassaigne and Fr\'ed\'eric + Magniez and Sylvain Peyronnet and Michel de Rougemont}, + title = {Probabilistic abstraction for model checking: an approach + based on property testing}, + journal = {ACM Transactions on Computational Logic}, + year = 2007, + project = {APMC}, + month = aug, + volume = 8, + number = 4, + urllrde = {2006XX-TOCL}, + abstract = {The goal of model checking is to verify the correctness of + a given program, on all its inputs. The main obstacle, in + many cases, is the intractably large size of the program's + transition system. Property testing is a randomized method + to verify whether some fixed property holds on individual + inputs, by looking at a small random part of that input. We + join the strengths of both approaches by introducing a new + notion of probabilistic abstraction, and by extending the + framework of model checking to include the use of these + abstractions. Our abstractions map transition systems + associated with large graphs to small transition systems + associated with small random subgraphs. This reduces the + original transition system to a family of small, even + constant-size, transition systems. We prove that with high + probability, ``sufficiently'' incorrect programs will be + rejected ($\eps$-robustness). We also prove that under a + certain condition (exactness), correct programs will never + be rejected (soundness). Our work applies to programs for + graph properties such as bipartiteness, $k$-colorability, + or any $\exists\forall$ first order graph properties. Our + main contribution is to show how to apply the ideas of + property testing to syntactic programs for such properties. + We give a concrete example of an abstraction for a program + for bipartiteness. Finally, we show that the relaxation of + the test alone does not yield transition systems small + enough to use the standard model checking method. More + specifically, we prove, using methods from communication + complexity, that the OBDD size remains exponential for + approximate bipartiteness.} +} + +@InProceedings{ lassaigne.05.wollic, + author = {Richard Lassaigne and Sylvain Peyronnet}, + title = {Probabilistic verification and approximation}, + booktitle = {Proceedings of 12th Workshop on Logic, Language, + Information and Computation (Wollic)}, + year = 2005, + series = {Electronic Notes in Theoretical Computer Science}, + volume = 143, + pages = {101--114}, + project = {APMC}, + urllrde = {200507-Wollic}, + abstract = {Model checking is an algorithmic method allowing to + automatically verify if a system which is represented as a + Kripke model satisfies a given specification. + Specifications are usually expressed by formulas of + temporal logic. The first objective of this paper is to + give an overview of methods able to verify probabilistic + systems. Models of such systems are labelled discrete time + Markov chains and specifications are expressed in + extensions of temporal logic by probabilistic operators. + The second objective is to focus on complexity of these + methods and to answer the question: can probabilistic + verification be efficiently approximated? In general, the + answer is negative. However, in many applications, the + specification formulas can be expressed in some positive + fragment of linear time temporal logic. In this paper, we + show how some simple randomized approximation algorithms + can improve the efficiency of the verification of such + probabilistic specifications.} +} + +@InProceedings{ lazzara.11.icdar, + author = {Guillaume Lazzara and Roland Levillain and {\relax + Th}ierry G\'eraud and Yann Jacquelet and Julien Marquegnies + and Arthur Cr\'epin-Leblond}, + title = {The {SCRIBO} Module of the {Olena} Platform: a Free + Software Framework for Document Image Analysis}, + booktitle = {Proceedings of the 11th International Conference on + Document Analysis and Recognition (ICDAR)}, + year = 2011, + address = {Beijing, China}, + month = sep, + organization = {International Association for Pattern Recognition (IAPR)}, + project = {Olena}, + urllrde = {201109-ICDAR}, + abstract = {Electronic documents are being more and more usable thanks + to better and more affordable network, storage and + computational facilities. But in order to benefit from + computer-aided document management, paper documents must be + digitized and analyzed. This task may be challenging at + several levels. Data may be of multiple types thus + requiring different adapted processing chains. The tools to + be developed should also take into account the needs and + knowledge of users, ranging from a simple graphical + application to a complete programming framework. Finally, + the data sets to process may be large. In this paper, we + expose a set of features that a Document Image Analysis + framework should provide to handle the previous issues. In + particular, a good strategy to address both flexibility and + efficiency issues is the Generic Programming (GP) paradigm. + These ideas are implemented as an open source module, + SCRIBO, built on top of Olena, a generic and efficient + image processing platform. Our solution features services + such as preprocessing filters, text detection, page + segmentation and document reconstruction (as XML, PDF or + HTML documents). This framework, composed of reusable + software components, can be used to create full-fledged + graphical applications, small utilities, or processing + chains to be integrated into third-party projects.}, + keywords = {Document Image Analysis, Software Design, Reusability, + Free Software} +} + +@InProceedings{ le-quoc.07.ntms, + author = {Cuong Le Quoc and Patrick Bellot and Akim Demaille}, + title = {On the security of quantum networks: a proposal framework + and its capacity}, + booktitle = {Proceedings of the 2007 International Conference on New + Technologies, Mobility and Security (NTMS'07)}, + year = 2007, + address = {Paris, France}, + month = may, + urllrde = {200705-NTMS}, + abstract = {In large Quantum Key Distribution (QKD)-based networks, + intermediate nodes are necessary because of the short + length of QKD links. They have tendency to be used more + than classical networks. A realistic assumption is that + there are eavesdropping operations in these nodes without + knowledge of legitimate network participants. We develop a + QKD-based network framework. We present a percolation-based + approach to discuss about conditions of extremely high + secret key transmission. We propose also an adaptive + stochastic routing algorithm that helps on protecting keys + from reasonable eavesdroppers in a dense QKD network. We + show that under some assumptions, one could prevent + eavesdroppers from sniffing the secrets with an arbitrarily + large probability.} +} + +@InProceedings{ le-quoc.07.rivf, + author = {Cuong Le Quoc and Patrick Bellot and Akim Demaille}, + title = {Stochastic routing in large grid-shaped quantum networks}, + booktitle = {Proceedings of the Fifth International Conference on + Computer Sciences, Research, Innovation and Vision for the + Future (RIVF'07)}, + year = 2007, + address = {Hanoi, Vietnam}, + month = mar, + isbn = {1-4244-0695-1}, + urllrde = {200703-RIVF}, + abstract = {This paper investigates the problem of secret key + transmissions for an arbitrary Alice-Bob pair in Quantum + Key Distribution-based networks. We develop a realistic + QKD-based network framework and we show that the key + transmission problem on such a framework can be considered + as a variant of the classical percolation problem. We also + present an adaptive stochastic routing algorithm protect + from inevitable eavesdroppers. Simulations were carried out + not only to validate our approach, but also to compute + critical parameters ensuring security. These results show + that large quantum networks with eavesdroppers do provide + security.}, + keywords = {Quantum Key Distribution, QKD network, percolation theory, + stochastic routing} +} + +@InProceedings{ le-quoc.08.ispec, + author = {Cuong Le Quoc and Patrick Bellot and Akim Demaille}, + title = {Towards the World-Wide Quantum Network}, + booktitle = {Proceedings of the 4th Information Security Practice and + Experience Conference (ISPEC'08)}, + year = 2008, + address = {Sydney, Australia}, + month = april, + urllrde = {200804-ISPEC}, + abstract = {Quantum Key Distribution (QKD) networks are of much + interest due to their capacity of providing extremely high + security keys to network participants. Most QKD network + studies so far focus on trusted models where all the + network nodes are assumed to be perfectly secured. This + restricts QKD networks to be small. In this paper, we first + develop a novel model dedicated to large-scale QKD + networks, some of whose nodes could be eavesdropped + secretly. Then, we investigate the key transmission problem + in the new model by an approach based on percolation theory + and stochastic routing. Analyses show that under computable + conditions large-scale QKD networks could protect secret + keys with an extremely high probability. Simulations + validate our results.}, + keywords = {Quantum Key Distribution, QKD network, percolation theory, + stochastic routing} +} + +@TechReport{ lefebvre.04.tr, + author = {Sylvain Lefebvre and J\'er\^ome Darbon and Fabrice Neyret}, + title = {Unified texture management for arbitrary meshes}, + institution = {INRIA-Rhone-Alpes}, + year = 2004, + number = {RR-5210}, + address = {France}, + month = may, + project = {Image}, + urllrde = {200405-RRinria}, + abstract = {Video games and simulators commonly use very detailed + textures, whose cumulative size is often larger than the + GPU memory. Textures may be loaded progressively, but + dynamically loading and transferring this large amount of + data in GPU memory results in loading delays and poor + performance. Therefore, managing texture memory has become + an important issue. While this problem has been (partly) + addressed early for the specific case of terrain rendering, + there is no generic texture management system for arbitrary + meshes. We propose such a system, implemented on today's + GPUs, which unifies classical solutions aimed at reducing + memory transfer: progressive loading, texture compression, + and caching strategies. For this, we introduce a new + algorithm -- running on GPU -- to solve the major + difficulty of detecting which parts of the texture are + required for rendering. Our system is based on three + components manipulating a tile pool which stores texture + data in GPU memory. First, the Texture Load Map determines + at every frame the appropriate list of texture tiles (i.e. + location and MIP-map level) to render from the current + viewpoint. Second, the Texture Cache manages the tile pool. + Finally, the Texture Producer loads and decodes required + texture tiles asynchronously in the tile pool. Decoding of + compressed texture data is implemented on GPU to minimize + texture transfer. The Texture Producer can also generate + procedural textures. Our system is transparent to the user, + and the only parameter that must be supplied at runtime is + the current viewpoint. No modifications of the mesh are + required. We demonstrate our system on large scenes + displayed in real time. We show that it achieves + interactive frame rates even in low-memory low-bandwidth + situations.} +} + +@InProceedings{ lesage.06.isvc, + author = {David Lesage and J\'er\^ome Darbon and Ceyhun Burak Akg\"ul}, + title = {An Efficient Algorithm for Connected Attribute Thinnings + and Thickenings}, + booktitle = {Proceedings of the second International Conference on + Visual Computing}, + year = 2006, + address = {Lake Tahoe, Nevada, USA}, + month = nov, + project = {Image}, + pages = {393--404}, + volume = 4292, + series = {Lecture Notes in Computer Science Series}, + publisher = {Springer-Verlag}, + urllrde = {200611-ISVC}, + abstract = {Connected attribute filters are anti-extensive + morphological operators widely used for their ability of + simplifying the image without moving its contours. In this + paper, we present a fast, versatile and easy-to-implement + algorithm for grayscale connected attribute thinnings and + thickennings, a subclass of connected filters for the wide + range of non-increasing attributes. We show that our + algorithm consumes less memory and is computationally more + efficient than other available methods on natural images.} +} + +@Misc{ levillain.05.olenaposter, + author = {Roland Levillain}, + title = {{O}lena {P}roject poster}, + month = oct, + year = 2005, + urllrde = {200510-OlenaPoster} +} + +@Misc{ levillain.05.tigerposter, + author = {Roland Levillain}, + title = {{T}iger {P}roject poster}, + month = oct, + year = 2005, + urllrde = {200510-TigerPoster} +} + +@InProceedings{ levillain.09.ismm, + author = {Roland Levillain and {\relax Th}ierry G\'eraud and Laurent + Najman}, + title = {{Milena}: Write Generic Morphological Algorithms Once, Run + on Many Kinds of Images}, + booktitle = {Mathematical Morphology and Its Application to Signal and + Image Processing -- Proceedings of the Ninth International + Symposium on Mathematical Morphology (ISMM)}, + pages = {295--306}, + year = 2009, + editor = {Michael H. F. Wilkinson and Jos B. T. M. Roerdink}, + series = {Lecture Notes in Computer Science}, + address = {Groningen, The Netherlands}, + month = aug, + publisher = {Springer Berlin / Heidelberg}, + volume = 5720, + project = {Olena}, + urllrde = {200908-ISMM}, + abstract = {We present a programming framework for discrete + mathematical morphology centered on the concept of + genericity. We show that formal definitions of + morphological algorithms can be translated into actual + code, usable on virtually any kind of compatible images, + provided a general definition of the concept of image is + given. This work is implemented in Milena, a generic, + efficient, and user-friendly image processing library.}, + keywords = {mathematical morphology, image processing operator, + genericity, programming} +} + +@InProceedings{ levillain.10.icip, + author = {Roland Levillain and {\relax Th}ierry G\'eraud and Laurent + Najman}, + title = {Why and How to Design a Generic and Efficient Image + Processing Framework: The Case of the {Milena} Library}, + booktitle = {Proceedings of the IEEE International Conference on Image + Processing (ICIP)}, + pages = {1941--1944}, + year = 2010, + address = {Hong Kong}, + month = sep, + project = {Olena}, + urllrde = {201009-ICIP}, + abstract = {Most image processing frameworks are not generic enough to + provide true reusability of data structures and algorithms. + In fact, genericity allows users to write and experiment + virtually any method on any compatible input(s). In this + paper, we advocate the use of generic programming in the + design of image processing software, while preserving + performances close to dedicated code. The implementation of + our proposal, Milena, a generic and efficient library, + illustrates the benefits of our approach.}, + keywords = {Genericity, Image Processing, Software Design, + Reusability, Efficiency} +} + +@InProceedings{ levillain.10.wadgmm, + author = {Roland Levillain and {\relax Th}ierry G\'eraud and Laurent + Najman}, + title = {Writing Reusable Digital Geometry Algorithms in a Generic + Image Processing Framework}, + booktitle = {Proceedings of the Workshop on Applications of Digital + Geometry and Mathematical Morphology (WADGMM)}, + pages = {96--100}, + year = 2010, + address = {Istanbul, Turkey}, + month = aug, + url = {http://mdigest.jrc.ec.europa.eu/wadgmm2010/}, + project = {Olena}, + urllrde = {201008-WADGMM}, + abstract = {Digital Geometry software should reflect the generality of + the underlying mathematics: mapping the latter to the + former requires genericity. By designing generic solutions, + one can effectively reuse digital geometry data structures + and algorithms. We propose an image processing framework + centered on the Generic Programming paradigm in which an + algorithm on the paper can be turn into a single code, + written once and usable with various input types. This + approach enables users to design and implement new methods + at a lower cost, try cross-domain experiments and help + generalize results.}, + keywords = {Generic Programming, Interface, Skeleton, Complex} +} + +@InProceedings{ levillain.11.gretsi, + author = {Roland Levillain and {\relax Th}ierry G\'eraud and Laurent + Najman}, + title = {Une approche g\'en\'erique du logiciel pour le traitement + d'images pr\'eservant les performances}, + booktitle = {Proceedings of the 23rd Symposium on Signal and Image + Processing (GRETSI)}, + category = {national}, + year = 2011, + address = {Bordeaux, France}, + month = sep, + note = {In French.}, + project = {Olena}, + urllrde = {201109-GRETSI}, + abstract = {De plus en plus d'outils logiciels modernes pour le + traitement d'images sont con\,c{}us en prenant en compte le + probl\`eme de la g\'en\'ericit\'e du code, c'est-\`a-dire + la possibilit\'e d'\'ecrire des algorithmes + r\'eutilisables, compatibles avec de nombreux types + d'entr\'ees. Cependant, ce choix de conception se fait + souvent au d\'etriment des performances du code + ex\'ecut\'e. Du fait de la grande vari\'et\'e des types + d'images existants et de la n\'ecessit\'e d'avoir des + impl\'ementations rapides, g\'en\'ericit\'e et performance + apparaissent comme des qualit\'es essentielles du logiciel + en traitement d'images. Cet article pr\'esente une approche + pr\'eservant les performances dans un framework logiciel + g\'en\'erique tirant parti des caract\'eristiques des types + de donn\'ees utilis\'es. Gr\^ace \`a celles-ci, il est + possible d'\'ecrire des variantes d'algorithmes + g\'en\'eriques offrant un compromis entre g\'en\'ericit\'e + et performance. Ces alternatives sont capables de + pr\'eserver une partie des aspects g\'en\'eriques d'origine + tout en apportant des gains substantiels \`a l'ex\'ecution. + D'apr\`es nos essais, ces optimisations g\'en\'eriques + fournissent des performances supportant la comparaison avec + du code d\'edi\'e, allant parfois m\^eme jusqu'\`a surpasser des routines optimis\'ees manuellement.} +} + +@InProceedings{ linard.10.acsd, + author = {Alban Linard and Emmanuel Paviot-Adet and Fabrice Kordon + and Didier Buchs and Samuel Charron}, + title = {{polyDD}: Towards a Framework Generalizing Decision + Diagrams}, + booktitle = {Proceedings of the 10th International Conference on + Application of Concurrency to System Design (ACSD)}, + pages = {124--133}, + year = 2010, + address = {Braga, Portugal}, + month = jun, + project = {Verification}, + urllrde = {201006-ACSD}, + publisher = {IEEE Computer Society}, + abstract = {Decision Diagrams are now widely used in model checking as + extremely compact representations of state spaces. Many + Decision Diagram categories have been developed over the + past twenty years based on the same principles. Each one + targets a specific domain with its own characteristics. + Moreover, each one provides its own definition. It prevents + sharing concepts and techniques between these structures. + This paper aims to propose a basis for a common Framework + for Decision Diagrams. It should help users of this + technology to define new Decision Diagram categories thanks + to a simple specification mechanism called Controller. This + enables the building of efficient Decision Diagrams + dedicated to a given problem.} +} + +@InProceedings{ lombardy.03.ciaa, + author = {Sylvain Lombardy and Rapha\"el Poss and Yann + R\'egis-Gianas and Jacques Sakarovitch}, + title = {Introducing {V}aucanson}, + booktitle = {Proceedings of Implementation and Application of Automata, + 8th International Conference (CIAA)}, + pages = {96--107}, + year = 2003, + editor = {Springer-Verlag}, + volume = 2759, + series = {Lecture Notes in Computer Science Series}, + address = {Santa Barbara, CA, USA}, + month = jul, + project = {Vaucanson}, + urllrde = {200307-Ciaa}, + abstract = {This paper reports on a new software platform dedicated to + the computation with automata and transducers, called + Vaucanson, the main feature of which is the capacity of + dealing with automata whose labels may belong to various + algebraic structures. The paper successively shows how + Vaucanson allows to program algorithms on automata in a way + which is very close to the mathematical expression of the + algorithm, describes some features of the Vaucanson + platform, including the fact that the very rich data + structure used to implement automata does not weight too + much on the performance and finally explains the main + issues of the programming design that allow to achieve both + genericity and efficiency.} +} + +@Article{ lombardy.04.tcs, + author = {Sylvain Lombardy and Yann R\'egis-{G}ianas and Jacques + Sakarovitch}, + title = {Introducing {V}aucanson}, + journal = {Theoretical Computer Science}, + volume = 328, + year = 2004, + pages = {77--96}, + month = nov, + project = {Vaucanson}, + urllrde = {200411-TCS}, + abstract = {This paper reports on a new software platform called + VAUCANSON and dedicated to the computation with automata + and transducers. Its main feature is the capacity of + dealing with automata whose labels may belong to various + algebraic structures. The paper successively describes the + main features of the VAUCANSON platform, including the fact + that the very rich data structure used to implement + automata does not weigh too much on the performance, shows + how VAUCANSON allows to program algorithms on automata in a + way which is very close to the mathematical expression of + the algorithm and finally explains the main choices of the + programming design that enable to achieve both genericity + and efficiency.} +} + +@InProceedings{ maes.03.dpcool, + author = {Francis Maes}, + title = {Program templates: expression templates applied to program + evaluation}, + booktitle = {Proceedings of the Workshop on Declarative Programming in + the Context of Object-Oriented Languages (DP-COOL; in + conjunction with PLI)}, + year = 2003, + address = {Uppsala, Sweden}, + number = {FZJ-ZAM-IB-2003-10}, + pages = {67--86}, + editor = {J\"org Striegnitz and Kei Davis}, + month = aug, + series = {John von Neumann Institute for Computing (NIC)}, + project = {Software}, + urllrde = {20020619-Seminar-Maes-Report}, + abstract = {The C++ language provides a two-layer execution model: + static execution of meta-programs and dynamic execution of + resulting programs. The Expression Templates technique + takes advantage of this dual execution model through the + construction of C++ types expressing simple arithmetic + formulas. Our intent is to extend this technique to a whole + programming language. The Tiger language is a small, + imperative language with types, variables, arrays, records, + ow control structures and nested functions. The rst step is + to show how to express a Tiger program as a C++ type. The + second step concerns operational analysis which is done + through the use of meta-programs. Finally an implementation + of our Tiger evaluator is proposed. Our technique goes much + deeper than the Expression Templates one. It shows how the + generative power of C++ meta-programming can be used in + order to compile abstract syntax trees of a fully featured + programming language.} +} + +@InProceedings{ maes.04.mpool, + author = {Francis Maes}, + title = {Metagene, a {C++} meta-program generation tool}, + booktitle = {Proceedings of the Workshop on Multiple Paradigm with OO + Languages (MPOOL; in conjunction with ECOOP)}, + year = 2004, + address = {Oslo, Norway}, + month = jun, + project = {Software}, + urllrde = {200406-MPOOL}, + abstract = {The C++ language offers a two layer evaluation model. + Thus, it is possible to evaluate a program in two steps: + the so-called static and dynamic evaluations. Static + evaluation is used for reducing the amount of work done at + execution-time. Programs executed statically (called + metaprograms) are written in C++ through an intensive use + of template classes. Due to the complexity of these + structures, writing, debugging and maintaining C++ + meta-programs is a difficult task. Metagene is a program + transformation tool which simplifies the development of + such programs. Due to the similarities between C++ + meta-programming and functional programming, the input + language of Metagene is an ML language. Given a functional + input program, Metagene outputs the corresponding C++ + meta-program expressed using template classes.} +} + +@InProceedings{ minetto.10.icip, + author = {Rodrigo Minetto and Nicolas Thome and Matthieu Cord and + Jonathan Fabrizio and Beatriz Marcotegui}, + title = {SnooperText: A Multiresolution System for Text Detection + in Complex Visual Scenes}, + booktitle = {Proceedings of the IEEE International Conference on Image + Processing (ICIP)}, + pages = {3861--3864}, + year = 2010, + address = {Hong Kong}, + month = sep, + abstract = {Text detection in natural images remains a very + challenging task. For instance, in an urban context, the + detection is very difficult due to large variations in + terms of shape, size, color, orientation, and the image may + be blurred or have irregular illumination, etc. In this + paper, we describe a robust and accurate multiresolution + approach to detect and classify text regions in such + scenarios. Based on generation/validation paradigm, we + first segment images to detect character regions with a + multiresolution algorithm able to manage large character + size variations. The segmented regions are then filtered + out using shapebased classification, and neighboring + characters are merged to generate text hypotheses. A + validation step computes a region signature based on + texture analysis to reject false positives. We evaluate our + algorithm in two challenging databases, achieving very good + results}, + keywords = {Text detection, multiresolution, image segmentation, + machine learning} +} + +@InProceedings{ perrot.06.nist, + author = {Patrick Perrot and R\'eda Dehak and G\'erard Chollet}, + title = {{ENST-IRCGN} System Description}, + booktitle = {NIST SRE'06 Workshop: speaker recognition evaluation + campaign}, + year = 2006, + address = {San Juan, Puerto Rico}, + month = jun, + urllrde = {200606-NIST-B} +} + +@Misc{ pouillard.05.sud, + author = {Akim Demaille and {\relax Th}omas Largillier and Nicolas + Pouillard}, + title = {{ESDF}: A proposal for a more flexible {SDF} handling}, + note = {Communication to Stratego Users Day 2005}, + year = 2005, + address = {Utrecht {U}niversity, {N}etherland}, + month = may, + project = {Transformers}, + urllrde = {200505-SUD-esdf}, + abstract = {By the means on its annotations, Syntax Definition + Formalism (SDF) seems to be extensible: the user is tempted + to tailor its grammar syntax by adding new annotation + kinds. Unfortunately the standard SDF crunching tools from + Stratego/XT do not support the extension of SDF, and the + user has to develop the whole set of tools for her home + grown extension(s). We present the SDF tool set that + provides ``weak'' genericity with respect to the grammar + grammar: support for arbitrary SDF annotations. We would + like to contribute it to Stratego/XT since its components + subsume their stock peers. Finally, we present a set of + four extensions we find useful.} +} + +@InProceedings{ regisgianas.03.poosc, + author = {Yann R\'egis-Gianas and Rapha\"el Poss}, + title = {On orthogonal specialization in {C++}: dealing with + efficiency and algebraic abstraction in {V}aucanson}, + booktitle = {Proceedings of the Parallel/High-performance + Object-Oriented Scientific Computing (POOSC; in conjunction + with ECOOP)}, + year = 2003, + number = {FZJ-ZAM-IB-2003-09}, + pages = {71--82}, + editor = {J\"org Striegnitz and Kei Davis}, + series = {John von Neumann Institute for Computing (NIC)}, + address = {Darmstadt, Germany}, + month = jul, + project = {Vaucanson}, + urllrde = {200307-Poosc}, + abstract = {Vaucanson is a C++ generic library for weighted finite + state machine manipulation. For the sake of generality, FSM + are defined using algebraic structures such as alphabet + (for the letters), free monoid (for the words), semiring + (for the weights) and series (mapping from words to + weights). As usual, what is at stake is to maintain + efficiency while providing a high-level layer for the + writing of generic algorithms. Yet, one of the + particularities of FSM manipulation is the need of a fine + grained specialization power on an object which is both an + algebraic concept and an intensive computing machine.} +} + +@InProceedings{ ricou.07.adass, + author = {Olivier Ricou and Anthony Baillard and Emmanuel Bertin and + Frederic Magnard and Chiara Marmo and Yannick Mellier}, + title = {Web services at {TERAPIX}}, + booktitle = {Proceedings of the XVII conference on Astronomical Data + Analysis Software \& Systems (ADASS)}, + month = sep, + year = 2007, + urllrde = {200709-ADASS}, + abstract = {We present an implementation of V.O.-compliant web + services built around software tools developed at the + TERAPIX centre. These services allow to operate from a + remote site several pipeline tasks dedicated to + astronomical data processing on the TERAPIX cluster, + including the latest EFIGI morphological analysis tool.} +} + +@InProceedings{ ricou.07.eceg, + author = {Olivier Ricou}, + title = {10 years of confrontation between {French} {Internet} + users and their successive governments}, + booktitle = {Proceedings of the 7th European Conference on e-Government + (ECEG)}, + month = jun, + year = 2007, + urllrde = {200706-ECEG}, + abstract = {This paper is a testimony on the relations between the + Internet users and their governments in France during the + last decade. It shows the complexity of communication + between two worlds that are strangers to each other. Since + most of the confrontation occurred over law proposals, it + analyses their impact on Internet users and focuses on two + examples. These example show the failure of Internet as a + political medium. French politicians do not seem to want an + active participation of the citizens in decisionmaking + processes. In order to end this paper on an optimistic + note, the last section enumerates the achievements of + egovernment which contributed preparing for a better + democracy by increasing transparency, accountability, and + education. This might push citizens to ask for more. } +} + +@InProceedings{ ricou.08.eceg, + author = {Olivier Ricou}, + title = {A Survey of {French} Local e-Democracy}, + booktitle = {Proceedings of the 8th European Conference on e-Government + (ECEG)}, + month = jul, + year = 2008, + urllrde = {200807-ECEG}, + abstract = {Since the end of the last century, the Internet has shown + that it is a different media, a media of citizen + journalists. This paper surveys e-democratic tools used at + the local level in France in order to see how the Internet + can change our democracy and people's participation. It + describes the official tools provided by municipalities and + administrations as well as citizens' tools, like blogs, + which become more and more important in today's democratic + debate. It analyses how they help for more transparency, + accountability and participation, which might lead to + define new democratic rules.} +} + +@TechReport{ vaucanson.04.techrep, + author = {The \textsc{Vaucanson} group}, + title = {Proposal: an {XML} representation for automata}, + institution = {EPITA Research and Development Laboratory (LRDE)}, + year = 2004, + number = 0414, + address = {France}, + month = nov, + url = {http://www.lrde.epita.fr/cgi-bin/twiki/view/Publications/200414-TR} + , + project = {Vaucanson}, + urllrde = {200414-TR} +} + +@InProceedings{ verna.00.vsmm, + author = {Didier Verna}, + title = {Action recognition: how intelligent virtual environments + can ease human-machine interaction}, + booktitle = {Proceedings of the 6th International Conference on Virtual + Systems and MultiMedia (VSMM)---Intelligent Environments + Workshop}, + pages = {703--713}, + year = 2000, + address = {Gifu, Japan}, + month = oct, + publisher = {IOS Press, USA}, + isbn = {1-58603-108-2}, + project = {Urbi}, + urllrde = {200010-Vsmm-2}, + abstract = {This paper describes a research that has been conducted in + the field of cognitive assistance to human-machine + interaction in virtual environments. The idea is to design + a system which, bearing in mind the actions performed by + the operator at present and the current state of the + environment, attempts to determine the global operation + that the user is in the process of executing, and + eventually takes control of the same process in order to + complete it automatically. This idea implies the conception + of an action recognition mechanism based on a specific + knowledge representation model. This mechanism is + implemented in a computer demonstrator, known as the TOASt + system, which is also presented.} +} + +@InProceedings{ verna.01.sci, + author = {Didier Verna}, + title = {Virtual reality and tele-operation: a common framework}, + booktitle = {Proceedings of the 5th World Multi-Conference on + Systemics, Cybernetics and Informatics (SCI)---Emergent + Computing and Virtual Engineering}, + year = 2001, + volume = 3, + pages = {499--504}, + address = {Orlando, Florida, USA}, + month = jul, + editors = {N. Callas and S. Esquivel and J. Burge}, + project = {Urbi}, + urllrde = {200107-Sci}, + abstract = {This paper proposes an overview of a study that + conceptually unify the fields of virtual reality and + tele-operation, by analyzing the notion of ``assistance'' + to the operator of a virtual reality or tele-operation + system. This analysis demonstrates that cases of assistance + that are usually considered to belong to virtual reality + are not conceptually different from what has been done in + tele-operation since long before virtual reality appeared. + With this common framework for virtual reality and + tele-operation, we hope to provide a theoretical + formalization of many ideas acquired empirically, and hence + a basis onto which further discussion could be undertaken + in a constructive manner.} +} + +@InProceedings{ verna.06.ecoop, + author = {Didier Verna}, + title = {Beating {C} in Scientific Computing Applications}, + booktitle = {Third European Lisp Workshop at ECOOP}, + year = 2006, + address = {Nantes, France}, + month = jul, + note = {Best paper award.}, + project = {Software}, + urllrde = {200607-ECOOP}, + abstract = {This paper presents an ongoing research on the behavior + and performance of Lisp with respect to C in the context of + scientific numerical computing. Several simple image + processing algorithms are used to evaluate the performance + of pixel access and arithmetic operations in both + languages. We demonstrate that the behavior of equivalent + Lisp and C code is similar with respect to the choice of + data structures and types, and also to external parameters + such as hardware optimization. We further demonstrate that + properly typed and optimized Lisp code runs as fast as the + equivalent C code, or even faster in some cases.} +} + +@Article{ verna.06.ijcs, + author = {Didier Verna}, + title = {How to make Lisp go faster than {C}}, + journal = {IAENG International Journal of Computer Science}, + year = 2006, + volume = 32, + number = 4, + month = dec, + issn = {1819-656X}, + project = {Software}, + urllrde = {200606-IMECS}, + abstract = {Contrary to popular belief, Lisp code can be very + efficient today: it can run as fast as equivalent C code or + even faster in some cases. In this paper, we explain how to + tune Lisp code for performance by introducing the proper + type declarations, using the appropriate data structures + and compiler information. We also explain how efficiency is + achieved by the compilers. These techniques are applied to + simple image processing algorithms in order to demonstrate + the announced performance on pixel access and arithmetic + operations in both languages.} +} + +@InProceedings{ verna.06.imecs, + author = {Didier Verna}, + title = {How to make Lisp go faster than {C}}, + booktitle = {Proceedings of the International MultiConference of + Engineers and Computer Scientists}, + year = 2006, + address = {Hong Kong}, + month = jun, + organization = {International Association of Engineers}, + isbn = {988-98671-3-3}, + project = {Software}, + urllrde = {200606-IMECS}, + abstract = {Contrary to popular belief, Lisp code can be very + efficient today: it can run as fast as equivalent C code or + even faster in some cases. In this paper, we explain how to + tune Lisp code for performance by introducing the proper + type declarations, using the appropriate data structures + and compiler information. We also explain how efficiency is + achieved by the compilers. These techniques are applied to + simple image processing algorithms in order to demonstrate + the announced performance on pixel access and arithmetic + operations in both languages.} +} + +@Article{ verna.06.practex, + author = {Didier Verna}, + year = 2006, + volume = 2006, + number = 3, + month = aug, + project = {Software}, + urllrde = {200608-PracTeX}, + abstract = {This paper presents {\CurVe}, a curriculum vitae class for + \LaTeX2e, in a progressive approach going from a first + contact with the class, through concrete examples of + customization, and some aspects of advanced usage.} +} + +@InProceedings{ verna.07.imecs, + author = {Didier Verna}, + title = {{CLOS} solutions to binary methods}, + booktitle = {Proceedings of the International MultiConference of + Engineers and Computer Scientists}, + year = 2007, + address = {Hong Kong}, + month = mar, + organization = {International Association of Engineers}, + project = {Software}, + urllrde = {200703-IMECS}, + abstract = {Implementing binary methods in traditional object oriented + languages is difficult: numerous problems arise, such as + typing (covariance vs. contra-variance of the arguments), + polymorphism on multiple arguments (lack of multi-methods) + etc. The purpose of this paper is to demonstrate how those + problems are either solved, or nonexistent in the Common + Lisp Object System (CLOS). Several solutions for different + levels of binary methods support in CLOS are proposed. They + mainly consist in re-programming a binary method specific + object system through the CLOS meta-object protocol.} +} + +@InProceedings{ verna.08.els, + author = {Didier Verna}, + title = {Binary Methods Programming: the {CLOS} Perspective}, + booktitle = {Proceedings of the First European Lisp Symposium}, + pages = {91--105}, + year = 2008, + address = {Bordeaux, France}, + month = may, + project = {Software}, + urllrde = {200805-ELS}, + abstract = {Implementing binary methods in traditional object-oriented + languages is difficult: numerous problems arise regarding + the relationship between types and classes in the context + of inheritance, or the need for privileged access to the + internal representation of objects. Most of these problems + occur in the context of statically typed languages that + lack multi-methods (polymorphism on multiple arguments). + The purpose of this paper is twofold: first, we show why + some of these problems are either non-issues, or easily + solved in Common Lisp. Then, we demonstrate how the Common + Lisp Object System (CLOS) allows us not only to implement + binary methods in a straightforward way, but also to + support the concept directly, and even enforce it at + different levels (usage and implementation).} +} + +@Article{ verna.08.jucs, + author = {Didier Verna}, + title = {Binary Methods Programming: the {CLOS} Perspective + (extended version)}, + journal = {Journal of Universal Computer Science}, + year = 2008, + volume = 14, + number = 20, + pages = {3389--3411}, + project = {Software}, + urllrde = {200811-JUCS}, + abstract = {Implementing binary methods in traditional object-oriented + languages is difficult: numerous problems arise regarding + the relationship between types and classes in the context + of inheritance, or the need for privileged access to the + internal representation of objects. Most of these problems + occur in the context of statically typed languages that + lack multi-methods (polymorphism on multiple arguments). + The purpose of this paper is twofold: first, we show why + some of these problems are either non-issues, or easily + solved in Common Lisp. Then, we demonstrate how the Common + Lisp Object System (CLOS) allows us not only to implement + binary methods in a straightforward way, but also to + support the concept directly, and even enforce it at + different levels (usage and implementation).} +} + +@InProceedings{ verna.08.lncs, + author = {Didier Verna and Charlotte Herzeel and Christophe Rhodes + and Hans H\"ubner}, + title = {Report on the 5th Workshop {ELW} at {ECOOP 2008}}, + booktitle = {Object-Oriented Technology. ECOOP 2008 Workshop Reader.}, + pages = {1--6}, + year = 2008, + editor = {Patrick Eugster}, + volume = 5475, + series = {Lecture Notes in Computer Science}, + month = jul, + publisher = {Springer} +} + +@InProceedings{ verna.09.accu, + author = {Didier Verna}, + title = {Revisiting the Visitor: the Just Do It Pattern}, + booktitle = {Proceedings of the ACCU Conference 2009}, + year = 2009, + address = {Oxford}, + project = {Software}, + urllrde = {200904-ACCU}, + abstract = { }, + note = {Accepted} +} + +@InProceedings{ verna.09.ilc, + author = {Didier Verna}, + title = {{CLOS} Efficiency: Instantiation}, + booktitle = {Proceedings of the International Lisp Conference}, + year = 2009, + month = mar, + pages = {76--90}, + organization = {Association of Lisp Users}, + urllrde = {200903-ILC}, + abstract = {This article reports the results of an ongoing + experimental research on the behavior and performance of + CLOS, the Common Lisp Object System. Our purpose is to + evaluate the behavior and performance of the 3 most + important characteristics of any dynamic Object Oriented + system: class instantiation, slot access and dynamic + dispatch. This paper describes the results of our + experiments on instantiation. We evaluate the efficiency of + the instantiation process in both C++ and Lisp under a + combination of parameters such as slot types or classes + hierarchy. We show that in a non-optimized configuration + where safety is given priority on speed, the behavior of + C++ and Lisp instantiation can be quite different, which is + also the case amongst different Lisp compilers. On the + other hand, we demonstrate that when compilation is tuned + for speed, instantiation in Lisp becomes faster than in + C++.} +} + +@InProceedings{ verna.10.els, + author = {Didier Verna}, + title = {{CLoX}: {C}ommon {L}isp objects for {XEmacs}}, + booktitle = {Proceedings of the 3rd European Lisp Symposium}, + year = 2010, + address = {Lisbon, Portugal}, + month = may, + project = {Software}, + urllrde = {201005-ELS}, + abstract = {CLoX is an ongoing attempt to provide a full Emacs Lisp + implementation of the Common Lisp Object System, including + its underlying meta-object protocol, for XEmacs. This paper + describes the early development stages of this project. + CLoX currently consists in a port of Closette to Emacs + Lisp, with some additional features, most notably, a deeper + integration between types and classes and a comprehensive + test suite. All these aspects are described in the paper, + and we also provide a feature comparison with an + alternative project called Eieio.} +} + +@Article{ verna.10.jucs, + author = {Didier Verna}, + title = {Revisiting the Visitor: the Just Do It Pattern}, + journal = {Journal of Universal Computer Science}, + year = 2010, + volume = 16, + pages = {246--271}, + project = {Software}, + urllrde = {201004-JUCS}, + abstract = {While software design patterns are a generally useful + concept, they are often (and mistakenly) seen as ready-made + universal recipes for solving common problems. In a way, + the danger is that programmers stop thinking about their + actual problem, and start looking for pre-cooked solutions + in some design pattern book instead. What people usually + forget about design patterns is that the underlying + programming language plays a major role in the exact shape + such or such pattern will have on the surface. The purpose + of this paper is twofold: we show why design pattern + expression is intimately linked to the expressiveness of + the programming language in use, and we also demonstrate + how a blind application of them can in fact lead to very + poorly designed code.} +} + +@InProceedings{ verna.10.tug, + author = {Didier Verna}, + title = {Classes, Styles, Conflicts: the Biological Realm of + {\LaTeX}}, + booktitle = {TUGboat}, + pages = {162--172}, + year = 2010, + editor = {Barbara Beeton and Karl Berry}, + volume = 31, + number = 2, + project = {Software}, + urllrde = {201006-TUG}, + abstract = {The \LaTeX{} world is composed of thousands of software + components, most notably classes and styles. Classes and + styles are born, evolve or die, interact with each other, + compete or cooperate, very much as living organisms do at + the cellular level. This paper attempts to draw an extended + analogy between the \LaTeX{} biotope and cellular biology. + By considering \LaTeX{} documents as living organisms and + styles as viruses that infect them, we are able to exhibit + a set of behavioral patterns common to both worlds. We + analyze infection methods, types and cures, and we show how + \LaTeX{} or cellular organisms are able to survive in a + world of perpetual war.} +} + +@InProceedings{ verna.11.onward, + author = {Didier Verna}, + title = {Biological Realms in Computer Science: the Way You Don't + (Want To) Think About Them}, + booktitle = {Onward! 2011}, + year = {2011}, + note = {Accepted}, + abstract = {In biology, evolution is usually seen as a tinkering + process, different from what an engineer does when he plans + the development of his systems. Recently, studies have + shown that even in biology, there is a part of good + engineering. As computer scientists, we have much more + difficulty to admit that there is also a great deal of + tinkering in what we do, and that our software systems + behave more and more like biological realms every day. This + essay relates my personal experience about this + discovery.} +} + +@InProceedings{ verna.11.tug, + author = {Didier Verna}, + title = {Towards {\LaTeX} Coding Standards}, + booktitle = {TUGboat}, + OPTpages = {00--00}, + year = 2011, + OPTeditor = {Barbara Beeton and Karl Berry}, + OPTvolume = 00, + OPTnumber = 0, + project = {Software}, + OPTurllrde = {201100-TUG}, + note = {Accepted}, + abstract = {Because \LaTeX is only a macro-expansion system, the + language does not impose any kind of good software + engineering practice, program structure or coding style. + Maybe because in the \LaTeX world, collaboration is not so + widespread, the idea of some LaTeX Coding Standards is not + so pressing as with other programming languages. Over the + years, the permanent flow of personal development + experiences contributed to shape our own taste in terms of + coding style. In this paper, we report on all these + experiences and describe what we think are good programming + practices.} +} + +@InProceedings{ xue.03.icip, + author = {Heru Xue and {\relax Th}ierry G\'eraud and Alexandre + Duret-Lutz}, + title = {Multi-band segmentation using morphological clustering and + fusion application to color image segmentation}, + booktitle = {Proceedings of the IEEE International Conference on Image + Processing (ICIP)}, + year = 2003, + pages = {353--356}, + volume = 1, + address = {Barcelona, Spain}, + month = sep, + project = {Image}, + urllrde = {200309-Icip}, + abstract = {In this paper we propose a novel approach for color image + segmentation. Our approach is based on segmentation of + subsets of bands using mathematical morphology followed by + the fusion of the resulting segmentation channels. For + color images the band subsets are chosen as RG, RB and GB + pairs, whose 2D histograms are processed as projections of + a 3D histogram. The segmentations in 2D color spaces are + obtained using the watershed algorithm. These 2D + segmentations are then combined to obtain a final result + using a region split-and-merge process. The CIE L a b color + space is used to measure the color distance. Our approach + results in improved performance and can be generalized for + multi-band segmentation of images such as multi-spectral + satellite images information.} +} + +@InProceedings{ yoruk.04.eusipco, + author = {Erdem Yoruk and Ender Konukoglu and Bulent Sankur and + J\'er\^ome Darbon}, + title = {Person authentication based on hand shape}, + booktitle = {Proceedings of 12th European Signal Processing Conference + (EUSIPCO)}, + year = 2004, + address = {Vienna, Austria}, + month = sep, + project = {Image}, + urllrde = {200409-EUSIPCO}, + abstract = {The problem of person identification based on their hand + images has been addressed. The system is based on the + images of the right hands of the subjects, captured by a + flatbed scanner in an unconstrained pose. In a + preprocessing stage of the algorithm, the silhouettes of + hand images are registered to a fixed pose, which involves + both rotation and translation of the hand and, separately, + of the individual fingers. Independent component features + of the hand silhouette images are used for recognition. The + classification performance is found to be very satisfactory + and it was shown that, at least for groups of one hundred + subjects, hand-based recognition is a viable secure access + control scheme.} +} + +@Article{ yoruk.06.itip, + author = {Erdem Y\"or\"uk and Ender Konukoglu and B\"ulent Sankur + and J\'er\^ome Darbon}, + title = {Shape-based hand recognition}, + journal = {IEEE Transactions on Image Processing}, + year = 2006, + volume = 15, + number = 7, + pages = {1803--1815}, + month = jul, + project = {Image}, + urllrde = {2006XX-ITIP}, + abstract = {The problem of person recognition and verification based + on their hand images has been addressed. The system is + based on the images of the right hands of the subjects, + captured by a flatbed scanner in an unconstrained pose at + 45 dpi. In a preprocessing stage of the algorithm, the + silhouettes of hand images are registered to a fixed pose, + which involves both rotation and translation of the hand + and, separately, of the individual fingers. Two feature + sets have been comparatively assessed, Hausdorff distance + of the hand contours and independent component features of + the hand silhouette images. Both the classification and the + verification performances are found to be very satisfactory + as it was shown that, at least for groups of about five + hundred subjects, hand-based recognition is a viable secure + access control scheme.} +} + +%% Local Variables: +%% fill-column: 76 +%% ispell-local-dictionary: "american" +%% End: diff --git a/doc/mainpage.hh b/doc/mainpage.dox similarity index 80% rename from doc/mainpage.hh rename to doc/mainpage.dox index 116c69a..8f49ca3 100644 --- a/doc/mainpage.hh +++ b/doc/mainpage.dox @@ -13,8 +13,8 @@ <tr> <td> \li What is Olena ? - \li \ref bibliography - \li Contributors + \li <a class="el" href="http://www.lrde.epita.fr/cgi-bin/twiki/view/Olena/Publications">Bibliography</a> + \li <a class="el" href="a00028.html">Contributors</a> </td> <td> \li \ref moduleslist @@ -23,7 +23,7 @@ \li Swilena </td> <td> - \li Online Demos + \li <a class="el" href="http://www.lrde.epita.fr/cgi-bin/twiki/view/Olena/Demos">Online Demos</a> \li Papers Related Programs \li Olena Powered Programs </td> diff --git a/doc/modules_list.hh b/doc/modules_list.dox similarity index 100% rename from doc/modules_list.hh rename to doc/modules_list.dox diff --git a/doc/olena.qhcp b/doc/olena.qhcp deleted file mode 100644 index 595d34e..0000000 --- a/doc/olena.qhcp +++ /dev/null @@ -1,12 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<QHelpCollectionProject version="1.0"> - <assistant> - <startPage>qthelp://fr.epita.lrde.olena/milena-2.0/index.html</startPage> - </assistant> - <docFiles> - <register> - <file>../milena/doc/user-refman/html/milena.qch</file> - <file>../scribo/doc/user-refman/html/scribo.qch</file> - </register> - </docFiles> -</QHelpCollectionProject> \ No newline at end of file diff --git a/scribo/doc/Doxyfile.in b/scribo/doc/Doxyfile.in index d279d76..7ad639f 100644 --- a/scribo/doc/Doxyfile.in +++ b/scribo/doc/Doxyfile.in @@ -26,7 +26,7 @@ PROJECT_LOGO = @top_srcdir@/doc/logo.jpg OUTPUT_DIRECTORY = @builddir@/user-refman.tmp CREATE_SUBDIRS = YES OUTPUT_LANGUAGE = English -BRIEF_MEMBER_DESC = YES +BRIEF_MEMBER_DESC = NO REPEAT_BRIEF = YES ABBREVIATE_BRIEF = ALWAYS_DETAILED_SEC = YES @@ -47,6 +47,8 @@ BUILTIN_STL_SUPPORT = YES IDL_PROPERTY_SUPPORT = NO DISTRIBUTE_GROUP_DOC = NO SUBGROUPING = YES +INLINE_GROUPED_CLASSES = NO +SORT_GROUP_NAMES = YES #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- @@ -95,7 +97,8 @@ INPUT = @top_srcdir@/scribo FILE_PATTERNS = *.cc \ *.hh \ *.hxx \ - *.hcc + *.hcc \ + *.dox RECURSIVE = YES EXCLUDE = @top_srcdir@/scribo/demo \ @top_srcdir@/scribo/sandbox \ @@ -126,8 +129,8 @@ INPUT_ENCODING = ISO-8859-1 SOURCE_BROWSER = YES INLINE_SOURCES = NO STRIP_CODE_COMMENTS = YES -REFERENCED_BY_RELATION = YES -REFERENCES_RELATION = YES +REFERENCED_BY_RELATION = NO +REFERENCES_RELATION = NO REFERENCES_LINK_SOURCE = NO USE_HTAGS = NO VERBATIM_HEADERS = YES @@ -329,7 +332,7 @@ SKIP_FUNCTION_MACROS = YES TAGFILES = @builddir@/../../milena/doc/milena.tag=../../../../milena/doc/user-refman/html GENERATE_TAGFILE = scribo.tag ALLEXTERNALS = NO -EXTERNAL_GROUPS = YES +EXTERNAL_GROUPS = NO PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- # Configuration options related to the dot tool diff --git a/scribo/doc/groups.dox b/scribo/doc/groups.dox new file mode 100644 index 0000000..73d842e --- /dev/null +++ b/scribo/doc/groups.dox @@ -0,0 +1,19 @@ +/*! \defgroup grpstruct Data structures + * + * \brief Scribo high level data structures. + * + */ + + +/*! \defgroup grproutine Routines + * + * \brief All routines/algorithms provided in Scribo. + * + */ + + +/*! \defgroup grpalgobin Binarization + * + * \brief Binarization algorithms. + * + */ diff --git a/scribo/scribo/core/component_set.hh b/scribo/scribo/core/component_set.hh index ded64ae..8c3e83f 100644 --- a/scribo/scribo/core/component_set.hh +++ b/scribo/scribo/core/component_set.hh @@ -119,6 +119,10 @@ namespace scribo } // end of namespace scribo::internal + /// \brief Represents all the components in a document image. + /// + /// \ingroup grpstruct + // template <typename L> class component_set : public Serializable<component_set<L> > { diff --git a/scribo/scribo/core/document.hh b/scribo/scribo/core/document.hh index cc885e4..5bbd226 100644 --- a/scribo/scribo/core/document.hh +++ b/scribo/scribo/core/document.hh @@ -79,9 +79,12 @@ namespace scribo } // end of namespace scribo::internal - + /// \brief Represent document data and structure. + /// + /// \ingroup grpstruct + // template <typename L> - struct document : public Serializable<document<L> > + class document : public Serializable<document<L> > { typedef internal::document_data<L> data_t; diff --git a/scribo/scribo/core/line_links.hh b/scribo/scribo/core/line_links.hh index b7b438c..4f807e4 100644 --- a/scribo/scribo/core/line_links.hh +++ b/scribo/scribo/core/line_links.hh @@ -67,7 +67,9 @@ namespace scribo - /// \brief Line group representation. + /// \brief Line links representation. + /// + /// \ingroup grpstruct // template <typename L> class line_links : public Serializable<line_links<L> > diff --git a/scribo/scribo/core/line_set.hh b/scribo/scribo/core/line_set.hh index db987e6..4880a77 100644 --- a/scribo/scribo/core/line_set.hh +++ b/scribo/scribo/core/line_set.hh @@ -1,5 +1,5 @@ -// 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. // @@ -86,6 +86,9 @@ namespace scribo Line ids start from 1. + + \ingroup grpstruct + */ template <typename L> class line_set diff --git a/scribo/scribo/core/object_groups.hh b/scribo/scribo/core/object_groups.hh index 46447d2..53ba7f9 100644 --- a/scribo/scribo/core/object_groups.hh +++ b/scribo/scribo/core/object_groups.hh @@ -88,6 +88,8 @@ namespace scribo /// \brief Object group representation. + /// + /// \ingroup grpstruct // template <typename L> class object_groups : public Serializable<object_groups<L> > diff --git a/scribo/scribo/core/object_links.hh b/scribo/scribo/core/object_links.hh index 37fd299..a2543a7 100644 --- a/scribo/scribo/core/object_links.hh +++ b/scribo/scribo/core/object_links.hh @@ -69,7 +69,9 @@ namespace scribo - /// \brief Object group representation. + /// \brief Object links representation. + /// + /// \ingroup grpstruct // template <typename L> class object_links : public Serializable<object_links<L> > diff --git a/scribo/scribo/core/paragraph_set.hh b/scribo/scribo/core/paragraph_set.hh index c21359d..69194be 100644 --- a/scribo/scribo/core/paragraph_set.hh +++ b/scribo/scribo/core/paragraph_set.hh @@ -65,6 +65,7 @@ namespace scribo Paragraph ids start from 1. + \ingroup grpstruct */ template <typename L> class paragraph_set : public Serializable<paragraph_set<L> > -- 1.7.2.5

1 0

olena-2.0-15-gdc00c29 Introduce bib files.
by Guillaume Lazzara 29 Nov '11

29 Nov '11

--- Makefile.am | 4 +- doc/Doxyfile.in | 2 +- doc/Makefile.am | 18 ++- doc/bibliography.hh | 19 ++ doc/mainpage.hh | 44 +++-- doc/modules_list.hh | 9 + doc/olena.bib | 415 ++++++++++++++++++++++++++++++++++++++++ milena/doc/Doxyfile.in | 4 +- milena/doc/Makefile.am | 10 +- milena/mln/registration/icp.hh | 2 + scribo/Makefile.am | 2 +- scribo/doc/Makefile.am | 15 +- 12 files changed, 512 insertions(+), 32 deletions(-) create mode 100644 doc/bibliography.hh create mode 100644 doc/modules_list.hh create mode 100644 doc/olena.bib diff --git a/Makefile.am b/Makefile.am index 66dc10c..677a9c3 100644 --- a/Makefile.am +++ b/Makefile.am @@ -17,7 +17,7 @@ ACLOCAL_AMFLAGS = -I m4 -SUBDIRS = build-aux external milena +SUBDIRS = build-aux doc external milena if ENABLE_SWILENA SUBDIRS += swilena @@ -164,3 +164,5 @@ snapshot: && $(MAKE) $(AM_MAKEFLAGS) dist \ && mv -f $(srcdir)/configure.ac.old $(srcdir)/configure.ac #>> + + diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 106c58c..a0fcf00 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -112,7 +112,7 @@ INPUT_FILTER = FILTER_PATTERNS = FILTER_SOURCE_FILES = NO INPUT_ENCODING = ISO-8859-1 - +CITE_BIB_FILES = @top_srcdir@/doc/olena.bib #--------------------------------------------------------------------------- # configuration options related to source browsing #--------------------------------------------------------------------------- diff --git a/doc/Makefile.am b/doc/Makefile.am index ac2fd2e..e733ab9 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -53,11 +53,13 @@ regen-doc: DOXYFILE_USER = Doxyfile_user -REFMAN_deps = $(srcdir)/footer.html \ - $(srcdir)/header.html \ - $(srcdir)/doxygen.css \ - $(srcdir)/mainpage.hh \ - $(srcdir)/DoxygenLayout.xml +REFMAN_deps = $(srcdir)/footer.html \ + $(srcdir)/header.html \ + $(srcdir)/doxygen.css \ + $(srcdir)/mainpage.hh \ + $(srcdir)/DoxygenLayout.xml \ + $(srcdir)/modules_list.hh \ + $(srcdir)/olena.bib # Sed is used to generate Doxyfile from Doxyfile.in instead of # configure, because the former is way faster than the latter. @@ -142,6 +144,12 @@ install-data-local: # special case. rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN) cp -r $(srcdir)/$(USER_REFMAN)/html $(DESTDIR)$(htmldir)/$(USER_REFMAN) +# Update paths to milena documentation directory + $(DESTDIR)$(htmldir)/$(USER_REFMAN)/installdox \ + -l milena.tag@$(DESTDIR)$(htmldir)/$(USER_REFMAN)/milena \ + `find $(DESTDIR)$(htmldir)/$(USER_REFMAN)/ -name '*.html'` \ + -l scribo.tag@$(DESTDIR)$(htmldir)/$(USER_REFMAN)/scribo \ + `find $(DESTDIR)$(htmldir)/$(USER_REFMAN)/ -name '*.html'` ## Try GNU chmod's X mode before resorting to something slower but ## more standard. chmod -R a+rX $(DESTDIR)$(htmldir) || \ diff --git a/doc/bibliography.hh b/doc/bibliography.hh new file mode 100644 index 0000000..841372b --- /dev/null +++ b/doc/bibliography.hh @@ -0,0 +1,19 @@ +/** \page bibliography Bibliography + + Here you can find all the articles related to the Olena platform. + + \li \cite burrus.03.mpool + \li \cite darbon.02.ismm + \li \cite darbon.04.ecoopphd + \li \cite duret.00.gcse + \li \cite geraud.00.icpr + \li \cite geraud.01.ai + \li \cite geraud.08.mpool + \li \cite geraud.99.gretsi + \li \cite lazzara.11.icdar + \li \cite levillain.09.ismm + \li \cite levillain.10.icip + \li \cite levillain.10.wadgmm + \li \cite levillain.11.gretsi + + */ diff --git a/doc/mainpage.hh b/doc/mainpage.hh index 0704753..116c69a 100644 --- a/doc/mainpage.hh +++ b/doc/mainpage.hh @@ -6,26 +6,46 @@ <table class="doxtable itable"> <tr> - <th>General Presentation</th> - <th>Modules</th> - <th>Applications</th> + <th>General Presentation</th> + <th>Modules</th> + <th>Applications</th> </tr> <tr> - <td><ul><li>What is Olena ?</li><li>Bibliography</li><li>Contributors</li></ul></td> - <td><ul><li>List of Available modules</li><li><a href='../../../milena/doc/user-refman/html/index.html'>Milena</a></li><li><a href='../../../scribo/doc/user-refman/html/index.html'>Scribo</a></li><li>Swilena</li></ul></td> - <td><ul><li>Online Demos</li><li>Papers Related Programs</li><li>Olena Powered Programs</li></ul></td> + <td> + \li What is Olena ? + \li \ref bibliography + \li Contributors + </td> + <td> + \li \ref moduleslist + \li <a class="el" doxygen="milena.tag:../../../milena/doc/user-refman/html" href="../../../milena/doc/user-refman/html/index.html">Milena</a> + \li <a class="el" doxygen="scribo.tag:../../../scribo/doc/user-refman/html" href="../../../scribo/doc/user-refman/html/index.html">Scribo</a> + \li Swilena + </td> + <td> + \li Online Demos + \li Papers Related Programs + \li Olena Powered Programs + </td> </tr> <tr> - <th>Contributing</th> - <th>Licensing</th> - <th> </th> + <th>Contributing</th> + <th>Licensing</th> + <th> </th> </tr> <tr> - <td><ul><li>Report Bugs and Make Suggestions</li><li>Get the Sources</li><li>Online Resources</li></ul></td> - <td><ul><li>GNU GPL</li><li>Commercial Use</li></ul></td> - <td> </td> + <td> + \li Report Bugs and Make Suggestions + \li Get the Sources + \li Online Resources + </td> + <td> + \li GNU GPL + \li Commercial Use + </td> + <td> </td> </tr> </table> diff --git a/doc/modules_list.hh b/doc/modules_list.hh new file mode 100644 index 0000000..e3f2b8d --- /dev/null +++ b/doc/modules_list.hh @@ -0,0 +1,9 @@ +/** \page moduleslist List of available modules + +As a platform, Olena is divided in several modules: + +\li Milena, a generic image processing library. +\li Scribo, a framework for document image analysis. +\li Swilena, Python bindings for Milena. + + */ diff --git a/doc/olena.bib b/doc/olena.bib new file mode 100644 index 0000000..248a22d --- /dev/null +++ b/doc/olena.bib @@ -0,0 +1,415 @@ +@InProceedings{ burrus.03.mpool, + author = {Nicolas Burrus and Alexandre Duret-Lutz and {\relax + Th}ierry G\'eraud and David Lesage and Rapha\"el Poss}, + title = {A static {C++} object-oriented programming ({SCOOP}) + paradigm mixing benefits of traditional {OOP} and generic + programming}, + booktitle = {Proceedings of the Workshop on Multiple Paradigm with + Object-Oriented Languages (MPOOL)}, + year = 2003, + address = {Anaheim, CA, USA}, + month = oct, + project = {Olena}, + urllrde = {200310-MPOOL}, + abstract = {Object-oriented and generic programming are both supported + in C++. OOP provides high expressiveness whereas GP leads + to more efficient programs by avoiding dynamic typing. This + paper presents SCOOP, a new paradigm which enables both + classical OO design and high performance in C++ by mixing + OOP and GP. We show how classical and advanced OO features + such as virtual methods, multiple inheritance, argument + covariance, virtual types and multimethods can be + implemented in a fully statically typed model, hence + without run-time overhead.} +} + + +@InProceedings{ darbon.02.ismm, + author = {J\'er\^ome Darbon and {\relax Th}ierry G\'eraud and + Alexandre Duret-Lutz}, + title = {Generic implementation of morphological image operators}, + booktitle = {Mathematical Morphology, Proceedings of the 6th + International Symposium (ISMM)}, + pages = {175--184}, + year = 2002, + address = {Sydney, Australia}, + month = apr, + publisher = {CSIRO Publishing}, + project = {Olena}, + urllrde = {200204-Ismm}, + abstract = {Several libraries dedicated to mathematical morphology + exist. But they lack genericity, that is to say, the + ability for operators to accept input of different natures + ---2D binary images, graphs enclosing floating values, etc. + We describe solutions which are integrated in Olena, a + library providing morphological operators. We demonstrate + with some examples that translating mathematical formulas + and algorithms into source code is made easy and safe with + Olena. Moreover, experimental results show that no extra + costs at run-time are induced.} +} + +@InProceedings{ darbon.04.ecoopphd, + author = {J\'er\^ome Darbon and {\relax Th}ierry G\'eraud and + Patrick Bellot}, + title = {Generic algorithmic blocks dedicated to image processing}, + booktitle = {Proceedings of the ECOOP Workshop for PhD Students}, + year = 2004, + address = {Oslo, Norway}, + month = jun, + project = {Olena}, + urllrde = {200406-ECOOPPHD}, + abstract = {This paper deals with the implementation of algorithms in + the specific domain of image processing. Although many + image processing libraries are available, they generally + lack genericity and flexibility. Many image processing + algorithms can be expressed as compositions of elementary + algorithmic operations referred to as blocks. Implementing + these compositions is achieved using generic programming. + Our solution is compared to previous ones and we + demonstrate it on a class image processing algorithms.} +} + +@InProceedings{ duret.00.gcse, + author = {Alexandre Duret-Lutz}, + title = {Olena: a component-based platform for image processing, + mixing generic, generative and {OO} programming}, + booktitle = {Proceedings of the 2nd International Symposium on + Generative and Component-Based Software Engineering + (GCSE)---Young Researchers Workshop; published in + ``Net.ObjectDays2000''}, + pages = {653--659}, + year = 2000, + address = {Erfurt, Germany}, + month = oct, + isbn = {3-89683-932-2}, + project = {Olena}, + urllrde = {200010-NetObjectDays}, + abstract = {This paper presents Olena, a toolkit for programming and + designing image processing chains in which each processing + is a component. But since there exist many image types + (different structures such as 2D images, 3D images or + graphs, as well as different value types) the platform has + been designed with genericity and reusability in mind: each + component is written as a generic C++ procedure, \`a la + STL. Other libraries, such as Khoros [Kon94] have a + different approach where a processing component contains an + implementation for each type supported by the library. This + makes code maintenance hard and prevents easy addition of + new image types. Still, Olena is not only a generic + component library [Jaz95], it shall contain additional + tools such as a visual programming environment (VPE). Those + tools may be programmed in a classical object-oriented + fashion (using operation and inclusion polymorphism) which + may seems antagonist with the generic programming paradigm + used in the library. Section 2 outlines the architecture of + Olena and elaborates more on the design problems resulting + from the use of generic components. Section 3 presents the + solution chosen to address these problems.} +} + + +@InProceedings{ geraud.00.icpr, + author = {{\relax Th}ierry G\'eraud and Yoann Fabre and Alexandre + Duret-Lutz and Dimitri Papadopoulos-Orfanos and + Jean-Fran\c{c}ois Mangin}, + title = {Obtaining genericity for image processing and pattern + recognition algorithms}, + booktitle = {Proceedings of the 15th International Conference on + Pattern Recognition (ICPR)}, + year = 2000, + month = sep, + address = {Barcelona, Spain}, + volume = 4, + pages = {816--819}, + publisher = {IEEE Computer Society}, + project = {Olena}, + urllrde = {200009-Icpr}, + abstract = {Algorithm libraries dedicated to image processing and + pattern recognition are not reusable; to run an algorithm + on particular data, one usually has either to rewrite the + algorithm or to manually ``copy, paste, and modify''. This + is due to the lack of genericity of the programming + paradigm used to implement the libraries. In this paper, we + present a recent paradigm that allows algorithms to be + written once and for all and to accept input of various + types. Moreover, this total reusability can be obtained + with a very comprehensive writing and without significant + cost at execution, compared to a dedicated algorithm. This + new paradigm is called ``generic programming'' and is fully + supported by the C++ language. We show how this paradigm + can be applied to image processing and pattern recognition + routines. The perspective of our work is the creation of a + generic library.} +} + +@InProceedings{ geraud.01.ai, + author = {{\relax Th}ierry G\'eraud and Yoann Fabre and Alexandre + Duret-Lutz}, + title = {Applying generic programming to image processing}, + booktitle = {Proceedings of the IASTED International Conference on + Applied Informatics (AI)---Symposium on Advances in + Computer Applications}, + year = 2001, + publisher = {ACTA Press}, + editor = {M.H.~Hamsa}, + address = {Innsbruck, Austria}, + pages = {577--581}, + month = feb, + project = {Olena}, + urllrde = {200102-Ai}, + abstract = {This paper presents the evolution of algorithms + implementation in image processing libraries and discusses + the limits of these implementations in terms of + reusability. In particular, we show that in C++, an + algorithm can have a general implementation; said + differently, an implementation can be generic, i.e., + independent of both the input aggregate type and the type + of the data contained in the input aggregate. A total + reusability of algorithms can therefore be obtained; + moreover, a generic implementation is more natural and does + not introduce a meaningful additional cost in execution + time as compared to an implementation dedicated to a + particular input type.} +} + + +@InProceedings{ geraud.08.mpool, + author = {{\relax Th}ierry G\'eraud and Roland Levillain}, + title = {Semantics-Driven Genericity: A Sequel to the Static {C++} + Object-Oriented Programming Paradigm ({SCOOP 2})}, + booktitle = {Proceedings of the 6th International Workshop on + Multiparadigm Programming with Object-Oriented Languages + (MPOOL)}, + year = 2008, + address = {Paphos, Cyprus}, + month = jul, + project = {Olena}, + urllrde = {200807-MPOOL}, + abstract = {Classical (unbounded) genericity in \Cxx{}03 defines the + interactions between generic data types and algorithms in + terms of concepts. Concepts define the requirements over a + type (or a parameter) by expressing constraints on its + methods and dependent types (typedefs). The upcoming + \Cxx{}0x standard will promote concepts from abstract + entities (not directly enforced by the tools) to language + constructs, enabling compilers and tools to perform + additional checks on generic constructs as well as enabling + new features (e.g., concept-based overloading). Most modern + languages support this notion of signature on generic + types. However, generic types built on other types and + relying on concepts to both ensure type conformance and + drive code specialization, restrain the interface and the + implementation of the newly created type: specific methods + and associated types not mentioned in the concept will not + be part of the new type. The paradigm of concept-based + genericity lacks the required semantics to transform types + while retaining or adapting their intrinsic capabilities. + We present a new form of semantically-enriched genericity + allowing static generic type transformations through a + simple form of type introspection based on type metadata + called properties. This approach relies on a new Static + \Cxx Object-Oriented Programming (SCOOP) paradigm, and is + adapted to the creation of generic and efficient libraries, + especially in the field of scientific computing. Our + proposal uses a metaprogramming facility built into a \Cxx + library called Static, and doesn't require any language + extension nor additional processing (preprocessor, + transformation tool).} +} + +@InProceedings{ geraud.99.gretsi, + author = {{\relax Th}ierry G\'eraud and Yoann Fabre and Dimitri + Papadopoulos-Orfanos and Jean-Fran\c{c}ois Mangin}, + title = {Vers une r\'eutilisabilit\'e totale des algorithmes de + traitement d'images}, + booktitle = {Proceedings of the 17th Symposium on Signal and Image + Processing (GRETSI)}, + category = {national}, + pages = {331--334}, + volume = 2, + year = 1999, + address = {Vannes, France}, + month = sep, + note = {In French}, + project = {Olena}, + urllrde = {199909-Gretsi}, + abstract = {Cet article pr\'esente l'\'evolution des techniques de + programmation d'algorithmes de traitement d'images et + discute des limites de la r\'eutilisabilit\'e de ces + algorithmes. En particulier, nous montrons qu'en C++ un + algorithme peut s'\'ecrire sous une forme g\'en\'erale, + ind\'ependante aussi bien du type des donn\'ees que du type + des structures de donn\'ees sur lesquelles il peut + s'appliquer. Une r\'eutilisabilit\'e totale des algorithmes + peut donc \^etre obtenue ; mieux, leur \'ecriture est plus + naturelle et elle n'introduit pas de surco\^ut significatif + en temps d'ex\'ecution.} +} + + +@InProceedings{ lazzara.11.icdar, + author = {Guillaume Lazzara and Roland Levillain and {\relax + Th}ierry G\'eraud and Yann Jacquelet and Julien Marquegnies + and Arthur Cr\'epin-Leblond}, + title = {The {SCRIBO} Module of the {Olena} Platform: a Free + Software Framework for Document Image Analysis}, + booktitle = {Proceedings of the 11th International Conference on + Document Analysis and Recognition (ICDAR)}, + year = 2011, + address = {Beijing, China}, + month = sep, + organization = {International Association for Pattern Recognition (IAPR)}, + note = {Accepted}, + project = {Olena}, + urllrde = {201109-ICDAR}, + abstract = {Electronic documents are being more and more usable thanks + to better and more affordable network, storage and + computational facilities. But in order to benefit from + computer-aided document management, paper documents must be + digitized and analyzed. This task may be challenging at + several levels. Data may be of multiple types thus + requiring different adapted processing chains. The tools to + be developed should also take into account the needs and + knowledge of users, ranging from a simple graphical + application to a complete programming framework. Finally, + the data sets to process may be large. In this paper, we + expose a set of features that a Document Image Analysis + framework should provide to handle the previous issues. In + particular, a good strategy to address both flexibility and + efficiency issues is the Generic Programming (GP) paradigm. + These ideas are implemented as an open source module, + SCRIBO, built on top of Olena, a generic and efficient + image processing platform. Our solution features services + such as preprocessing filters, text detection, page + segmentation and document reconstruction (as XML, PDF or + HTML documents). This framework, composed of reusable + software components, can be used to create full-fledged + graphical applications, small utilities, or processing + chains to be integrated into third-party projects.}, + keywords = {Document Image Analysis, Software Design, Reusability, + Free Software} +} + +@InProceedings{ levillain.09.ismm, + author = {Roland Levillain and {\relax Th}ierry G\'eraud and Laurent + Najman}, + title = {{Milena}: Write Generic Morphological Algorithms Once, Run + on Many Kinds of Images}, + booktitle = {Mathematical Morphology and Its Application to Signal and + Image Processing -- Proceedings of the Ninth International + Symposium on Mathematical Morphology (ISMM)}, + pages = {295--306}, + year = 2009, + editor = {Michael H. F. Wilkinson and Jos B. T. M. Roerdink}, + series = {Lecture Notes in Computer Science}, + address = {Groningen, The Netherlands}, + month = aug, + publisher = {Springer Berlin / Heidelberg}, + volume = 5720, + project = {Olena}, + urllrde = {200908-ISMM}, + abstract = {We present a programming framework for discrete + mathematical morphology centered on the concept of + genericity. We show that formal definitions of + morphological algorithms can be translated into actual + code, usable on virtually any kind of compatible images, + provided a general definition of the concept of image is + given. This work is implemented in Milena, a generic, + efficient, and user-friendly image processing library.}, + keywords = {mathematical morphology, image processing operator, + genericity, programming} +} + +@InProceedings{ levillain.10.icip, + author = {Roland Levillain and {\relax Th}ierry G\'eraud and Laurent + Najman}, + title = {Why and How to Design a Generic and Efficient Image + Processing Framework: The Case of the {Milena} Library}, + booktitle = {Proceedings of the IEEE International Conference on Image + Processing (ICIP)}, + pages = {1941--1944}, + year = 2010, + address = {Hong Kong}, + month = sep, + project = {Olena}, + urllrde = {201009-ICIP}, + abstract = {Most image processing frameworks are not generic enough to + provide true reusability of data structures and algorithms. + In fact, genericity allows users to write and experiment + virtually any method on any compatible input(s). In this + paper, we advocate the use of generic programming in the + design of image processing software, while preserving + performances close to dedicated code. The implementation of + our proposal, Milena, a generic and efficient library, + illustrates the benefits of our approach.}, + keywords = {Genericity, Image Processing, Software Design, + Reusability, Efficiency} +} + +@InProceedings{ levillain.10.wadgmm, + author = {Roland Levillain and {\relax Th}ierry G\'eraud and Laurent + Najman}, + title = {Writing Reusable Digital Geometry Algorithms in a Generic + Image Processing Framework}, + booktitle = {Proceedings of the Workshop on Applications of Digital + Geometry and Mathematical Morphology (WADGMM)}, + pages = {96--100}, + year = 2010, + address = {Istanbul, Turkey}, + month = aug, + url = {http://mdigest.jrc.ec.europa.eu/wadgmm2010/}, + project = {Olena}, + urllrde = {201008-WADGMM}, + abstract = {Digital Geometry software should reflect the generality of + the underlying mathematics: mapping the latter to the + former requires genericity. By designing generic solutions, + one can effectively reuse digital geometry data structures + and algorithms. We propose an image processing framework + centered on the Generic Programming paradigm in which an + algorithm on the paper can be turn into a single code, + written once and usable with various input types. This + approach enables users to design and implement new methods + at a lower cost, try cross-domain experiments and help + generalize results.}, + keywords = {Generic Programming, Interface, Skeleton, Complex} +} + +@InProceedings{ levillain.11.gretsi, + author = {Roland Levillain and {\relax Th}ierry G\'eraud and Laurent + Najman}, + title = {Une approche g\'en\'erique du logiciel pour le traitement + d'images pr\'eservant les performances}, + booktitle = {Proceedings of the 23rd Symposium on Signal and Image + Processing (GRETSI)}, + category = {national}, + year = 2011, + address = {Bordeaux, France}, + month = sep, + note = {In French. Accepted}, + project = {Olena}, + urllrde = {201109-GRETSI}, + abstract = {De plus en plus d'outils logiciels modernes pour le + traitement d'images sont con\,c{}us en prenant en compte le + probl\`eme de la g\'en\'ericit\'e du code, c'est-\`a-dire + la possibilit\'e d'\'ecrire des algorithmes + r\'eutilisables, compatibles avec de nombreux types + d'entr\'ees. Cependant, ce choix de conception se fait + souvent au d\'etriment des performances du code + ex\'ecut\'e. Du fait de la grande vari\'et\'e des types + d'images existants et de la n\'ecessit\'e d'avoir des + impl\'ementations rapides, g\'en\'ericit\'e et performance + apparaissent comme des qualit\'es essentielles du logiciel + en traitement d'images. Cet article pr\'esente une approche + pr\'eservant les performances dans un framework logiciel + g\'en\'erique tirant parti des caract\'eristiques des types + de donn\'ees utilis\'es. Gr\^ace \`a celles-ci, il est + possible d'\'ecrire des variantes d'algorithmes + g\'en\'eriques offrant un compromis entre g\'en\'ericit\'e + et performance. Ces alternatives sont capables de + pr\'eserver une partie des aspects g\'en\'eriques d'origine + tout en apportant des gains substantiels \`a l'ex\'ecution. + D'apr\`es nos essais, ces optimisations g\'en\'eriques + fournissent des performances supportant la comparaison avec + du code d\'edi\'e, allant parfois m\^eme jusqu'\`a surpasser des routines optimis\'ees manuellement.} +} diff --git a/milena/doc/Doxyfile.in b/milena/doc/Doxyfile.in index c1b0bc6..7790ce6 100644 --- a/milena/doc/Doxyfile.in +++ b/milena/doc/Doxyfile.in @@ -122,7 +122,7 @@ INPUT_FILTER = FILTER_PATTERNS = FILTER_SOURCE_FILES = NO INPUT_ENCODING = ISO-8859-1 -CITE_BIB_FILES = $top_srcdir$/doc/doc.bib +CITE_BIB_FILES = @top_srcdir@/doc/doc.bib #--------------------------------------------------------------------------- # configuration options related to source browsing #--------------------------------------------------------------------------- @@ -149,7 +149,7 @@ HTML_FILE_EXTENSION = .html HTML_HEADER = @top_srcdir@/doc/header.html HTML_FOOTER = @top_srcdir@/doc/subdoc_footer.html HTML_STYLESHEET = @top_srcdir@/doc/doxygen.css -LAYOUT_FILE = @top_srcdir@/doc/DoxygenLayout.xml +LAYOUT_FILE = @top_srcdir@/milena/doc/DoxygenLayout.xml HTML_ALIGN_MEMBERS = YES GENERATE_HTMLHELP = NO CHM_FILE = diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index 2132c7e..99dd4c6 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -739,11 +739,11 @@ DATA_html_dirs_inst = $(WHITE_PAPER) # .../srcdoc", which installs our dir into the previous one, instead # of replacing it. install-data-local: - $(mkdir_p) $(DESTDIR)$(htmldir) + $(mkdir_p) $(DESTDIR)$(htmldir)/$(USER_REFMAN) # The user reference manual is located in a subdirectory, hence this # special case. - rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN) - cp -r $(srcdir)/$(USER_REFMAN)/html $(DESTDIR)$(htmldir)/$(USER_REFMAN) + rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN)/milena + cp -r $(srcdir)/$(USER_REFMAN)/html $(DESTDIR)$(htmldir)/$(USER_REFMAN)/milena # Other HTML directories can be processed uniformly. for d in $(DATA_html_dirs_inst); do \ rm -rf $(DESTDIR)$(htmldir)/$$d; \ @@ -762,5 +762,5 @@ uninstall-local: done # Same remark as above regarding the special case of the user # reference manual. - chmod -R 700 $(DESTDIR)$(htmldir)/$(USER_REFMAN) - rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN) + chmod -R 700 $(DESTDIR)$(htmldir)/$(USER_REFMAN)/milena + rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN)/milena diff --git a/milena/mln/registration/icp.hh b/milena/mln/registration/icp.hh index 9448a2f..4c3bd51 100644 --- a/milena/mln/registration/icp.hh +++ b/milena/mln/registration/icp.hh @@ -107,6 +107,8 @@ namespace mln * * \pre \p P_ and \p X must not be empty. * + * \cite besl.92.pami + * * Reference article: "A Method for Registration of 3-D Shapes", Paul J. * Besl and Neil D. McKay, IEEE, 2, February 1992. * diff --git a/scribo/Makefile.am b/scribo/Makefile.am index b9a590a..cf8a4c6 100644 --- a/scribo/Makefile.am +++ b/scribo/Makefile.am @@ -15,7 +15,7 @@ # You should have received a copy of the GNU General Public License # along with Olena. If not, see <http://www.gnu.org/licenses/>. -SUBDIRS = demo tests src +SUBDIRS = demo doc tests src .PHONY: bin diff --git a/scribo/doc/Makefile.am b/scribo/doc/Makefile.am index f1fae6c..6469ab9 100644 --- a/scribo/doc/Makefile.am +++ b/scribo/doc/Makefile.am @@ -223,11 +223,16 @@ maintainer-clean-local: # .../srcdoc", which installs our dir into the previous one, instead # of replacing it. install-data-local: - $(mkdir_p) $(DESTDIR)$(htmldir) + $(mkdir_p) $(DESTDIR)$(htmldir)/$(USER_REFMAN) # The user reference manual is located in a subdirectory, hence this # special case. - rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN) - cp -r $(srcdir)/$(USER_REFMAN)/html $(DESTDIR)$(htmldir)/$(USER_REFMAN) + rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN)/scribo + cp -r $(srcdir)/$(USER_REFMAN)/html \ + $(DESTDIR)$(htmldir)/$(USER_REFMAN)/scribo +# Update paths to milena documentation directory + $(DESTDIR)$(htmldir)/$(USER_REFMAN)/scribo/installdox \ + -l milena.tag@$(DESTDIR)$(htmldir)/$(USER_REFMAN)/milena \ + `find $(DESTDIR)$(htmldir)/$(USER_REFMAN)/scribo/ -name '*.html'` # Other HTML directories can be processed uniformly. for d in $(DATA_html_dirs_inst); do \ rm -rf $(DESTDIR)$(htmldir)/$$d; \ @@ -246,5 +251,5 @@ uninstall-local: done # Same remark as above regarding the special case of the user # reference manual. - chmod -R 700 $(DESTDIR)$(htmldir)/$(USER_REFMAN) - rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN) + chmod -R 700 $(DESTDIR)$(htmldir)/$(USER_REFMAN)/scribo + rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN)/scribo -- 1.7.2.5

1 0

olena-2.0-14-g81ff577 Add support for bib files in Milena's doc.
by Guillaume Lazzara 29 Nov '11

29 Nov '11

--- doc/doc.bib | 12 ++++++++++++ milena/doc/Doxyfile.in | 2 +- 2 files changed, 13 insertions(+), 1 deletions(-) create mode 100644 doc/doc.bib diff --git a/doc/doc.bib b/doc/doc.bib new file mode 100644 index 0000000..b116a98 --- /dev/null +++ b/doc/doc.bib @@ -0,0 +1,12 @@ +(a)Article{besl.92.pami, + author = "P.J. Besl and N.D. McKay", + title = "A Method for Registration of 3-D Shapes", + journal = "IEEE Transactions on Pattern Analysis and Machine Intelligence", + volume = "14", + issn = "0162-8828", + year = "1992", + pages = "239--256", + doi = "http://doi.ieeecomputersociety.org/10.1109/34.121791", + publisher = "IEEE Computer Society", + address = "Los Alamitos, CA, USA" +} \ No newline at end of file diff --git a/milena/doc/Doxyfile.in b/milena/doc/Doxyfile.in index 494d99c..c1b0bc6 100644 --- a/milena/doc/Doxyfile.in +++ b/milena/doc/Doxyfile.in @@ -122,7 +122,7 @@ INPUT_FILTER = FILTER_PATTERNS = FILTER_SOURCE_FILES = NO INPUT_ENCODING = ISO-8859-1 - +CITE_BIB_FILES = $top_srcdir$/doc/doc.bib #--------------------------------------------------------------------------- # configuration options related to source browsing #--------------------------------------------------------------------------- -- 1.7.2.5

1 0

olena-2.0-13-gd88afde First draft of unified doc.
by Guillaume Lazzara 29 Nov '11

29 Nov '11

--- configure.ac | 2 + doc/.gitignore | 9 + doc/Doxyfile.in | 361 +++++++++ doc/DoxygenLayout.xml | 184 +++++ doc/Makefile.am | 155 ++++ doc/doxygen.css | 856 ++++++++++++++++++++ doc/footer.html | 5 + doc/header.html | 46 ++ doc/logo.jpg | Bin 0 -> 7477 bytes doc/mainpage.hh | 38 + doc/olena.qhcp | 12 + doc/subdoc_footer.html | 6 + milena/doc/Doxyfile.in | 42 +- milena/doc/DoxygenLayout.xml | 184 +++++ milena/doc/milena.qhcp | 11 + scribo/doc/.gitignore | 13 + scribo/doc/Doxyfile.in | 373 +++++++++ scribo/doc/DoxygenLayout.xml | 184 +++++ scribo/doc/Makefile.am | 250 ++++++ {milena => scribo}/doc/doxyfuns.sty | 0 .../doc/examples-outputs.mk | 0 scribo/doc/examples.mk | 4 + .../doc/examples/dummy.cc | 0 .../doc/figures.mk | 0 {milena => scribo}/doc/gen-examples-outputs-mk | 0 {milena => scribo}/doc/gen-figures-mk | 0 {milena => scribo}/doc/gen-make-variable | 0 {milena => scribo}/doc/gen-split-examples-mk | 0 {milena => scribo}/doc/gen-split-outputs-mk | 0 {milena => scribo}/doc/graphicx.hva | 0 scribo/doc/outputs.mk | 4 + .../doc/outputs/dummy.txt | 0 .../doc/programs-examples.mk | 0 scribo/doc/scribo.qhcp | 11 + milena/doc/milena.sty => scribo/doc/scribo.sty | 0 .../doc/split-examples.mk | 0 .../doc/split-outputs.mk | 0 {milena => scribo}/doc/tools/todoxygen.sh | 0 .../doc/tutorial.tex | 0 39 files changed, 2735 insertions(+), 15 deletions(-) create mode 100644 doc/.gitignore create mode 100644 doc/Doxyfile.in create mode 100644 doc/DoxygenLayout.xml create mode 100644 doc/Makefile.am create mode 100644 doc/doxygen.css create mode 100644 doc/footer.html create mode 100644 doc/header.html create mode 100644 doc/logo.jpg create mode 100644 doc/mainpage.hh create mode 100644 doc/olena.qhcp create mode 100644 doc/subdoc_footer.html create mode 100644 milena/doc/DoxygenLayout.xml create mode 100644 milena/doc/milena.qhcp create mode 100644 scribo/doc/.gitignore create mode 100644 scribo/doc/Doxyfile.in create mode 100644 scribo/doc/DoxygenLayout.xml create mode 100644 scribo/doc/Makefile.am copy {milena => scribo}/doc/doxyfuns.sty (100%) copy milena/doc/outputs/accu-right-instantiation.txt => scribo/doc/examples-outputs.mk (100%) create mode 100644 scribo/doc/examples.mk copy milena/doc/outputs/accu-right-instantiation.txt => scribo/doc/examples/dummy.cc (100%) copy milena/doc/outputs/accu-right-instantiation.txt => scribo/doc/figures.mk (100%) copy {milena => scribo}/doc/gen-examples-outputs-mk (100%) copy {milena => scribo}/doc/gen-figures-mk (100%) copy {milena => scribo}/doc/gen-make-variable (100%) copy {milena => scribo}/doc/gen-split-examples-mk (100%) copy {milena => scribo}/doc/gen-split-outputs-mk (100%) copy {milena => scribo}/doc/graphicx.hva (100%) create mode 100644 scribo/doc/outputs.mk copy milena/doc/outputs/accu-right-instantiation.txt => scribo/doc/outputs/dummy.txt (100%) copy milena/doc/outputs/accu-right-instantiation.txt => scribo/doc/programs-examples.mk (100%) create mode 100644 scribo/doc/scribo.qhcp copy milena/doc/milena.sty => scribo/doc/scribo.sty (100%) copy milena/doc/outputs/accu-right-instantiation.txt => scribo/doc/split-examples.mk (100%) copy milena/doc/outputs/accu-right-instantiation.txt => scribo/doc/split-outputs.mk (100%) copy {milena => scribo}/doc/tools/todoxygen.sh (100%) copy milena/doc/outputs/accu-right-instantiation.txt => scribo/doc/tutorial.tex (100%) diff --git a/configure.ac b/configure.ac index a53bcf8..d07ecdb 100644 --- a/configure.ac +++ b/configure.ac @@ -339,6 +339,7 @@ AC_CONFIG_FILES([ scribo/demo/review/Makefile scribo/demo/viewer/Makefile scribo/demo/xml2doc/Makefile + scribo/doc/Makefile scribo/src/Makefile scribo/src/binarization/Makefile scribo/src/contest/Makefile @@ -406,6 +407,7 @@ AC_CONFIG_FILES([milena/doc/tools/data.hh]) # Ask for the Makefile creations. AC_CONFIG_FILES([ Makefile + doc/Makefile external/Makefile milena/Makefile milena/doc/Makefile diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 0000000..9b600ce --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1,9 @@ +/Doxyfile_user +/user-refman +/user-refman.pdf + +/Doxyfile_devel +/devel-refman +/devel-refman.pdf + +/figures/*.png diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in new file mode 100644 index 0000000..106c58c --- /dev/null +++ b/doc/Doxyfile.in @@ -0,0 +1,361 @@ +# Copyright (C) 2011 EPITA Research and Development Laboratory (LRDE) +# +# This file is part of Olena. +# +# Olena is free software: you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation, version 2 of the License. +# +# Olena is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Olena. If not, see <http://www.gnu.org/licenses/>. +# +# Doxyfile 1.5.1 + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- +PROJECT_NAME = "Olena" +PROJECT_NUMBER = "@PACKAGE_VERSION@" +PROJECT_BRIEF = "An Image Processing Platform" +PROJECT_LOGO = @top_srcdir@/doc/logo.jpg +OUTPUT_DIRECTORY = @builddir@/user-refman.tmp +CREATE_SUBDIRS = NO +OUTPUT_LANGUAGE = English +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ABBREVIATE_BRIEF = +ALWAYS_DETAILED_SEC = YES +INLINE_INHERITED_MEMB = YES +FULL_PATH_NAMES = NO +STRIP_FROM_PATH = @top_srcdir@ +STRIP_FROM_INC_PATH = +SHORT_NAMES = YES +JAVADOC_AUTOBRIEF = YES +MULTILINE_CPP_IS_BRIEF = NO +INHERIT_DOCS = YES +SEPARATE_MEMBER_PAGES = NO +TAB_SIZE = 8 +ALIASES = +OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_JAVA = NO +BUILTIN_STL_SUPPORT = YES +IDL_PROPERTY_SUPPORT = NO +DISTRIBUTE_GROUP_DOC = NO +SUBGROUPING = YES +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- +EXTRACT_ALL = NO +EXTRACT_PRIVATE = NO +EXTRACT_STATIC = NO +EXTRACT_LOCAL_CLASSES = NO +EXTRACT_LOCAL_METHODS = NO +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +HIDE_FRIEND_COMPOUNDS = YES +HIDE_IN_BODY_DOCS = YES +INTERNAL_DOCS = NO +CASE_SENSE_NAMES = YES +HIDE_SCOPE_NAMES = NO +SHOW_INCLUDE_FILES = NO +INLINE_INFO = YES +SORT_MEMBER_DOCS = YES +SORT_BRIEF_DOCS = YES +SORT_BY_SCOPE_NAME = YES +GENERATE_TODOLIST = NO +GENERATE_TESTLIST = NO +GENERATE_BUGLIST = NO +GENERATE_DEPRECATEDLIST= NO +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 30 +SHOW_USED_FILES = NO # Disabled for light doc +SHOW_DIRECTORIES = NO # Disabled for light doc +SHOW_FILES = NO # Disabled for light doc +SHOW_NAMESPACES = YES +FILE_VERSION_FILTER = +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = YES +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = NO +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = @top_srcdir@/doc +FILE_PATTERNS = *.cc \ + *.hh \ + *.hxx \ + *.hcc +RECURSIVE = YES +EXCLUDE = @top_srcdir@/milena/ \ + @top_srcdir@/scribo/ +EXCLUDE_SYMLINKS = YES +EXCLUDE_PATTERNS = *spe.hh +EXCLUDE_SYMBOLS = *::internal* *_ mln::trait::* +EXAMPLE_PATH = +EXAMPLE_PATTERNS = *.cc \ + *.cc.raw \ + *.txt +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = +INPUT_FILTER = +FILTER_PATTERNS = +FILTER_SOURCE_FILES = NO +INPUT_ENCODING = ISO-8859-1 + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = NO +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION = YES +REFERENCES_LINK_SOURCE = NO +USE_HTAGS = NO +VERBATIM_HEADERS = YES +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = NO +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = mln:: +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = @top_srcdir@/doc/header.html +HTML_FOOTER = @top_srcdir@/doc/footer.html +HTML_STYLESHEET = @top_srcdir@/doc/doxygen.css +LAYOUT_FILE = @top_srcdir@/doc/DoxygenLayout.xml +HTML_ALIGN_MEMBERS = YES +GENERATE_HTMLHELP = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +BINARY_TOC = NO +TOC_EXPAND = NO +DISABLE_INDEX = NO +ENUM_VALUES_PER_LINE = 4 +GENERATE_TREEVIEW = NO +TREEVIEW_WIDTH = 250 +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = NO +LATEX_OUTPUT = latex +LATEX_CMD_NAME = latex +MAKEINDEX_CMD_NAME = makeindex +COMPACT_LATEX = NO +PAPER_TYPE = a4wide +EXTRA_PACKAGES = +LATEX_HEADER = +PDF_HYPERLINKS = YES +USE_PDFLATEX = YES +LATEX_BATCHMODE = YES +LATEX_HIDE_INDICES = NO +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_LINKS = NO +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML = NO +XML_OUTPUT = xml +XML_SCHEMA = +XML_DTD = +XML_PROGRAMLISTING = YES +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- +GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- +GENERATE_PERLMOD = NO +PERLMOD_LATEX = NO +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = YES +EXPAND_ONLY_PREDEF = YES +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = "for_all(x)=for(x.start(); x.is_valid(); x.next())" \ + "for_all_2(x1, x2)=for(x1.start(), x2.start(); x1.is_valid(); x1.next(), x2.next())" \ + "for_all_3(x1, x2, x3)=for(x1.start(), x2.start(), x3.start(); x1.is_valid(); x1.next(), x2.next(), x3.next())" \ + "for_all_remaining(x)=if (! x.is_valid()) {} else while (x.next(), x.is_valid())" \ + "mlc_unqualif(T)=typename mln::metal::unqualif<T>::ret" \ + "mlc_equal(T1,T2)=mln::metal::equal<T1,T2>" \ + "mln_piter(T)=typename T::piter" \ + "mln_fwd_piter(T)=typename T::fwd_piter" \ + "mln_bkd_piter(T)=typename T::bkd_piter" \ + "mln_qiter(T)=typename T::qiter" \ + "mln_fwd_qiter(T)=typename T::fwd_qiter" \ + "mln_bkd_qiter(T)=typename T::bkd_qiter" \ + "mln_niter(T)=typename T::niter" \ + "mln_fwd_niter(T)=typename T::fwd_niter" \ + "mln_bkd_niter(T)=typename T::bkd_niter" \ + "mln_viter(T)=typename T::viter" \ + "mln_fwd_viter(T)=typename T::fwd_viter" \ + "mln_bkd_viter(T)=typename T::bkd_viter" \ + "mln_result(T)=typename T::result" \ + "mln_enc(T)=typename T::enc" \ + "mln_value(T)=typename T::value" \ + "mln_qlf_value(T)=typename T::qlf_value" \ + "mln_domain(T)=typename T::domain_t" \ + "mln_sum(T)=typename mln::value::props<T>::sum" \ + "mln_vset(T)=typename T::vset" \ + "mln_rvalue(T)=typename T::rvalue" \ + "mln_lvalue(T)=typename T::lvalue" \ + "mln_mesh(T)=typename T::mesh" \ + "mln_coord(T)=typename T::coord" \ + "mln_site(T)=typename T::site" \ + "mln_psite(T)=typename T::psite" \ + "mln_dpsite(T)=typename T::dpsite" \ + "mln_accu_with(A, T)=typename A::template with< T >::ret" \ + "mln_trait_op_div(L, R)=typename mln::trait::op::div< L , R >::ret" \ + "mln_trait_op_less(L, R)=typename mln::trait::op::less< L , R >::ret" \ + "mln_trait_op_minus(L, R)=typename mln::trait::op::minus< L , R >::ret" \ + "mln_trait_op_mod(L, R)=typename mln::trait::op::mod< L , R >::ret" \ + "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" \ + "mln_bkd_piter_(T)=T::bkd_piter" \ + "mln_qiter_(T)=T::qiter" \ + "mln_fwd_qiter_(T)=T::fwd_qiter" \ + "mln_bkd_qiter_(T)=T::bkd_qiter" \ + "mln_niter_(T)=T::niter" \ + "mln_fwd_niter_(T)=T::fwd_niter" \ + "mln_bkd_niter_(T)=T::bkd_niter" \ + "mln_viter_(T)=T::viter" \ + "mln_fwd_viter_(T)=T::fwd_viter" \ + "mln_bkd_viter_(T)=T::bkd_viter" \ + "mln_result_(T)=T::result" \ + "mln_enc_(T)=T::enc" \ + "mln_value_(T)=T::value" \ + "mln_qlf_value_(T)=T::qlf_value" \ + "mln_domain_(T)=T::domain_t" \ + "mln_sum_(T)=mln::value::props<T>::sum" \ + "mln_vset_(T)=T::vset" \ + "mln_rvalue_(T)=T::rvalue" \ + "mln_lvalue_(T)=T::lvalue" \ + "mln_mesh_(T)=T::mesh" \ + "mln_coord_(T)=T::coord" \ + "mln_site_(T)=T::site" \ + "mln_psite_(T)=T::psite" \ + "mln_dpsite_(T)=T::dpsite" \ + "mln_accu_with_(A, T)=A::template with< T >::ret" \ + "mln_trait_op_plus_(L, R)=mln::trait::op::plus< L , R >::ret" \ + "mln_trait_op_minus_(L, R)=mln::trait::op::minus< L , R >::ret" \ + "mln_trait_op_times_(L, R)=mln::trait::op::times< L , R >::ret" \ + "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_morpher_lvalue(I)=typename internal::morpher_lvalue_::ret" \ + "mln_concrete(I)=typename mln::trait::concrete::ret" \ + "mln_concrete_ch_value(I, V)=typename mln::trait::ch_value< typename mln::trait::concrete::ret, V >::ret" \ + "mlc_const(T)=typename mln::metal::const_< T >::ret" \ + "mlc_const_return(T)=typename mln::metal::const_return_< T >::ret" \ + "mln_element(T)=typename T::element" \ + "mln_element_(T)=T::element" \ + "mln_delta(T)=typename T::delta" \ + "mln_delta_(T)=T::delta" \ + "mln_dpoint(T)=typename T::dpoint" \ + "mln_dpoint_(T)=T::dpoint" \ + "mln_point(T)=typename T::point" \ + "mln_point_(T)=T::point" \ + "mln_gradient_component(I)=typename mln::trait::ch_value< I, mln::value::props< typename I::value >::sum >::ret" \ + "mln_gradient(I)=mln::value::stack_image< I::point::dim, mln::trait::ch_value< I, mln::value::props< typename I::value >::sum >::ret >" \ + "mln_trait_value_sum_product(T, U)=typename mln::trait::value_< mln_trait_op_times(T,U) >::sum" \ + "mln_sum_product(T, U)=typename mln::trait::value_< mln_trait_op_times(T,U) >::sum" \ + "mln_deduce(T, A1, A2)=typename T::A1::A2" \ + "mln_graph_element(T)=typename T::graph_element" \ + "mln_graph_element_(T)=T::graph_element" \ + "mln_fun_vv2v(F, L, R)=mln::fun::vv2v::F< mln_value(L), mln_value(R) >" \ + "mln_fun_vv2v_result(F, L, R)=typename mln_fun_vv2v(F, L, R)::result" \ + "mln_ch_fun_vv2v(F, L, R)=typename mln::trait::ch_value< L, typename mln_fun_vv2v(F, L, R)::result >::ret" + + + + +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- +TAGFILES = @builddir@/../scribo/doc/scribo.tag=../../scribo/doc/user-refman/html \ + @builddir@/../milena/doc/milena.tag=../../milena/doc/user-refman/html +GENERATE_TAGFILE = +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +PERL_PATH = /usr/bin/perl +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +CLASS_DIAGRAMS = NO +HIDE_UNDOC_RELATIONS = YES +HAVE_DOT = YES +CLASS_GRAPH = NO +COLLABORATION_GRAPH = NO # Disabled for light doc +GROUP_GRAPHS = NO # Disabled for light doc +UML_LOOK = NO +TEMPLATE_RELATIONS = NO +INCLUDE_GRAPH = NO # Disabled for light doc +INCLUDED_BY_GRAPH = NO # Disabled for light doc +CALL_GRAPH = NO +CALLER_GRAPH = NO +GRAPHICAL_HIERARCHY = NO +DIRECTORY_GRAPH = NO # Disabled for light doc +DOT_IMAGE_FORMAT = png +DOT_PATH = +DOTFILE_DIRS = +MAX_DOT_GRAPH_DEPTH = 1000 +DOT_TRANSPARENT = NO +DOT_MULTI_TARGETS = NO +GENERATE_LEGEND = NO # Disabled for light doc +DOT_CLEANUP = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- +SEARCHENGINE = NO + + +# Local Variables: +# mode: Makefile +# End: diff --git a/doc/DoxygenLayout.xml b/doc/DoxygenLayout.xml new file mode 100644 index 0000000..a279910 --- /dev/null +++ b/doc/DoxygenLayout.xml @@ -0,0 +1,184 @@ +<doxygenlayout version="1.0"> +  + <navindex> + <tab type="mainpage" visible="yes" title="Home"/> + <tab type="pages" visible="no" title=""/> + <tab type="modules" visible="no" title=""/> + <tab type="namespaces" visible="no" title=""> + <tab type="namespaces" visible="no" title=""/> + <tab type="namespacemembers" visible="no" title=""/> + </tab> + <tab type="classes" visible="no" title=""> + <tab type="classes" visible="no" title=""/> + <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> + <tab type="hierarchy" visible="no" title=""/> + <tab type="classmembers" visible="no" title=""/> + </tab> + <tab type="files" visible="no" title=""> + <tab type="files" visible="no" title=""/> + <tab type="globals" visible="no" title=""/> + </tab> + <tab type="dirs" visible="no" title=""/> + <tab type="examples" visible="no" title=""/> + </navindex> + +  + <class> + <briefdescription visible="yes"/> + <includes visible="$SHOW_INCLUDE_FILES"/> + <inheritancegraph visible="$CLASS_GRAPH"/> + <collaborationgraph visible="$COLLABORATION_GRAPH"/> + <allmemberslink visible="yes"/> + <memberdecl> + <nestedclasses visible="yes" title=""/> + <publictypes title=""/> + <publicslots title=""/> + <signals title=""/> + <publicmethods title=""/> + <publicstaticmethods title=""/> + <publicattributes title=""/> + <publicstaticattributes title=""/> + <protectedtypes title=""/> + <protectedslots title=""/> + <protectedmethods title=""/> + <protectedstaticmethods title=""/> + <protectedattributes title=""/> + <protectedstaticattributes title=""/> + <packagetypes title=""/> + <packagemethods title=""/> + <packagestaticmethods title=""/> + <packageattributes title=""/> + <packagestaticattributes title=""/> + <properties title=""/> + <events title=""/> + <privatetypes title=""/> + <privateslots title=""/> + <privatemethods title=""/> + <privatestaticmethods title=""/> + <privateattributes title=""/> + <privatestaticattributes title=""/> + <friends title=""/> + <related title="" subtitle=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <typedefs title=""/> + <enums title=""/> + <constructors title=""/> + <functions title=""/> + <related title=""/> + <variables title=""/> + <properties title=""/> + <events title=""/> + </memberdef> + <usedfiles visible="$SHOW_USED_FILES"/> + <authorsection visible="yes"/> + </class> + +  + <namespace> + <briefdescription visible="yes"/> + <memberdecl> + <nestednamespaces visible="yes" title=""/> + <classes visible="yes" title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + </memberdef> + <authorsection visible="yes"/> + </namespace> + +  + <file> + <briefdescription visible="yes"/> + <includes visible="$SHOW_INCLUDE_FILES"/> + <includegraph visible="$INCLUDE_GRAPH"/> + <includedbygraph visible="$INCLUDED_BY_GRAPH"/> + <sourcelink visible="yes"/> + <memberdecl> + <classes visible="yes" title=""/> + <namespaces visible="yes" title=""/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + </memberdef> + <authorsection/> + </file> + +  + <group> + <briefdescription visible="yes"/> + <groupgraph visible="$GROUP_GRAPHS"/> + <memberdecl> + <classes visible="yes" title=""/> + <namespaces visible="yes" title=""/> + <dirs visible="yes" title=""/> + <nestedgroups visible="yes" title=""/> + <files visible="yes" title=""/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <enumvalues title=""/> + <functions title=""/> + <variables title=""/> + <signals title=""/> + <publicslots title=""/> + <protectedslots title=""/> + <privateslots title=""/> + <events title=""/> + <properties title=""/> + <friends title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <pagedocs/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <enumvalues title=""/> + <functions title=""/> + <variables title=""/> + <signals title=""/> + <publicslots title=""/> + <protectedslots title=""/> + <privateslots title=""/> + <events title=""/> + <properties title=""/> + <friends title=""/> + </memberdef> + <authorsection visible="yes"/> + </group> + +  + <directory> + <briefdescription visible="yes"/> + <directorygraph visible="yes"/> + <memberdecl> + <dirs visible="yes"/> + <files visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + </directory> +</doxygenlayout> diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..ac2fd2e --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,155 @@ +# Copyright (C) 2007, 2008, 2009, 2010 EPITA Research and Development +# Laboratory (LRDE). +# +# This file is part of Olena. +# +# Olena is free software: you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation, version 2 of the License. +# +# Olena is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Olena. If not, see <http://www.gnu.org/licenses/>. + + +# Look for Milena headers in srcdir and for (generated) test headers +# (like data.hh) in builddir. +AM_CPPFLAGS = -I$(top_srcdir)/milena -I$(top_builddir)/milena + +DOXYGEN = doxygen + +DOXYFILE = Doxyfile + + +## --------------------- ## +## LaTeX configuration. ## +## --------------------- ## + +include $(top_srcdir)/build-aux/tex.mk + +TEXI2DVI_FLAGS += \ + -I $(srcdir) -I $(srcdir)/outputs -I $(srcdir)/outputs/split \ + -I $(srcdir)/img -I $(srcdir)/examples/split + +# Additional files for LaTeX compilations. +DOC_PACKAGES = doxyfuns.sty milena.sty + + +# ----------------------- # +# User Reference Manual. # +# ----------------------- # + +all-local: $(srcdir)/$(USER_REFMAN) + +# Run "make regen-doc" to forcefully rebuild the Doxygen documentation. +.PHONY: regen-doc +regen-doc: + rm -f $(srcdir)/user-refman.stamp + $(MAKE) $(AM_MAKEFLAGS) $(srcdir)/user-refman.stamp + +DOXYFILE_USER = Doxyfile_user + +REFMAN_deps = $(srcdir)/footer.html \ + $(srcdir)/header.html \ + $(srcdir)/doxygen.css \ + $(srcdir)/mainpage.hh \ + $(srcdir)/DoxygenLayout.xml + +# Sed is used to generate Doxyfile from Doxyfile.in instead of +# configure, because the former is way faster than the latter. +# +## FIXME: This is because, as in TC, we depend on $Id$ from the +## ChangeLog. Maybe we should depend from something less prone to +## change. See Bison's build system. +edit = sed -e "s|@ID@|$$Id|" \ + -e 's,@PACKAGE_NAME\@,$(PACKAGE_NAME),g' \ + -e 's,@PACKAGE_VERSION\@,$(PACKAGE_VERSION),g' \ + -e 's,@top_srcdir\@,$(top_srcdir),g' \ + -e 's,@top_builddir\@,$(top_builddir),g' \ + -e 's,@srcdir\@,$(srcdir),g' \ + -e 's,@builddir\@,$(builddir),g' + +$(DOXYFILE_USER): $(srcdir)/$(DOXYFILE).in + Id=`grep '^\$$Id' $(top_srcdir)/milena/ChangeLog \ + | sed -e 's/\\\$$//g'`; \ + $(edit) $< >$@ +MAINTAINERCLEANFILES = $(DOXYFILE_USER) + +USER_REFMAN = user-refman + + +# HTML. +EXTRA_DIST = $(srcdir)/user-refman.stamp +MAINTAINERCLEANFILES += $(srcdir)/user-refman.stamp +$(srcdir)/user-refman.stamp: $(srcdir)/$(DOXYFILE).in $(REFMAN_deps) + @rm -f $@.tmp + @touch $@.tmp + rm -rf $(USER_REFMAN).tmp + $(MAKE) $(AM_MAKE_FLAGS) $(DOXYFILE_USER) + $(DOXYGEN) $(DOXYFILE_USER) + rm -rf $(srcdir)/$(USER_REFMAN) +## FIXME: Moving directories between file systems is not portable. + mv $(USER_REFMAN).tmp $(srcdir)/$(USER_REFMAN) + @mv -f $@.tmp $@ + +$(srcdir)/$(USER_REFMAN): $(srcdir)/user-refman.stamp +## Recover from the removal of $@. + @if test -d $@; then :; else \ + rm -f $<; \ + $(MAKE) $(AM_MAKEFLAGS) $<; \ + fi + +# Installing a directory located in the source dir is not supported by +# Automake by default, so we cannot simply add `$(USER_REFMAN)/html' +# to `dist_doc_DATA'. The rule `install-data-local' (see below) used +# to work around this limitation is borrowed from the Vaucanson +# project. +EXTRA_DIST += $(USER_REFMAN) + + + + + +## ---------- ## +## Cleaning. ## +## ---------- ## + +MAINTAINERCLEANFILES += $(dist_pdf_DATA) + +maintainer-clean-local: + -rm -rf $(USER_REFMAN).tmp $(srcdir)/$(USER_REFMAN) + -rm -rf $(DEVEL_REFMAN).tmp $(srcdir)/$(DEVEL_REFMAN) + -for d in $(DATA_html_dirs); do \ + rm -rf $$d.tmp $(srcdir)/$$d; \ + done + + +## -------------- ## +## Installation. ## +## -------------- ## + + +# We install by hand, otherwise Automake produces "install .../srcdoc +# .../srcdoc", which installs our dir into the previous one, instead +# of replacing it. +install-data-local: + $(mkdir_p) $(DESTDIR)$(htmldir) +# The user reference manual is located in a subdirectory, hence this +# special case. + rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN) + cp -r $(srcdir)/$(USER_REFMAN)/html $(DESTDIR)$(htmldir)/$(USER_REFMAN) +## Try GNU chmod's X mode before resorting to something slower but +## more standard. + chmod -R a+rX $(DESTDIR)$(htmldir) || \ + find $(DESTDIR)$(htmldir) $ -type d -a -exec chmod a+rx {} \; $ \ + -o -exec chmod a+r {} \; + +uninstall-local: +# Same remark as above regarding the special case of the user +# reference manual. + chmod -R 700 $(DESTDIR)$(htmldir)/$(USER_REFMAN) + rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN) diff --git a/doc/doxygen.css b/doc/doxygen.css new file mode 100644 index 0000000..104c7dd --- /dev/null +++ b/doc/doxygen.css @@ -0,0 +1,856 @@ +/* The standard CSS for doxygen */ + +body, table, div, p, dl { + font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; + font-size: 12px; +} + +/* @group Heading Levels */ + +h1 { + font-size: 150%; +} + +.title { + font-size: 150%; + font-weight: bold; + margin: 10px 2px; +} + +h2 { + font-size: 120%; +} + +h3 { + font-size: 100%; +} + +dt { + font-weight: bold; +} + +div.multicol { + -moz-column-gap: 1em; + -webkit-column-gap: 1em; + -moz-column-count: 3; + -webkit-column-count: 3; +} + +p.startli, p.startdd, p.starttd { + margin-top: 2px; +} + +p.endli { + margin-bottom: 0px; +} + +p.enddd { + margin-bottom: 4px; +} + +p.endtd { + margin-bottom: 2px; +} + +/* @end */ + +caption { + font-weight: bold; +} + +span.legend { + font-size: 70%; + text-align: center; +} + +h3.version { + font-size: 90%; + text-align: center; +} + +div.qindex, div.navtab{ + background-color: #EBEFF6; + border: 1px solid #A3B4D7; + text-align: center; + margin: 2px; + padding: 2px; +} + +div.qindex, div.navpath { + width: 100%; + line-height: 140%; +} + +div.navtab { + margin-right: 15px; +} + +/* @group Link Styling */ + +a { + color: #3D578C; + font-weight: normal; + text-decoration: none; +} + +.contents a:visited { + color: #4665A2; +} + +a:hover { + text-decoration: underline; +} + +a.qindex { + font-weight: bold; +} + +a.qindexHL { + font-weight: bold; + background-color: #9CAFD4; + color: #ffffff; + border: 1px double #869DCA; +} + +.contents a.qindexHL:visited { + color: #ffffff; +} + +a.el { + font-weight: bold; +} + +a.elRef { +} + +a.code { + color: #4665A2; +} + +a.codeRef { + color: #4665A2; +} + +/* @end */ + +dl.el { + margin-left: -1cm; +} + +.fragment { + font-family: monospace, fixed; + font-size: 105%; +} + +pre.fragment { + border: 1px solid #C4CFE5; + background-color: #FBFCFD; + padding: 4px 6px; + margin: 4px 8px 4px 2px; + overflow: auto; + word-wrap: break-word; + font-size: 9pt; + line-height: 125%; +} + +div.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px; + padding: 0.2em; + border: solid thin #333; + border-radius: 0.5em; + -webkit-border-radius: .5em; + -moz-border-radius: .5em; + box-shadow: 2px 2px 3px #999; + -webkit-box-shadow: 2px 2px 3px #999; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444)); + background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000); +} + +div.groupHeader { + margin-left: 16px; + margin-top: 12px; + font-weight: bold; +} + +div.groupText { + margin-left: 16px; + font-style: italic; +} + +body { + background: white; + color: black; + margin: 0; +} + +div.contents { + margin-top: 10px; + margin-left: 10px; + margin-right: 5px; +} + +td.indexkey { + background-color: #EBEFF6; + font-weight: bold; + border: 1px solid #C4CFE5; + margin: 2px 0px 2px 0; + padding: 2px 10px; +} + +td.indexvalue { + background-color: #EBEFF6; + border: 1px solid #C4CFE5; + padding: 2px 10px; + margin: 2px 0px; +} + +tr.memlist { + background-color: #EEF1F7; +} + +p.formulaDsp { + text-align: center; +} + +img.formulaDsp { + +} + +img.formulaInl { + vertical-align: middle; +} + +div.center { + text-align: center; + margin-top: 0px; + margin-bottom: 0px; + padding: 0px; +} + +div.center img { + border: 0px; +} + +address.footer { + text-align: right; + padding-right: 12px; +} + +img.footer { + border: 0px; + vertical-align: middle; +} + +/* @group Code Colorization */ + +span.keyword { + color: #008000 +} + +span.keywordtype { + color: #604020 +} + +span.keywordflow { + color: #e08000 +} + +span.comment { + color: #800000 +} + +span.preprocessor { + color: #806020 +} + +span.stringliteral { + color: #002080 +} + +span.charliteral { + color: #008080 +} + +span.vhdldigit { + color: #ff00ff +} + +span.vhdlchar { + color: #000000 +} + +span.vhdlkeyword { + color: #700070 +} + +span.vhdllogic { + color: #ff0000 +} + +/* @end */ + +/* +.search { + color: #003399; + font-weight: bold; +} + +form.search { + margin-bottom: 0px; + margin-top: 0px; +} + +input.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} +*/ + +td.tiny { + font-size: 75%; +} + +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #A3B4D7; +} + +th.dirtab { + background: #EBEFF6; + font-weight: bold; +} + +hr { + height: 0px; + border: none; + border-top: 1px solid #4A6AAA; +} + +hr.footer { + height: 1px; +} + +/* @group Member Descriptions */ + +table.memberdecls { + border-spacing: 0px; + padding: 0px; +} + +.mdescLeft, .mdescRight, +.memItemLeft, .memItemRight, +.memTemplItemLeft, .memTemplItemRight, .memTemplParams { + background-color: #F9FAFC; + border: none; + margin: 4px; + padding: 1px 0 0 8px; +} + +.mdescLeft, .mdescRight { + padding: 0px 8px 4px 8px; + color: #555; +} + +.memItemLeft, .memItemRight, .memTemplParams { + border-top: 1px solid #C4CFE5; +} + +.memItemLeft, .memTemplItemLeft { + white-space: nowrap; +} + +.memItemRight { + width: 100%; +} + +.memTemplParams { + color: #4665A2; + white-space: nowrap; +} + +/* @end */ + +/* @group Member Details */ + +/* Styles for detailed member documentation */ + +.memtemplate { + font-size: 80%; + color: #4665A2; + font-weight: normal; + margin-left: 9px; +} + +.memnav { + background-color: #EBEFF6; + border: 1px solid #A3B4D7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} + +.mempage { + width: 100%; +} + +.memitem { + padding: 0; + margin-bottom: 10px; + margin-right: 5px; +} + +.memname { + white-space: nowrap; + font-weight: bold; + margin-left: 6px; +} + +.memproto { + border-top: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + padding: 6px 0px 6px 0px; + color: #253555; + font-weight: bold; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + /* opera specific markup */ + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + border-top-right-radius: 8px; + border-top-left-radius: 8px; + /* firefox specific markup */ + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + -moz-border-radius-topright: 8px; + -moz-border-radius-topleft: 8px; + /* webkit specific markup */ + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + -webkit-border-top-right-radius: 8px; + -webkit-border-top-left-radius: 8px; + background-image:url('nav_f.png'); + background-repeat:repeat-x; + background-color: #E2E8F2; + +} + +.memdoc { + border-bottom: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + padding: 2px 5px; + background-color: #FBFCFD; + border-top-width: 0; + /* opera specific markup */ + border-bottom-left-radius: 8px; + border-bottom-right-radius: 8px; + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + /* firefox specific markup */ + -moz-border-radius-bottomleft: 8px; + -moz-border-radius-bottomright: 8px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + background-image: -moz-linear-gradient(center top, #FFFFFF 0%, #FFFFFF 60%, #F7F8FB 95%, #EEF1F7); + /* webkit specific markup */ + -webkit-border-bottom-left-radius: 8px; + -webkit-border-bottom-right-radius: 8px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + background-image: -webkit-gradient(linear,center top,center bottom,from(#FFFFFF), color-stop(0.6,#FFFFFF), color-stop(0.60,#FFFFFF), color-stop(0.95,#F7F8FB), to(#EEF1F7)); +} + +.paramkey { + text-align: right; +} + +.paramtype { + white-space: nowrap; +} + +.paramname { + color: #602020; + white-space: nowrap; +} +.paramname em { + font-style: normal; +} + +.params, .retval, .exception, .tparams { + border-spacing: 6px 2px; +} + +.params .paramname, .retval .paramname { + font-weight: bold; + vertical-align: top; +} + +.params .paramtype { + font-style: italic; + vertical-align: top; +} + +.params .paramdir { + font-family: "courier new",courier,monospace; + vertical-align: top; +} + + + + +/* @end */ + +/* @group Directory (tree) */ + +/* for the tree view */ + +.ftvtree { + font-family: sans-serif; + margin: 0px; +} + +/* these are for tree view when used as main index */ + +.directory { + font-size: 9pt; + font-weight: bold; + margin: 5px; +} + +.directory h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +/* +The following two styles can be used to replace the root node title +with an image of your choice. Simply uncomment the next two styles, +specify the name of your image and be sure to set 'height' to the +proper pixel height of your image. +*/ + +/* +.directory h3.swap { + height: 61px; + background-repeat: no-repeat; + background-image: url("yourimage.gif"); +} +.directory h3.swap span { + display: none; +} +*/ + +.directory > h3 { + margin-top: 0; +} + +.directory p { + margin: 0px; + white-space: nowrap; +} + +.directory div { + display: none; + margin: 0px; +} + +.directory img { + vertical-align: -30%; +} + +/* these are for tree view when not used as main index */ + +.directory-alt { + font-size: 100%; + font-weight: bold; +} + +.directory-alt h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +.directory-alt > h3 { + margin-top: 0; +} + +.directory-alt p { + margin: 0px; + white-space: nowrap; +} + +.directory-alt div { + display: none; + margin: 0px; +} + +.directory-alt img { + vertical-align: -30%; +} + +/* @end */ + +div.dynheader { + margin-top: 8px; +} + +address { + font-style: normal; + color: #2A3D61; +} + +table.doxtable { + border-collapse:collapse; + /* new */ + width:80%; + table-layout:fixed; +} + +table.doxtable td, table.doxtable th { + border: 1px solid #2D4068; + padding: 3px 7px 2px; +} + +table.doxtable th { + background-color: #374F7F; + color: #FFFFFF; + font-size: 110%; + padding-bottom: 4px; + padding-top: 5px; + + /* Changed */ + text-align:center; +} + +.tabsearch { + top: 0px; + left: 10px; + height: 36px; + background-image: url('tab_b.png'); + z-index: 101; + overflow: hidden; + font-size: 13px; +} + +.navpath ul +{ + font-size: 11px; + background-image:url('tab_b.png'); + background-repeat:repeat-x; + height:30px; + line-height:30px; + color:#8AA0CC; + border:solid 1px #C2CDE4; + overflow:hidden; + margin:0px; + padding:0px; +} + +.navpath li +{ + list-style-type:none; + float:left; + padding-left:10px; + padding-right:15px; + background-image:url('bc_s.png'); + background-repeat:no-repeat; + background-position:right; + color:#364D7C; +} + +.navpath li.navelem a +{ + height:32px; + display:block; + text-decoration: none; + outline: none; +} + +.navpath li.navelem a:hover +{ + color:#6884BD; +} + +.navpath li.footer +{ + list-style-type:none; + float:right; + padding-left:10px; + padding-right:15px; + background-image:none; + background-repeat:no-repeat; + background-position:right; + color:#364D7C; + font-size: 8pt; +} + + +div.summary +{ + float: right; + font-size: 8pt; + padding-right: 5px; + width: 50%; + text-align: right; +} + +div.summary a +{ + white-space: nowrap; +} + +div.ingroups +{ + font-size: 8pt; + padding-left: 5px; + width: 50%; + text-align: left; +} + +div.ingroups a +{ + white-space: nowrap; +} + +div.header +{ + background-image:url('nav_h.png'); + background-repeat:repeat-x; + background-color: #F9FAFC; + margin: 0px; + border-bottom: 1px solid #C4CFE5; +} + +div.headertitle +{ + padding: 5px 5px 5px 10px; +} + +dl +{ + padding: 0 0 0 10px; +} + +dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug +{ + border-left:4px solid; + padding: 0 0 0 6px; +} + +dl.note +{ + border-color: #D0C000; +} + +dl.warning, dl.attention +{ + border-color: #FF0000; +} + +dl.pre, dl.post, dl.invariant +{ + border-color: #00D000; +} + +dl.deprecated +{ + border-color: #505050; +} + +dl.todo +{ + border-color: #00C0E0; +} + +dl.test +{ + border-color: #3030E0; +} + +dl.bug +{ + border-color: #C08050; +} + +#projectlogo +{ + text-align: center; + vertical-align: bottom; + border-collapse: separate; +} + +#projectlogo img +{ + border: 0px none; +} + +#projectname +{ + /* Changed */ + font: 32px Tahoma, Arial,sans-serif; + + margin: 0px; + padding: 2px 0px; +} + +#projectbrief +{ + /* Changed */ + font: 13px Tahoma, Arial,sans-serif; + + margin: 0px; + padding: 0px; +} + +#projectnumber +{ + font: 50% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 0px; +} + +#titlearea +{ + padding: 0px; + margin: 0px; + width: 100%; + border-bottom: 1px solid #5373B4; +} + +.image +{ + text-align: center; +} + +.dotgraph +{ + text-align: center; +} + +.mscgraph +{ + text-align: center; +} + +.caption +{ + font-weight: bold; +} + + +/* ===> NEW */ + +table.itable th +{ + font-size: 17px; +} + +table.itable li +{ + font-size: 16px; +} \ No newline at end of file diff --git a/doc/footer.html b/doc/footer.html new file mode 100644 index 0000000..d0e98ec --- /dev/null +++ b/doc/footer.html @@ -0,0 +1,5 @@ +<hr class="footer"/><address class="footer"> +Copyright (C) 2011 EPITA Research and Development Laboratory (LRDE)Olena 2.0 +</address> +</body> +</html> diff --git a/doc/header.html b/doc/header.html new file mode 100644 index 0000000..a94502d --- /dev/null +++ b/doc/header.html @@ -0,0 +1,46 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<title>$title</title> +<link href="$relpath$tabs.css" rel="stylesheet" type="text/css"/> +<link href="$relpath$doxygen.css" rel="stylesheet" type="text/css" /> +$treeview +$search +$mathjax +</head> +<body> +<div id="top"> + +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> +  + <td id="projectlogo"><a href="$relpath$index.html"><img alt="Logo" src="$relpath$$projectlogo"></a></td> +  +  + <td style="padding-left: 0.5em;"> + <div id="projectname">Olena +  + </div> + <div id="projectbrief">$projectbrief</div> + </td> +  +  +  + <td style="padding-left: 0.5em;"> + <div id="projectbrief">$projectbrief</div> + </td> +  +  +  +  + <td>$searchbox</td> +  +  + </tr> + </tbody> +</table> +</div> + diff --git a/doc/logo.jpg b/doc/logo.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a68a505583cdf475c11054066db4ded69dafd17a GIT binary patch literal 7477 zcmbW42Q-}9x4^%dF?t)l8@<;cqxVj9qL(okz4wxcNQ^Eadaoe_K_q%7f(U{jBm{{> zi5e1b-1~p`-uKpeW&QW8b<S`0*?XV;?Q_0wopU*VxeAc$XlQEyAgl<21Oec34JcO+ zMY{lizCOSY002G!1yKMHEP=2;0K@=5|6l;n0Wto?#vtB**?<Ay9vZ;;myH#+zd~%} zKfM3!p=khsht=SSii?RB|0j!yiWY<Zo~ao8SCs3;kiQx02V8z6zNxLMYHw(4prNg& zj!ho`h_&?4-acS*0Pyk-^f%U2f#0;Wg5ym9V1NL?1;hZr5gFjCZ=zv(6+v5F6&`>! zy5fHcHpcPXRh9toR!GYb4*!?_|J%WkzW#yO$27z`TysVRAh8^WWzUd6-z)tdmZ_XP zt{8k(A1Z%rf>@@zV%I<Usy<Xsf3ngQJ9~LMV{NW-_I37hzTyEa-wzH#VHu)_<@jJU zDg?_jSmyK$@<L<z6w6dzD8~S7k%_PLfheTgRl%`L>~CtUie)+M;u5?5gPs1tfv8Yy zo&ccg;~VCWc6AGc^CJ1+V$#wGxE3nJ6BQUJWax<WaP)VEtNM8PI(mlzz@N{2<poe& z)fSE|vXq##l$4OTFt+@E$^Sa|m(~9cS8MyH#Sf!D)(k{5{<rRL-@kP}r2v39!qz73 zZ=F*P0JPl&0J_D$b)3ZjKo$o8t&{(F9-6ED;uaX_D<dKj5)vYeMj?f-3i_A)p9X(f z{?G7_`Gl|L`>S?vHI$2EkY^zLs;EdGPoE%vcz~}X5(O9f@0<AFcKk<L|Hwno80CWU zM|oqXGRN*Rw6`mExxJmyfoLCZINJMvTH$}w?H@T@;h*~&3zX%*0V;c8fP9h)fP5PV za43lYh)p4O1oYRs=@FO%S8tvL>*k;P9?RJAKidD&fK#!5!2xJj_?24K*c6To@(;dZ z>^pJQKmkI444?w&0TzG*;01&Lao{>23n&5VfDT{)m;#o79e@Pf058BF2mvC2+dw>! z2&4g-KrT=Olmj(DJ<tTS0UbauFa*2;rhr-CJ+KOF0AGPU;21c^er@qUBp^x<J%|;= z1rh*>gAgDEkUB^YWDK$dIe=V2-k=~*B<Kz(5tISS1(kqmK#ibwP%mf{^aiv5S_5r^ z4nRM_5HK;A3d{`V28)0ZU}dl_*c5CFb_M%^!@+Uj6mT}U6kG>x1^0qqfoH+1;IH5# z2mm31&_LKALJ$N*6=DFfg1A8ZA<+;FBnwgssfWCP3`5>RRv|l(GaOtTN*p+j5RNR4 z7LFMX62}iG8Yc-S7pEGh6=wkFEzTOw9?owl36u#c0F{AiLvKP|p&`(CXcn{*+5#Pf z&O$e!$GEt-G`Kvt*KxIQEpgp(BXE;&3ve57dvM?2e!@M%!^5M;6Tp+lGr)7i3&e}Z z%fYL|>&BbL+rT@;C&FjN7suDYx5D?vkHycze~jOSKaIbMe@;M7z(pWKU_jtZ5Jr$n zP)_iIV3J^i;G7Uf$U`VkXiDf#c$+Yru%2*`aEb5-5fKqPku;GJ5t`^0Q8v+2q7kAs zqBCL&Vt!&(VjJQh;uPX4;vV7!;vXa=B-|uQBvvGWBq<~{B>f~SB&Vd5q{5`yq|T%< zq<N&Rq|>C|$q2}}$dt+K$im68$ePI}$#%#I$hpZ?$sNg~$@9qD$={J5!6;#3Fawwu zED81)HVWIKz@y-%P^WOFh@&W@=%@HZ38CbmRHZ~x-k~g~9HiW!!lmM&(x!5!N~C&1 zH9@sUO+hU|ZB89Zok!hCy-EY2;il21@uW$mX`-2<`AN%6t4xccO`xr(ou)mZW294} zL(yUA8t7)}e$vC~)#*Lx)9Ksjml<#v_!*2CLKq4e1{ro3sTgG$k&GC|CdNf3FcUwM zF;fIn8Phn^5i<+3CbKVd4s$>A4hs#75{o;_LzXU<ZB|NF1y(fcL)LEAFK}wOGTalM z4IhB-u`#h}u?4Y}uuZU?v-7Z<vB$DEurG5Eav(TdI39BJaqMxja_VzNa@KM#auIML zxZJoNaSd~waPx3maNpx@<KE(-<I&~`=c(mc;w9l#<n`k%<(=Wf<wNj!@D=b)@q_s# z`Q7;Q_$LLx0#X8KfdYXyf>1$eL2toQ!FNK$LdrtHLbXC`!ZgBq!m+|_!rw(WMXW^9 zMTSLwi%N=mik6GM7o!l<5sMXjA$B0nFOC$?6Q8+8a!un}%(ds&_9X-)P!fd_^OBU3 z`jYn~`y_u!U6=Bgs+Zcn&UxM8dj9oy2r7gjA_*}f4V6}rj*;$=K9iA>36yD)*_9QN z^^komyCugXhmtFo`y|gU?<ij)zp4ONa8M{#SXE?GbW|)={HVmC<g8Sww5iOe?5<p= z{9Q#<#b2dG<wR9RHA=Nd4Wg#0hEbbPr%*Rj&sAU1VApWfsMXlhl+=vS?9qa1>1w5G zz0+paMrzk+@9A9EiP9O+CDt|3&DH&=$FJwF_d*}6ucQA!f9VF-4euLm27rOK!2^S3 zLmopv!<R<5MutXtMxTwvj3bSQO(;$5O&*&Zo2r<mn!Y#VH48H9Gbb~*F|RQ{u~4(f zuvon*ax?1YD@z7TwB>UvJS%gnN~<Glb?Z#)4I4?Dc$+y}9@|jcQ9A}ZPrFWgGJ8k+ zW(TN)g~MZq3r7RTQpY1FZKr&vJ)|n~5%R0ElJi67ZInDJ1GVWQ?~>uN<tp#`z;)YA z(Jjku2d#?EMen<7xfi*gco=w8d0cv0cs6+9dpUTudsBFOcn|on_=Nhr@fGlm_g(dq z@yqnv^VjvS3;+e#20Ra>!XBo^gLs4P2CW4v1m^{xhM0#mhr&X=L&wAT!xF+a!!^Py zB5)#*5q*(tk+&n)qLiabqCwG4(S0!-F>x^)w={26-zL26ar<?wXlzF8;T?-RFXEWv zZpD4Nt9iFJo;2P+{@p#<dqwwg?xXKdBwS0#N%)O%#*8J3CT1mGBq5W=lEsp<lP^<T zQYKQRQVY{?)4bE>(iPLIGhi9v8J`~LKWKdje~5W_m}#FmnkA7{^oa0L(4*CCz3k^X zoH=PZ7rAb^vw13c4f#y@3Hc`l&IQwjN`>`B%teVsKa0`D^Cg-kt)<+hS!K9o!DXMz z&C7=?5EV6*43&wMzpA{eR;!Jx2Wqa@)I4T-oLUR64XWL)v#FbUqW0u@y-<Bg15HEX zQ{ZXP(=Uw<jdM-9O?}OX=K5z`&+=O+TQIGl*09#SHn+Cb=a$dkwCl9@y^wv;@>2L^ zRR>!~UMF>DY8PQwT-RlHc=u6{Z_iGzYwxE%`@Z-6H~VJ>j0PqKbq7a=G=}<zm4~}W z<VQM2Wk%b_5Mynxq+Yd-OOCg^mVDhZAvMuDd42Nvl=Re#H*#;frWL1q->SVGn$ezl zHG5<B&79fX{5zX>tMktDTMM2G`-{Pg=kISVL6<Pg<jYwrOe>`y_&zkOO09OTsjZEF zH2L`c6Y|s7^?>z@jkwPwpR+buH*2=Uw>q{pwx_;Wf7$rz`}KS${u}ID{&(K*&vun| z$M<gTZS4E+Umhg=p#M>IC~??#WO%f4>~(y8f;pu>tv*AX4ga+Gxp^LPfp?Mpi|^Nq z-@3n-F1;=<FW&>If82(yZbbjCTm|`eegE>i>;Yi-*n`J)2#6g3!$1%i=yCvH#GYxO zSJ$1t1s4yWfDnp<9pop!8U#Q%V60qS*#I067y`u_05A$l0xD`Y8ZmZGLJsk(Kp+5X z^Upv~JTNW@f`1i=2Zp_eVPk-BAlQ7a0%7CeKw%WPlmHbQI|rVavN$!@<sv|gjR1y0 zV1Od<&ig?bYO;Cpz-I7ih5LSvl5mJ`%0@(u>U6UE!=uTZ#BbD@4+M1im5mtT4pQ`0 z8Xar7EqB)z%xeqdku)KQZ+vT-WJ8*DPcW1f$!Zz`OPWh(jv5z6QDrHb{F3RNH-Ch_ zo2;sw4T;!V^2^GL{K@JU;i5X$*wTFG?DVtX$MQ?yy+ryLvJkWDbB9xFeom~;r`$EJ zFMlGY<0=00vDVLKfw;<$m2{0>&(SGWKR4OTXrrnn@_u@8{$HZSugy|-BQi<PBwx*c z^|#XyE_1Gda>e%3-G~#Bmo3s;c%LHwP;t6}IeY{;Ja`c?-q`3SC4PH9z$Ul4s7*lL zGwC}bKtiu0T^bywRSbQV<x=2h{vl4llc4mO!<0xzvz#VJi9w*j8K?W1Vv9eARkDA3 z)Z+d6-<?6~jpb7sCN`%0`>=1Eu8~$Zr#Yyd&`9k)xP{i~@=^JI^Nvs3Ak+QCudgS= zZIkmk<~=?Ladh4IEu3{Te=_*`ia4qKI`3r0Ak!!Z68|{9y)K+nB=bYS%SzguEidk7 zT3zZpm%#UlP5_NZ*!37~*ZtfxIAdIpA(#|tCZw7*Ww4xVHx-kXB0Wts&}o+=GavjS zzEJXA;?!OTuNv3cc}h>o_Iw0ktWIss(~g=;V0wt|f?Cl8V_j~Px-l;cQ|aEytJ!>R zxKk`1-ew(=u>W(?E8`dElrh1{JJJ1hIC%Y0kcE+G7P+b*<%C3Et}2W@Cu2}{UQOUw z(&|vS&16t6ua^}y%m3-KRivcpapl(!f+otTMk;Av!9z2GuvzP=#`LH;3G*hLNIxwZ zYAgDKR1QwkfNY1aV*8)2|Dw~?F<H-2pLj<Nwf1t(Sc)hr)@Czzo48Fv19l`1vYekQ ztB9CiS1Y{)E|O$ZBBVd@P+z!(jtKew`Y~Q#kWf>y*)E-D>t*nIyWXKuRyPK?fxbQG z<^!oO^}NTk?91p=POq0z{`s1>a08EQrLcM<&#n39LUYM6=cf(uU#gt%4>_lDB|Arz z9td*H3sKO$@6hp@Z7~`zT+Dlk`sm|y)Q<?CBluPTyKVCjpWjaM(GB#Q>XF0bYlBOX zl?Ox<E8CT;_Njui<8<SC$KrNDp1udOZf&B*)Dpg1mEBK~7DNx8i3W>jloGIYc39Nv z%P85Ic^Ft+0)3G#8y`~ZdG3EgXuM58UN~?cej6a56p>+7Qg-qhTrPQ>%<fylX2S)4 zbwmiYQB^_o*A}ssO?iX`-_bUobH8xajI=Sw7Y{}RjEs*JZ+~E~AAo(k(5YHt-@}94 zCA+`=?HHD2vXgMk`*pWPH;xzqGH<rzIhoVKP{rI%U==JHsNJ-h-6i9S*-<vAX3_d^ z5Z>v;cR)I0W@g|Mm*UQI{yUxFe&V+;oPH7K3TE-owlg_@r4p+O)Nie4J37q8qMni1 z)KqH@CcC7(=`~e)5~)ULGxZv$x|?@pH&iBUG-o-TkM-%<>!yJG<91_Z&YbGqdoRsk zO|_Y0nCc={A0Ho-TD<Lz`sv5f*R$)U3QRQ~1PDDqLtoZ3aPP4ZXZ0T~GG+Q(lWCn0 zPaYJ2?agOq?vaGQ(yR~<OcGNNA^08~Et#6GOprC|ZkcK>I2muOGuD5+q+g!TqE83Z zX_>69JpS6$aZaT#&K0rk<aaZGzkID=L8q{e#><r7^qjWZne7%Ex2x^;@36Bx^jPS! z%KCxaPy~MK;w!pxkDM|~2D;f<j(I8cz~gHB#r&dA?8LP%14>W{e0H1=p<~w$pUq6q z$pGd{;HL1fk>8DN-mueUsGsJ7#arBz=E8eI%C1I!9#%|7G6AT9)-N0!kq<H%6$Y*1 z_EmG{PCY)e25b~<wlZHwRgzYPJ>w?MKcuqh`*_&@`M!fsN?Tg8meqUBd3IWATfef_ zu9DCAa>g3GKN=iA;*ot<u-s2Y94)Ihs<yAyb;w>DU3gRSWVPw5_rB_nbNQnc#nVSt zy5%;$W;46LY~`cq{mh7j3Zyd>dT%)1{1R-Pw3N#(w=bXD8A)^;_tekbBGrOTp^SU* zK%C{iH&Hpduh+=*{SHZ2H^gRf@X=d4-SCaN%?G~6D6!8KZu@2!Jb1V#eYTi73RL%F zQ^NI5m%s^`=!HSeXnNyj=sDtvmzA6>s8TBx<!OF*kQvk3w}?5=>S@lHcAC=C;rt4! z@bcW#&sXeGgnYF#4%+34;ZxB5vMV#GRKfl#_s6o`)J*Gh#RxAwq58Lm*HFip`fk<~ z@n%J3`<rw@RNIe}+<5_)s4~r3mgR{H%gJa&$H^x-Rb^c#=9APeL+`-D`t3G(Sxwxo z-A7xmGiG9sa-)P!rvNWoD-%=E5p?xnJ#K5UC^#0jxNsV<_D*8|QNK6Wr#QqHMn<Mb z5)57oCJ>zRtrzA`wVy?i4j~Kn_$*ORT3c>W86%a@pX%#id-1@&`b!>0O3Nn`SzQ5{ zt&<W##Le2JB{a?iQoKjs#5DMO`+mD-n(WzC1)enqFK`qj`DYnqJtebR>qV(qKPn#t zVtNgY$g7QMbBZu2?b#xds(BM18QCqP(`dpIL-cx=9FNzA-TOp5kp}aY+(}uQHy~y^ zaay^jpXgjQ87KAb*}QD(T6aWkd(sdxY~a8=OF2h_A_OpbpamZ}vOtI>wW`)hbcS`| z6ZX+Q%zT;QpktP1dEq$^C8NXJtTI%iz0GJBb#Ca0Cc(B+o$MiD-Rx?FZVLdq_i8v5 z?SJj)5-{`)xK_~QDeyqfCQo3dNjBwxS(UHET=kXSZ=By8@!kE*c{gv2P<i&N{8(TU z?fk$yrJdrDz8`T3JX6z@{5^8Nh!s=S-S!exJm9q*S>3cHYvY7gc`>mYz?2;(A>rB9 z0OEb3QTcRm1Gkyq!@)g(uRb_S_kMLeX48cF)?4}@E_ILRim8b?f_2Y^^7uQOWUQvG zISRYQW)gC)&2O?_xM0-I%4QXR{$8rx-Ti_-uJNYLcM#<Nc$ctr2cg)s(i$9-4$HwD z?X*<ZCOc#f893h1&sG=A5GTB?#i4tR%00H~R?+^<TiK|`db#Utb6#AQoVG9lBPlhT zTSke<;I?RtQO;+CcX-jG$@L58tl)PXtas!_oEFZ-aB7{>$lxiq;3J=IZl7Vf5Jh&y z+gvMnRlA4Q%TbjBqdxw$>L09o9fDetgEE<#lDvX5hD;1%i$%*~hjP<$im3H(iC~_f z98K6I6f-9IUrgR-v;%d|{D^AM+_!3WEq?Z$eGQs11evT&m1UJj&H7IB)n-b^dwxHJ zk4rquU@j<*9Sb3JhY0%7j^4kp`Qd>a8*hSl_~=fpxT<8=EV$UoyyB2=T<xQ89HjT2 ztesg~<ckR`eLm84!?(MJ)2A&zimof+<98mvOvHn}je@i#jmmP^CcK5r_7VRiNx1zi zQ;N>w*qZmXR}v}yh&W@{2wSF9<h9oVmq7AHaG2vb=HswWLegU{ra}~ALxkc+jaoxw zEV#}5*MMk=ee97;%kpXKFhl$9y~L-^?@*t6T^1P5&Cz+ZrY@#L**tQ(yn)w~7X`GR zT3CHMFysENm_IrEzC&sIuwnmXv`&H6I+B*_1ukJ8sYifi@uPOf5J^*W69TGZy1l@_ zxrg^=fihhQ=TUHhHC6u(vfT5|go+xMo*wb@pn0Pa-i?XVp0Ww6t?x)?2*xrdgTJu2 z=ZhoKTzfJ<l>HLOdovnW)Z0@LXg?mt(4z%TTH@wu+SL#olYZiX%Mb6_JkXYO3qITC ze0W>pM?Xcy9fo%XeD-=DtjgK~94n^Cj7{p${vn3qmRd<aUsA-%zimnJaK+TGw0|Vv z>77tJb#sY;jm>0QbuV=kcAAiS+EKT@2s8asxU1g;;#Si;x1K98?bfc1TF~OWYw8%f zHPh0vH%9;A>AhN!Hx#=XHx6`VM?lhAcj?JYlzu&`GIn%Bm$&U7Cchq}n*SB~vX&u& zcs6yr@2B2;9L^5P#*0O>hj(aG2Tx^cTAeG7o}X!mnkjuKJoIkDvMX#RKosJ5!^{%# zi&#yNU6(zFq+_N^n<~A=A#KzAkvY!`>4R4MOr|+0giTe&X>ZvlhkT8SN--Ei#m`PJ z{^^h>nnvdyX6`0Cpb&2W@7weWv~AX1;@#Y4tDHz;Q@5pD=GZVhU6{XFpu8ou&#dAU zV5bFKOcup<X_^wpDE(?nV<)Va;(m%=cOBHt+d0-kh8#X|Zx|fGJl^$*Ir;i-HgbJ( zW$SENHlZmOlav@y>am6y3FV>~`ysFIYxMD#sKh8|amK`poGEJhmhy?17txsyx5c)O ziavUp`m9H`pA@HvRBV!)%)O3Mu$GQCZ2$75{;sX%O|Uj3^^V+2jxQJ1%Ma-0&XOf6 zm8qzelXD2FYM)Tk=DgHD=K#kY5k_AE>>-(HGAFN_f0`-}nybGK&3oKN#?MF9%7CwY zT^rC>`-Qesk9wb>O~w%V8TOcowceRMk7WH6G~`LVA5)E%#O;Z;f9U}ooSV@E4zfui zcDObjmN?_e)017Mza9CHr9|YGNY#Fv-|&lZ+&UciQN#AbS8IKEsBy(JW;-IbLN*3P z8_!>!#?Zo3xQQ96c+c9u@5(VN-u83bGJ0K<4@0y+$<o(Jxo`>CB3bZx$;LlN)1F4n z;T<S$#G7{)ySqO*BQ?=YLTv=D4kP_24iWsiLH%}ON;H`E&m&6v18*w0zGvW-^9~%< z*=oFRapGMSCemA(C|W(^^p0)JoTCt9-q%nF4+AG~K3Ir0K{y#p{{CGfKP%6YYDOj# zo;+kysi9UV(}`A<MX*N7xwE|G96bwfm#>WJPV2eJH2TqklH&Ae!AQrRnfD9xbA^|C z;*<@?ot}W=+8LG1C6LW9{^9;{0TBl#FYDV$r;0*^EMqalVe##;#UhlKJHc#Y50&qt zr7OjA#}VxW2Y$6CO-NPho2|p}z!(<ymK-~2nf0%G-#5AQB^@5}K4EgtDe)aNlzj<Z v|E)K!?PR_BtqNhOFXvh+L^XQ}ATuU-_ldQ=!zh!|Vs0BLtpW-$mka*^gSw+k literal 0 HcmV?d00001 diff --git a/doc/mainpage.hh b/doc/mainpage.hh new file mode 100644 index 0000000..0704753 --- /dev/null +++ b/doc/mainpage.hh @@ -0,0 +1,38 @@ +/** \mainpage Documentation of Olena + + <center> + <h1>Olena Reference Documentation</h1> + + <table class="doxtable itable"> + + <tr> + <th>General Presentation</th> + <th>Modules</th> + <th>Applications</th> + </tr> + <tr> + <td><ul><li>What is Olena ?</li><li>Bibliography</li><li>Contributors</li></ul></td> + <td><ul><li>List of Available modules</li><li><a href='../../../milena/doc/user-refman/html/index.html'>Milena</a></li><li><a href='../../../scribo/doc/user-refman/html/index.html'>Scribo</a></li><li>Swilena</li></ul></td> + <td><ul><li>Online Demos</li><li>Papers Related Programs</li><li>Olena Powered Programs</li></ul></td> + </tr> + + + <tr> + <th>Contributing</th> + <th>Licensing</th> + <th> </th> + </tr> + <tr> + <td><ul><li>Report Bugs and Make Suggestions</li><li>Get the Sources</li><li>Online Resources</li></ul></td> + <td><ul><li>GNU GPL</li><li>Commercial Use</li></ul></td> + <td> </td> + </tr> + + </table> + + </center> + + + */ + + diff --git a/doc/olena.qhcp b/doc/olena.qhcp new file mode 100644 index 0000000..595d34e --- /dev/null +++ b/doc/olena.qhcp @@ -0,0 +1,12 @@ +<?xml version="1.0" encoding="UTF-8"?> +<QHelpCollectionProject version="1.0"> + <assistant> + <startPage>qthelp://fr.epita.lrde.olena/milena-2.0/index.html</startPage> + </assistant> + <docFiles> + <register> + <file>../milena/doc/user-refman/html/milena.qch</file> + <file>../scribo/doc/user-refman/html/scribo.qch</file> + </register> + </docFiles> +</QHelpCollectionProject> \ No newline at end of file diff --git a/doc/subdoc_footer.html b/doc/subdoc_footer.html new file mode 100644 index 0000000..3548c1e --- /dev/null +++ b/doc/subdoc_footer.html @@ -0,0 +1,6 @@ +<hr class="footer"/><address class="footer"> +Copyright (C) 2011 EPITA Research and Development Laboratory (LRDE) +Olena 2.0 +</address> +</body> +</html> diff --git a/milena/doc/Doxyfile.in b/milena/doc/Doxyfile.in index 843280a..494d99c 100644 --- a/milena/doc/Doxyfile.in +++ b/milena/doc/Doxyfile.in @@ -1,5 +1,5 @@ -# Copyright (C) 2007, 2008, 2009, 2010 EPITA Research and Development -# Laboratory (LRDE) +# Copyright (C) 2007, 2008, 2009, 2010, 2011 EPITA Research and +# Development Laboratory (LRDE) # # This file is part of Olena. # @@ -20,8 +20,10 @@ #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- -PROJECT_NAME = "Milena (@PACKAGE_NAME@)" -PROJECT_NUMBER = "User documentation @PACKAGE_VERSION@ @ID@" +PROJECT_NAME = "Milena" +PROJECT_NUMBER = "@PACKAGE_VERSION@" +PROJECT_BRIEF = "An Image Processing Platform" +PROJECT_LOGO = @top_srcdir@/doc/logo.jpg OUTPUT_DIRECTORY = @builddir@/user-refman.tmp CREATE_SUBDIRS = YES OUTPUT_LANGUAGE = English @@ -54,8 +56,8 @@ EXTRACT_PRIVATE = NO EXTRACT_STATIC = NO EXTRACT_LOCAL_CLASSES = NO EXTRACT_LOCAL_METHODS = NO -HIDE_UNDOC_MEMBERS = YES -HIDE_UNDOC_CLASSES = YES +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO HIDE_FRIEND_COMPOUNDS = YES HIDE_IN_BODY_DOCS = YES INTERNAL_DOCS = NO @@ -144,9 +146,10 @@ IGNORE_PREFIX = mln:: GENERATE_HTML = YES HTML_OUTPUT = html HTML_FILE_EXTENSION = .html -HTML_HEADER = -HTML_FOOTER = -HTML_STYLESHEET = +HTML_HEADER = @top_srcdir@/doc/header.html +HTML_FOOTER = @top_srcdir@/doc/subdoc_footer.html +HTML_STYLESHEET = @top_srcdir@/doc/doxygen.css +LAYOUT_FILE = @top_srcdir@/doc/DoxygenLayout.xml HTML_ALIGN_MEMBERS = YES GENERATE_HTMLHELP = NO CHM_FILE = @@ -327,26 +330,26 @@ SKIP_FUNCTION_MACROS = YES # Configuration::additions related to external references #--------------------------------------------------------------------------- TAGFILES = -GENERATE_TAGFILE = +GENERATE_TAGFILE = milena.tag ALLEXTERNALS = NO EXTERNAL_GROUPS = YES PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- -CLASS_DIAGRAMS = YES -HIDE_UNDOC_RELATIONS = YES +CLASS_DIAGRAMS = NO +HIDE_UNDOC_RELATIONS = NO HAVE_DOT = YES -CLASS_GRAPH = YES +CLASS_GRAPH = NO COLLABORATION_GRAPH = NO # Disabled for light doc GROUP_GRAPHS = NO # Disabled for light doc UML_LOOK = NO -TEMPLATE_RELATIONS = YES +TEMPLATE_RELATIONS = NO INCLUDE_GRAPH = NO # Disabled for light doc INCLUDED_BY_GRAPH = NO # Disabled for light doc CALL_GRAPH = NO CALLER_GRAPH = NO -GRAPHICAL_HIERARCHY = YES +GRAPHICAL_HIERARCHY = NO DIRECTORY_GRAPH = NO # Disabled for light doc DOT_IMAGE_FORMAT = png DOT_PATH = @@ -360,6 +363,15 @@ DOT_CLEANUP = YES # Configuration::additions related to the search engine #--------------------------------------------------------------------------- SEARCHENGINE = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to the Qt help engine +#--------------------------------------------------------------------------- +GENERATE_QHP = yes +QHP_NAMESPACE = "fr.epita.lrde.olena.scribo" +QHP_VIRTUAL_FOLDER = "scribo-2.0" +QCH_FILE = "@builddir@/scribo.qch" +QHG_LOCATION = "qhelpgenerator" + # Local Variables: # mode: Makefile diff --git a/milena/doc/DoxygenLayout.xml b/milena/doc/DoxygenLayout.xml new file mode 100644 index 0000000..ff1e5e4 --- /dev/null +++ b/milena/doc/DoxygenLayout.xml @@ -0,0 +1,184 @@ +<doxygenlayout version="1.0"> +  + <navindex> + <tab type="mainpage" visible="yes" title="Milena"/> + <tab type="pages" visible="yes" title=""/> + <tab type="modules" visible="yes" title=""/> + <tab type="namespaces" visible="yes" title=""> + <tab type="namespaces" visible="yes" title=""/> + <tab type="namespacemembers" visible="yes" title=""/> + </tab> + <tab type="classes" visible="yes" title=""> + <tab type="classes" visible="yes" title=""/> + <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> + <tab type="hierarchy" visible="yes" title=""/> + <tab type="classmembers" visible="yes" title=""/> + </tab> + <tab type="files" visible="yes" title=""> + <tab type="files" visible="yes" title=""/> + <tab type="globals" visible="yes" title=""/> + </tab> + <tab type="dirs" visible="yes" title=""/> + <tab type="examples" visible="yes" title=""/> + </navindex> + +  + <class> + <briefdescription visible="yes"/> + <includes visible="$SHOW_INCLUDE_FILES"/> + <inheritancegraph visible="$CLASS_GRAPH"/> + <collaborationgraph visible="$COLLABORATION_GRAPH"/> + <allmemberslink visible="yes"/> + <memberdecl> + <nestedclasses visible="yes" title=""/> + <publictypes title=""/> + <publicslots title=""/> + <signals title=""/> + <publicmethods title=""/> + <publicstaticmethods title=""/> + <publicattributes title=""/> + <publicstaticattributes title=""/> + <protectedtypes title=""/> + <protectedslots title=""/> + <protectedmethods title=""/> + <protectedstaticmethods title=""/> + <protectedattributes title=""/> + <protectedstaticattributes title=""/> + <packagetypes title=""/> + <packagemethods title=""/> + <packagestaticmethods title=""/> + <packageattributes title=""/> + <packagestaticattributes title=""/> + <properties title=""/> + <events title=""/> + <privatetypes title=""/> + <privateslots title=""/> + <privatemethods title=""/> + <privatestaticmethods title=""/> + <privateattributes title=""/> + <privatestaticattributes title=""/> + <friends title=""/> + <related title="" subtitle=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <typedefs title=""/> + <enums title=""/> + <constructors title=""/> + <functions title=""/> + <related title=""/> + <variables title=""/> + <properties title=""/> + <events title=""/> + </memberdef> + <usedfiles visible="$SHOW_USED_FILES"/> + <authorsection visible="yes"/> + </class> + +  + <namespace> + <briefdescription visible="yes"/> + <memberdecl> + <nestednamespaces visible="yes" title=""/> + <classes visible="yes" title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + </memberdef> + <authorsection visible="yes"/> + </namespace> + +  + <file> + <briefdescription visible="yes"/> + <includes visible="$SHOW_INCLUDE_FILES"/> + <includegraph visible="$INCLUDE_GRAPH"/> + <includedbygraph visible="$INCLUDED_BY_GRAPH"/> + <sourcelink visible="yes"/> + <memberdecl> + <classes visible="yes" title=""/> + <namespaces visible="yes" title=""/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + </memberdef> + <authorsection/> + </file> + +  + <group> + <briefdescription visible="yes"/> + <groupgraph visible="$GROUP_GRAPHS"/> + <memberdecl> + <classes visible="yes" title=""/> + <namespaces visible="yes" title=""/> + <dirs visible="yes" title=""/> + <nestedgroups visible="yes" title=""/> + <files visible="yes" title=""/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <enumvalues title=""/> + <functions title=""/> + <variables title=""/> + <signals title=""/> + <publicslots title=""/> + <protectedslots title=""/> + <privateslots title=""/> + <events title=""/> + <properties title=""/> + <friends title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <pagedocs/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <enumvalues title=""/> + <functions title=""/> + <variables title=""/> + <signals title=""/> + <publicslots title=""/> + <protectedslots title=""/> + <privateslots title=""/> + <events title=""/> + <properties title=""/> + <friends title=""/> + </memberdef> + <authorsection visible="yes"/> + </group> + +  + <directory> + <briefdescription visible="yes"/> + <directorygraph visible="yes"/> + <memberdecl> + <dirs visible="yes"/> + <files visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + </directory> +</doxygenlayout> diff --git a/milena/doc/milena.qhcp b/milena/doc/milena.qhcp new file mode 100644 index 0000000..1a4e7ca --- /dev/null +++ b/milena/doc/milena.qhcp @@ -0,0 +1,11 @@ +<?xml version="1.0" encoding="UTF-8"?> +<QHelpCollectionProject version="1.0"> + <assistant> + <startPage>qthelp://fr.epita.lrde.olena/milena-2.0/index.html</startPage> + </assistant> + <docFiles> + <register> + <file>user-refman/html/milena.qch</file> + </register> + </docFiles> +</QHelpCollectionProject> \ No newline at end of file diff --git a/scribo/doc/.gitignore b/scribo/doc/.gitignore new file mode 100644 index 0000000..c858430 --- /dev/null +++ b/scribo/doc/.gitignore @@ -0,0 +1,13 @@ +/Doxyfile_user +/user-refman +/user-refman.pdf + +/Doxyfile_devel +/devel-refman +/devel-refman.pdf + +/figures/*.png + +/tutorial.hh +/tutorial.pdf +/tutorial/ diff --git a/scribo/doc/Doxyfile.in b/scribo/doc/Doxyfile.in new file mode 100644 index 0000000..d279d76 --- /dev/null +++ b/scribo/doc/Doxyfile.in @@ -0,0 +1,373 @@ +# Copyright (C) 2011 EPITA Research and Development Laboratory (LRDE) +# +# This file is part of Olena. +# +# Olena is free software: you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation, version 2 of the License. +# +# Olena is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Olena. If not, see <http://www.gnu.org/licenses/>. +# +# Doxyfile 1.5.1 + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- +PROJECT_NAME = "Scribo" +PROJECT_NUMBER = "User documentation @PACKAGE_VERSION@" +PROJECT_BRIEF = "An Image Processing Platform" +PROJECT_LOGO = @top_srcdir@/doc/logo.jpg +OUTPUT_DIRECTORY = @builddir@/user-refman.tmp +CREATE_SUBDIRS = YES +OUTPUT_LANGUAGE = English +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ABBREVIATE_BRIEF = +ALWAYS_DETAILED_SEC = YES +INLINE_INHERITED_MEMB = YES +FULL_PATH_NAMES = NO +STRIP_FROM_PATH = @top_srcdir@/scribo +STRIP_FROM_INC_PATH = +SHORT_NAMES = YES +JAVADOC_AUTOBRIEF = YES +MULTILINE_CPP_IS_BRIEF = NO +INHERIT_DOCS = YES +SEPARATE_MEMBER_PAGES = NO +TAB_SIZE = 8 +ALIASES = +OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_JAVA = NO +BUILTIN_STL_SUPPORT = YES +IDL_PROPERTY_SUPPORT = NO +DISTRIBUTE_GROUP_DOC = NO +SUBGROUPING = YES +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- +EXTRACT_ALL = NO +EXTRACT_PRIVATE = NO +EXTRACT_STATIC = NO +EXTRACT_LOCAL_CLASSES = NO +EXTRACT_LOCAL_METHODS = NO +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +HIDE_FRIEND_COMPOUNDS = YES +HIDE_IN_BODY_DOCS = YES +INTERNAL_DOCS = NO +CASE_SENSE_NAMES = YES +HIDE_SCOPE_NAMES = NO +SHOW_INCLUDE_FILES = YES +INLINE_INFO = YES +SORT_MEMBER_DOCS = YES +SORT_BRIEF_DOCS = YES +SORT_BY_SCOPE_NAME = YES +GENERATE_TODOLIST = NO +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +GENERATE_DEPRECATEDLIST= YES +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 30 +SHOW_USED_FILES = NO # Disabled for light doc +SHOW_DIRECTORIES = NO # Disabled for light doc +SHOW_FILES = NO # Disabled for light doc +SHOW_NAMESPACES = YES +FILE_VERSION_FILTER = +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = YES +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = NO +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = @top_srcdir@/scribo +FILE_PATTERNS = *.cc \ + *.hh \ + *.hxx \ + *.hcc +RECURSIVE = YES +EXCLUDE = @top_srcdir@/scribo/demo \ + @top_srcdir@/scribo/sandbox \ + @top_srcdir@/scribo/doc/user-refman \ + @top_srcdir@/scribo/doc/devel-refman \ + @top_srcdir@/scribo/tests/unit_test +EXCLUDE_SYMLINKS = YES +EXCLUDE_PATTERNS = *spe.hh +EXCLUDE_SYMBOLS = *::internal* *_ mln::trait::* +EXAMPLE_PATH = @top_srcdir@/scribo/doc/examples \ + @top_srcdir@/scribo/doc/outputs \ + @top_srcdir@/scribo/doc/examples/split \ + @top_srcdir@/scribo/doc/outputs/split +EXAMPLE_PATTERNS = *.cc \ + *.cc.raw \ + *.txt +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = @top_srcdir@/scribo/doc/img \ + @top_srcdir@/scribo/doc/figures +INPUT_FILTER = +FILTER_PATTERNS = +FILTER_SOURCE_FILES = NO +INPUT_ENCODING = ISO-8859-1 + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = YES +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION = YES +REFERENCES_LINK_SOURCE = NO +USE_HTAGS = NO +VERBATIM_HEADERS = YES +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = YES +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = mln:: +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = @top_srcdir@/doc/header.html +HTML_FOOTER = @top_srcdir@/doc/subdoc_footer.html +HTML_STYLESHEET = @top_srcdir@/doc/doxygen.css +LAYOUT_FILE = @top_srcdir@/scribo/doc/DoxygenLayout.xml +HTML_ALIGN_MEMBERS = YES +GENERATE_HTMLHELP = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +BINARY_TOC = NO +TOC_EXPAND = NO +DISABLE_INDEX = NO +ENUM_VALUES_PER_LINE = 4 +GENERATE_TREEVIEW = YES +TREEVIEW_WIDTH = 250 +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = YES +LATEX_OUTPUT = latex +LATEX_CMD_NAME = latex +MAKEINDEX_CMD_NAME = makeindex +COMPACT_LATEX = NO +PAPER_TYPE = a4wide +EXTRA_PACKAGES = +LATEX_HEADER = +PDF_HYPERLINKS = YES +USE_PDFLATEX = YES +LATEX_BATCHMODE = YES +LATEX_HIDE_INDICES = NO +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_LINKS = NO +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML = NO +XML_OUTPUT = xml +XML_SCHEMA = +XML_DTD = +XML_PROGRAMLISTING = YES +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- +GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- +GENERATE_PERLMOD = NO +PERLMOD_LATEX = NO +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = YES +EXPAND_ONLY_PREDEF = YES +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = "for_all(x)=for(x.start(); x.is_valid(); x.next())" \ + "for_all_2(x1, x2)=for(x1.start(), x2.start(); x1.is_valid(); x1.next(), x2.next())" \ + "for_all_3(x1, x2, x3)=for(x1.start(), x2.start(), x3.start(); x1.is_valid(); x1.next(), x2.next(), x3.next())" \ + "for_all_remaining(x)=if (! x.is_valid()) {} else while (x.next(), x.is_valid())" \ + "mlc_unqualif(T)=typename mln::metal::unqualif<T>::ret" \ + "mlc_equal(T1,T2)=mln::metal::equal<T1,T2>" \ + "mln_piter(T)=typename T::piter" \ + "mln_fwd_piter(T)=typename T::fwd_piter" \ + "mln_bkd_piter(T)=typename T::bkd_piter" \ + "mln_qiter(T)=typename T::qiter" \ + "mln_fwd_qiter(T)=typename T::fwd_qiter" \ + "mln_bkd_qiter(T)=typename T::bkd_qiter" \ + "mln_niter(T)=typename T::niter" \ + "mln_fwd_niter(T)=typename T::fwd_niter" \ + "mln_bkd_niter(T)=typename T::bkd_niter" \ + "mln_viter(T)=typename T::viter" \ + "mln_fwd_viter(T)=typename T::fwd_viter" \ + "mln_bkd_viter(T)=typename T::bkd_viter" \ + "mln_result(T)=typename T::result" \ + "mln_enc(T)=typename T::enc" \ + "mln_value(T)=typename T::value" \ + "mln_qlf_value(T)=typename T::qlf_value" \ + "mln_domain(T)=typename T::domain_t" \ + "mln_sum(T)=typename mln::value::props<T>::sum" \ + "mln_vset(T)=typename T::vset" \ + "mln_rvalue(T)=typename T::rvalue" \ + "mln_lvalue(T)=typename T::lvalue" \ + "mln_mesh(T)=typename T::mesh" \ + "mln_coord(T)=typename T::coord" \ + "mln_site(T)=typename T::site" \ + "mln_psite(T)=typename T::psite" \ + "mln_dpsite(T)=typename T::dpsite" \ + "mln_accu_with(A, T)=typename A::template with< T >::ret" \ + "mln_trait_op_div(L, R)=typename mln::trait::op::div< L , R >::ret" \ + "mln_trait_op_less(L, R)=typename mln::trait::op::less< L , R >::ret" \ + "mln_trait_op_minus(L, R)=typename mln::trait::op::minus< L , R >::ret" \ + "mln_trait_op_mod(L, R)=typename mln::trait::op::mod< L , R >::ret" \ + "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" \ + "mln_bkd_piter_(T)=T::bkd_piter" \ + "mln_qiter_(T)=T::qiter" \ + "mln_fwd_qiter_(T)=T::fwd_qiter" \ + "mln_bkd_qiter_(T)=T::bkd_qiter" \ + "mln_niter_(T)=T::niter" \ + "mln_fwd_niter_(T)=T::fwd_niter" \ + "mln_bkd_niter_(T)=T::bkd_niter" \ + "mln_viter_(T)=T::viter" \ + "mln_fwd_viter_(T)=T::fwd_viter" \ + "mln_bkd_viter_(T)=T::bkd_viter" \ + "mln_result_(T)=T::result" \ + "mln_enc_(T)=T::enc" \ + "mln_value_(T)=T::value" \ + "mln_qlf_value_(T)=T::qlf_value" \ + "mln_domain_(T)=T::domain_t" \ + "mln_sum_(T)=mln::value::props<T>::sum" \ + "mln_vset_(T)=T::vset" \ + "mln_rvalue_(T)=T::rvalue" \ + "mln_lvalue_(T)=T::lvalue" \ + "mln_mesh_(T)=T::mesh" \ + "mln_coord_(T)=T::coord" \ + "mln_site_(T)=T::site" \ + "mln_psite_(T)=T::psite" \ + "mln_dpsite_(T)=T::dpsite" \ + "mln_accu_with_(A, T)=A::template with< T >::ret" \ + "mln_trait_op_plus_(L, R)=mln::trait::op::plus< L , R >::ret" \ + "mln_trait_op_minus_(L, R)=mln::trait::op::minus< L , R >::ret" \ + "mln_trait_op_times_(L, R)=mln::trait::op::times< L , R >::ret" \ + "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_morpher_lvalue(I)=typename internal::morpher_lvalue_::ret" \ + "mln_concrete(I)=typename mln::trait::concrete::ret" \ + "mln_concrete_ch_value(I, V)=typename mln::trait::ch_value< typename mln::trait::concrete::ret, V >::ret" \ + "mlc_const(T)=typename mln::metal::const_< T >::ret" \ + "mlc_const_return(T)=typename mln::metal::const_return_< T >::ret" \ + "mln_element(T)=typename T::element" \ + "mln_element_(T)=T::element" \ + "mln_delta(T)=typename T::delta" \ + "mln_delta_(T)=T::delta" \ + "mln_dpoint(T)=typename T::dpoint" \ + "mln_dpoint_(T)=T::dpoint" \ + "mln_point(T)=typename T::point" \ + "mln_point_(T)=T::point" \ + "mln_gradient_component(I)=typename mln::trait::ch_value< I, mln::value::props< typename I::value >::sum >::ret" \ + "mln_gradient(I)=mln::value::stack_image< I::point::dim, mln::trait::ch_value< I, mln::value::props< typename I::value >::sum >::ret >" \ + "mln_trait_value_sum_product(T, U)=typename mln::trait::value_< mln_trait_op_times(T,U) >::sum" \ + "mln_sum_product(T, U)=typename mln::trait::value_< mln_trait_op_times(T,U) >::sum" \ + "mln_deduce(T, A1, A2)=typename T::A1::A2" \ + "mln_graph_element(T)=typename T::graph_element" \ + "mln_graph_element_(T)=T::graph_element" \ + "mln_fun_vv2v(F, L, R)=mln::fun::vv2v::F< mln_value(L), mln_value(R) >" \ + "mln_fun_vv2v_result(F, L, R)=typename mln_fun_vv2v(F, L, R)::result" \ + "mln_ch_fun_vv2v(F, L, R)=typename mln::trait::ch_value< L, typename mln_fun_vv2v(F, L, R)::result >::ret" + + + + +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- +TAGFILES = @builddir@/../../milena/doc/milena.tag=../../../../milena/doc/user-refman/html +GENERATE_TAGFILE = scribo.tag +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +PERL_PATH = /usr/bin/perl +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +CLASS_DIAGRAMS = NO +HIDE_UNDOC_RELATIONS = YES +HAVE_DOT = YES +CLASS_GRAPH = NO +COLLABORATION_GRAPH = NO # Disabled for light doc +GROUP_GRAPHS = NO # Disabled for light doc +UML_LOOK = NO +TEMPLATE_RELATIONS = NO +INCLUDE_GRAPH = NO # Disabled for light doc +INCLUDED_BY_GRAPH = NO # Disabled for light doc +CALL_GRAPH = NO +CALLER_GRAPH = NO +GRAPHICAL_HIERARCHY = NO +DIRECTORY_GRAPH = NO # Disabled for light doc +DOT_IMAGE_FORMAT = png +DOT_PATH = +DOTFILE_DIRS = +MAX_DOT_GRAPH_DEPTH = 1000 +DOT_TRANSPARENT = NO +DOT_MULTI_TARGETS = NO +GENERATE_LEGEND = NO # Disabled for light doc +DOT_CLEANUP = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- +SEARCHENGINE = YES + +GENERATE_QHP = yes +QHP_NAMESPACE = "fr.epita.lrde.olena.scribo" +QHP_VIRTUAL_FOLDER = "scribo-2.0" +QCH_FILE = "@builddir@/scribo.qch" +QHG_LOCATION = "qhelpgenerator" + + +# Local Variables: +# mode: Makefile +# End: diff --git a/scribo/doc/DoxygenLayout.xml b/scribo/doc/DoxygenLayout.xml new file mode 100644 index 0000000..ac34f54 --- /dev/null +++ b/scribo/doc/DoxygenLayout.xml @@ -0,0 +1,184 @@ +<doxygenlayout version="1.0"> +  + <navindex> + <tab type="mainpage" visible="yes" title="Scribo"/> + <tab type="pages" visible="yes" title=""/> + <tab type="modules" visible="yes" title=""/> + <tab type="namespaces" visible="yes" title=""> + <tab type="namespaces" visible="yes" title=""/> + <tab type="namespacemembers" visible="yes" title=""/> + </tab> + <tab type="classes" visible="yes" title=""> + <tab type="classes" visible="yes" title=""/> + <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> + <tab type="hierarchy" visible="yes" title=""/> + <tab type="classmembers" visible="yes" title=""/> + </tab> + <tab type="files" visible="yes" title=""> + <tab type="files" visible="yes" title=""/> + <tab type="globals" visible="yes" title=""/> + </tab> + <tab type="dirs" visible="yes" title=""/> + <tab type="examples" visible="yes" title=""/> + </navindex> + +  + <class> + <briefdescription visible="yes"/> + <includes visible="$SHOW_INCLUDE_FILES"/> + <inheritancegraph visible="$CLASS_GRAPH"/> + <collaborationgraph visible="$COLLABORATION_GRAPH"/> + <allmemberslink visible="yes"/> + <memberdecl> + <nestedclasses visible="yes" title=""/> + <publictypes title=""/> + <publicslots title=""/> + <signals title=""/> + <publicmethods title=""/> + <publicstaticmethods title=""/> + <publicattributes title=""/> + <publicstaticattributes title=""/> + <protectedtypes title=""/> + <protectedslots title=""/> + <protectedmethods title=""/> + <protectedstaticmethods title=""/> + <protectedattributes title=""/> + <protectedstaticattributes title=""/> + <packagetypes title=""/> + <packagemethods title=""/> + <packagestaticmethods title=""/> + <packageattributes title=""/> + <packagestaticattributes title=""/> + <properties title=""/> + <events title=""/> + <privatetypes title=""/> + <privateslots title=""/> + <privatemethods title=""/> + <privatestaticmethods title=""/> + <privateattributes title=""/> + <privatestaticattributes title=""/> + <friends title=""/> + <related title="" subtitle=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <typedefs title=""/> + <enums title=""/> + <constructors title=""/> + <functions title=""/> + <related title=""/> + <variables title=""/> + <properties title=""/> + <events title=""/> + </memberdef> + <usedfiles visible="$SHOW_USED_FILES"/> + <authorsection visible="yes"/> + </class> + +  + <namespace> + <briefdescription visible="yes"/> + <memberdecl> + <nestednamespaces visible="yes" title=""/> + <classes visible="yes" title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + </memberdef> + <authorsection visible="yes"/> + </namespace> + +  + <file> + <briefdescription visible="yes"/> + <includes visible="$SHOW_INCLUDE_FILES"/> + <includegraph visible="$INCLUDE_GRAPH"/> + <includedbygraph visible="$INCLUDED_BY_GRAPH"/> + <sourcelink visible="yes"/> + <memberdecl> + <classes visible="yes" title=""/> + <namespaces visible="yes" title=""/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + </memberdef> + <authorsection/> + </file> + +  + <group> + <briefdescription visible="yes"/> + <groupgraph visible="$GROUP_GRAPHS"/> + <memberdecl> + <classes visible="yes" title=""/> + <namespaces visible="yes" title=""/> + <dirs visible="yes" title=""/> + <nestedgroups visible="yes" title=""/> + <files visible="yes" title=""/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <enumvalues title=""/> + <functions title=""/> + <variables title=""/> + <signals title=""/> + <publicslots title=""/> + <protectedslots title=""/> + <privateslots title=""/> + <events title=""/> + <properties title=""/> + <friends title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <pagedocs/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <enumvalues title=""/> + <functions title=""/> + <variables title=""/> + <signals title=""/> + <publicslots title=""/> + <protectedslots title=""/> + <privateslots title=""/> + <events title=""/> + <properties title=""/> + <friends title=""/> + </memberdef> + <authorsection visible="yes"/> + </group> + +  + <directory> + <briefdescription visible="yes"/> + <directorygraph visible="yes"/> + <memberdecl> + <dirs visible="yes"/> + <files visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + </directory> +</doxygenlayout> diff --git a/scribo/doc/Makefile.am b/scribo/doc/Makefile.am new file mode 100644 index 0000000..f1fae6c --- /dev/null +++ b/scribo/doc/Makefile.am @@ -0,0 +1,250 @@ +# Copyright (C) 2011 EPITA Research and Development Laboratory (LRDE). +# +# This file is part of Olena. +# +# Olena is free software: you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation, version 2 of the License. +# +# Olena is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Olena. If not, see <http://www.gnu.org/licenses/>. + + +# Look for Scribo headers in srcdir and for (generated) test headers +# (like data.hh) in builddir. +AM_CPPFLAGS = -I$(top_srcdir)/scribo -I$(top_builddir)/scribo + +DOXYGEN = doxygen + +DOXYFILE = Doxyfile + +DATA_html_dirs = + +## --------------------- ## +## LaTeX configuration. ## +## --------------------- ## + +include $(top_srcdir)/build-aux/tex.mk + +TEXI2DVI_FLAGS += \ + -I $(srcdir) -I $(srcdir)/outputs -I $(srcdir)/outputs/split \ + -I $(srcdir)/img -I $(srcdir)/examples/split + +# Additional files for LaTeX compilations. +DOC_PACKAGES = doxyfuns.sty scribo.sty + + +# ----------------------- # +# User Reference Manual. # +# ----------------------- # + +all-local: $(srcdir)/$(USER_REFMAN) + +# Run "make regen-doc" to forcefully rebuild the Doxygen documentation. +.PHONY: regen-doc +regen-doc: + rm -f $(srcdir)/user-refman.stamp + $(MAKE) $(AM_MAKEFLAGS) $(srcdir)/user-refman.stamp + +DOXYFILE_USER = Doxyfile_user + +# Sed is used to generate Doxyfile from Doxyfile.in instead of +# configure, because the former is way faster than the latter. +# +## FIXME: This is because, as in TC, we depend on $Id$ from the +## ChangeLog. Maybe we should depend from something less prone to +## change. See Bison's build system. +edit = sed -e "s|@ID@|$$Id|" \ + -e 's,@PACKAGE_NAME\@,$(PACKAGE_NAME),g' \ + -e 's,@PACKAGE_VERSION\@,$(PACKAGE_VERSION),g' \ + -e 's,@top_srcdir\@,$(top_srcdir),g' \ + -e 's,@top_builddir\@,$(top_builddir),g' \ + -e 's,@srcdir\@,$(srcdir),g' \ + -e 's,@builddir\@,$(builddir),g' + +$(DOXYFILE_USER): $(srcdir)/$(DOXYFILE).in + Id=`grep '^\$$Id' $(top_srcdir)/scribo/ChangeLog \ + | sed -e 's/\\\$$//g'`; \ + $(edit) $< >$@ +MAINTAINERCLEANFILES = $(DOXYFILE_USER) + +USER_REFMAN = user-refman + +# PDF. +USER_REFMAN_PDF = user-refman.pdf +dist_pdf_DATA = $(srcdir)/$(USER_REFMAN_PDF) + +$(srcdir)/$(USER_REFMAN_PDF): $(srcdir)/$(USER_REFMAN) + cd $(srcdir)/$(USER_REFMAN)/latex && $(MAKE) $(AM_MAKEFLAGS) pdf + cp -f $(srcdir)/$(USER_REFMAN)/latex/refman.pdf $@ + +# HTML. +EXTRA_DIST = $(srcdir)/user-refman.stamp +MAINTAINERCLEANFILES += $(srcdir)/user-refman.stamp +$(srcdir)/user-refman.stamp: $(srcdir)/$(DOXYFILE).in $(REFMAN_deps) + @rm -f $@.tmp + @touch $@.tmp + rm -rf $(USER_REFMAN).tmp + $(MAKE) $(AM_MAKE_FLAGS) $(DOXYFILE_USER) + $(DOXYGEN) $(DOXYFILE_USER) +## Doxygen may generate an incomplete output and exit with success! +## Check some files before deeming the output as acceptable. + test -f $(USER_REFMAN).tmp/latex/refman.tex + rm -rf $(srcdir)/$(USER_REFMAN) +## FIXME: Moving directories between file systems is not portable. + mv $(USER_REFMAN).tmp $(srcdir)/$(USER_REFMAN) + @mv -f $@.tmp $@ + +$(srcdir)/$(USER_REFMAN): $(srcdir)/user-refman.stamp +## Recover from the removal of $@. + @if test -d $@; then :; else \ + rm -f $<; \ + $(MAKE) $(AM_MAKEFLAGS) $<; \ + fi + +# Installing a directory located in the source dir is not supported by +# Automake by default, so we cannot simply add `$(USER_REFMAN)/html' +# to `dist_doc_DATA'. The rule `install-data-local' (see below) used +# to work around this limitation is borrowed from the Vaucanson +# project. +EXTRA_DIST += $(USER_REFMAN) + + +# ---------------------------- # +# Developer Reference Manual. # +# ---------------------------- # + +# Run "make regen-devel-doc" to forcefully rebuild the Doxygen +# developer documentation. +.PHONY: regen-devel-doc +regen-devel-doc: + rm -f $(srcdir)/devel-refman.stamp + $(MAKE) $(AM_MAKEFLAGS) $(srcdir)/devel-refman.stamp + +DOXYFILE_DEVEL = Doxyfile_devel + +edit_devel = sed \ + -e 's,OUTPUT_DIRECTORY = @builddir@/user-refman.tmp,OUTPUT_DIRECTORY = @builddir@/devel-refman.tmp,' \ + -e 's,EXTRACT_ALL = NO,EXTRACT_ALL = YES,' \ + -e 's,EXTRACT_PRIVATE = NO,EXTRACT_PRIVATE = YES,' \ + -e 's,EXTRACT_STATIC = NO,EXTRACT_STATIC = YES,' \ + -e 's,EXTRACT_LOCAL_CLASSES = NO,EXTRACT_LOCAL_CLASSES = YES,' \ + -e 's,HIDE_UNDOC_MEMBERS = YES,HIDE_UNDOC_MEMBERS = NO,' \ + -e 's,HIDE_UNDOC_CLASSES = YES,HIDE_UNDOC_CLASSES = NO,' \ + -e 's,HIDE_FRIEND_COMPOUNDS = YES,HIDE_FRIEND_COMPOUNDS = NO,' \ + -e 's,HIDE_IN_BODY_DOCS = YES,HIDE_IN_BODY_DOCS = NO,' \ + -e 's,INTERNAL_DOCS = NO,INTERNAL_DOCS = YES,' \ + -e 's,GENERATE_TODOLIST = NO,GENERATE_TODOLIST = YES,' \ + -e 's,PROJECT_NUMBER = \"User documentation ,PROJECT_NUMBER = \",' \ + -e 's,EXCLUDE_SYMBOLS = \*::internal\* \*_ mln::trait::\*,EXCLUDE_SYMBOLS =,' + +$(DOXYFILE_DEVEL): $(srcdir)/$(DOXYFILE).in + rm -f $@.tmp + Id=`grep '^\$$Id' $(top_srcdir)/scribo/ChangeLog \ + | sed -e 's/\\\$$//g'`; \ + $(edit) $< >$@.tmp + $(edit_devel) $@.tmp >$@ + rm -f $@.tmp +MAINTAINERCLEANFILES += $(DOXYFILE_DEVEL) + +DEVEL_REFMAN = devel-refman + +# PDF. +DEVEL_REFMAN_PDF = devel-refman.pdf +# Be warned, most LaTeX installations will not be able to compile the +# PDF development documentation as-is, as TeX's default memory +# capacities are usually too small to handle such a large document. +$(srcdir)/$(DEVEL_REFMAN_PDF): $(srcdir)/$(DEVEL_REFMAN) + cd $(srcdir)/$(DEVEL_REFMAN)/latex && $(MAKE) $(AM_MAKEFLAGS) pdf + cp -f $(srcdir)/$(DEVEL_REFMAN)/latex/refman.pdf $@ + +# HTML. +MAINTAINERCLEANFILES += $(srcdir)/devel-refman.stamp +$(srcdir)/devel-refman.stamp: $(srcdir)/$(DOXYFILE).in $(REFMAN_deps) + @rm -f $@.tmp + @touch $@.tmp + rm -rf $(DEVEL_REFMAN).tmp + $(MAKE) $(AM_MAKE_FLAGS) $(DOXYFILE_DEVEL) + $(DOXYGEN) $(DOXYFILE_DEVEL) +## Doxygen may generate an incomplete output and exit with success! +## Check some files before deeming the output as acceptable. + test -f $(DEVEL_REFMAN).tmp/latex/refman.tex + rm -rf $(srcdir)/$(DEVEL_REFMAN) +## FIXME: Moving directories between file systems is not portable. + mv $(DEVEL_REFMAN).tmp $(srcdir)/$(DEVEL_REFMAN) + @mv -f $@.tmp $@ + +$(srcdir)/$(DEVEL_REFMAN): $(srcdir)/devel-refman.stamp +## Recover from the removal of $@. + @if test -d $@; then :; else \ + rm -f $<; \ + $(MAKE) $(AM_MAKEFLAGS) $<; \ + fi + +## -------------- ## +## Distribution. ## +## -------------- ## + +EXTRA_DIST += \ + $(DATA_html_dirs) \ + $(DOXYFILE).in \ + doxyfuns.sty \ + scribo.sty \ + tools/clearbanner.sh \ + tools/sample_utils.hh \ + tools/split_sample.sh \ + tools/todoxygen.sh + + +## ---------- ## +## Cleaning. ## +## ---------- ## + +MAINTAINERCLEANFILES += $(dist_pdf_DATA) + +maintainer-clean-local: + -rm -rf $(USER_REFMAN).tmp $(srcdir)/$(USER_REFMAN) + -rm -rf $(DEVEL_REFMAN).tmp $(srcdir)/$(DEVEL_REFMAN) + -for d in $(DATA_html_dirs); do \ + rm -rf $$d.tmp $(srcdir)/$$d; \ + done + + +## -------------- ## +## Installation. ## +## -------------- ## + +# We install by hand, otherwise Automake produces "install .../srcdoc +# .../srcdoc", which installs our dir into the previous one, instead +# of replacing it. +install-data-local: + $(mkdir_p) $(DESTDIR)$(htmldir) +# The user reference manual is located in a subdirectory, hence this +# special case. + rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN) + cp -r $(srcdir)/$(USER_REFMAN)/html $(DESTDIR)$(htmldir)/$(USER_REFMAN) +# Other HTML directories can be processed uniformly. + for d in $(DATA_html_dirs_inst); do \ + rm -rf $(DESTDIR)$(htmldir)/$$d; \ + cp -r $(srcdir)/$$d $(DESTDIR)$(htmldir); \ + done +## Try GNU chmod's X mode before resorting to something slower but +## more standard. + chmod -R a+rX $(DESTDIR)$(htmldir) || \ + find $(DESTDIR)$(htmldir) $ -type d -a -exec chmod a+rx {} \; $ \ + -o -exec chmod a+r {} \; + +uninstall-local: + for d in $(DATA_html_dirs_inst); do \ + chmod -R 700 $(DESTDIR)$(htmldir)/$$d; \ + rm -rf $(DESTDIR)$(htmldir)/$$d; \ + done +# Same remark as above regarding the special case of the user +# reference manual. + chmod -R 700 $(DESTDIR)$(htmldir)/$(USER_REFMAN) + rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN) diff --git a/milena/doc/doxyfuns.sty b/scribo/doc/doxyfuns.sty similarity index 100% copy from milena/doc/doxyfuns.sty copy to scribo/doc/doxyfuns.sty diff --git a/milena/doc/outputs/accu-right-instantiation.txt b/scribo/doc/examples-outputs.mk similarity index 100% copy from milena/doc/outputs/accu-right-instantiation.txt copy to scribo/doc/examples-outputs.mk diff --git a/scribo/doc/examples.mk b/scribo/doc/examples.mk new file mode 100644 index 0000000..c7181cc --- /dev/null +++ b/scribo/doc/examples.mk @@ -0,0 +1,4 @@ +## Generated by gen-make-variable. Do not edit by hand. + +EXAMPLES = \ + $(srcdir)/examples/dummy.cc diff --git a/milena/doc/outputs/accu-right-instantiation.txt b/scribo/doc/examples/dummy.cc similarity index 100% copy from milena/doc/outputs/accu-right-instantiation.txt copy to scribo/doc/examples/dummy.cc diff --git a/milena/doc/outputs/accu-right-instantiation.txt b/scribo/doc/figures.mk similarity index 100% copy from milena/doc/outputs/accu-right-instantiation.txt copy to scribo/doc/figures.mk diff --git a/milena/doc/gen-examples-outputs-mk b/scribo/doc/gen-examples-outputs-mk similarity index 100% copy from milena/doc/gen-examples-outputs-mk copy to scribo/doc/gen-examples-outputs-mk diff --git a/milena/doc/gen-figures-mk b/scribo/doc/gen-figures-mk similarity index 100% copy from milena/doc/gen-figures-mk copy to scribo/doc/gen-figures-mk diff --git a/milena/doc/gen-make-variable b/scribo/doc/gen-make-variable similarity index 100% copy from milena/doc/gen-make-variable copy to scribo/doc/gen-make-variable diff --git a/milena/doc/gen-split-examples-mk b/scribo/doc/gen-split-examples-mk similarity index 100% copy from milena/doc/gen-split-examples-mk copy to scribo/doc/gen-split-examples-mk diff --git a/milena/doc/gen-split-outputs-mk b/scribo/doc/gen-split-outputs-mk similarity index 100% copy from milena/doc/gen-split-outputs-mk copy to scribo/doc/gen-split-outputs-mk diff --git a/milena/doc/graphicx.hva b/scribo/doc/graphicx.hva similarity index 100% copy from milena/doc/graphicx.hva copy to scribo/doc/graphicx.hva diff --git a/scribo/doc/outputs.mk b/scribo/doc/outputs.mk new file mode 100644 index 0000000..09a1efd --- /dev/null +++ b/scribo/doc/outputs.mk @@ -0,0 +1,4 @@ +## Generated by gen-make-variable. Do not edit by hand. + +OUTPUTS = \ + $(srcdir)/outputs/dummy.txt diff --git a/milena/doc/outputs/accu-right-instantiation.txt b/scribo/doc/outputs/dummy.txt similarity index 100% copy from milena/doc/outputs/accu-right-instantiation.txt copy to scribo/doc/outputs/dummy.txt diff --git a/milena/doc/outputs/accu-right-instantiation.txt b/scribo/doc/programs-examples.mk similarity index 100% copy from milena/doc/outputs/accu-right-instantiation.txt copy to scribo/doc/programs-examples.mk diff --git a/scribo/doc/scribo.qhcp b/scribo/doc/scribo.qhcp new file mode 100644 index 0000000..77269b5 --- /dev/null +++ b/scribo/doc/scribo.qhcp @@ -0,0 +1,11 @@ +<?xml version="1.0" encoding="UTF-8"?> +<QHelpCollectionProject version="1.0"> + <assistant> + <startPage>qthelp://fr.epita.lrde.olena/scribo-2.0/index.html</startPage> + </assistant> + <docFiles> + <register> + <file>user-refman/html/scribo.qch</file> + </register> + </docFiles> +</QHelpCollectionProject> \ No newline at end of file diff --git a/milena/doc/milena.sty b/scribo/doc/scribo.sty similarity index 100% copy from milena/doc/milena.sty copy to scribo/doc/scribo.sty diff --git a/milena/doc/outputs/accu-right-instantiation.txt b/scribo/doc/split-examples.mk similarity index 100% copy from milena/doc/outputs/accu-right-instantiation.txt copy to scribo/doc/split-examples.mk diff --git a/milena/doc/outputs/accu-right-instantiation.txt b/scribo/doc/split-outputs.mk similarity index 100% copy from milena/doc/outputs/accu-right-instantiation.txt copy to scribo/doc/split-outputs.mk diff --git a/milena/doc/tools/todoxygen.sh b/scribo/doc/tools/todoxygen.sh similarity index 100% copy from milena/doc/tools/todoxygen.sh copy to scribo/doc/tools/todoxygen.sh diff --git a/milena/doc/outputs/accu-right-instantiation.txt b/scribo/doc/tutorial.tex similarity index 100% copy from milena/doc/outputs/accu-right-instantiation.txt copy to scribo/doc/tutorial.tex -- 1.7.2.5

1 0

olena-2.0-12-g769726b Move Otsu's threshold computation in a separate routine.
by Guillaume Lazzara 29 Nov '11

29 Nov '11

* scribo/binarization/otsu.hh, * scribo/binarization/otsu_threshold.hh: Move threshold computation in a separate routine. --- scribo/ChangeLog | 8 +++ scribo/scribo/binarization/otsu.hh | 56 +------------------- .../binarization/{otsu.hh => otsu_threshold.hh} | 31 +++++------ 3 files changed, 23 insertions(+), 72 deletions(-) copy scribo/scribo/binarization/{otsu.hh => otsu_threshold.hh} (84%) diff --git a/scribo/ChangeLog b/scribo/ChangeLog index 0923b28..6381a60 100644 --- a/scribo/ChangeLog +++ b/scribo/ChangeLog @@ -1,5 +1,13 @@ 2011-10-17 Guillaume Lazzara <z(a)lrde.epita.fr> + Move Otsu's threshold computation in a separate routine. + + * scribo/binarization/otsu.hh, + * scribo/binarization/otsu_threshold.hh: Move threshold + computation in a separate routine. + +2011-10-17 Guillaume Lazzara <z(a)lrde.epita.fr> + Add Niblack's binarization algorithm. * scribo/binarization/all.hh: Update includes. diff --git a/scribo/scribo/binarization/otsu.hh b/scribo/scribo/binarization/otsu.hh index c96a207..6b9d492 100644 --- a/scribo/scribo/binarization/otsu.hh +++ b/scribo/scribo/binarization/otsu.hh @@ -27,12 +27,8 @@ # define SCRIBO_BINARIZATION_OTSU_HH # include <mln/core/concept/image.hh> -# include <mln/util/array.hh> -# include <mln/geom/nsites.hh> -# include <mln/geom/ncols.hh> -# include <mln/geom/nrows.hh> -# include <mln/histo/compute.hh> +# include <scribo/binarization/otsu_threshold.hh> # include <scribo/binarization/global_threshold.hh> namespace scribo @@ -72,55 +68,7 @@ namespace scribo mlc_is_a(mln_value(I), value::Scalar)::check(); // FIXME: Check that input value is gray level. - mln_value(I) maxval = mln_max(mln_value(I)); - unsigned nsites = geom::nsites(input); - - /* Histogram generation */ - histo::array<mln_value(I)> hist = mln::histo::compute(input); - - - /* calculation of probability density */ - util::array<double> pdf(hist.nvalues()); //probability distribution - for(int i = 0; i< maxval; ++i) - pdf[i] = (double)hist[i] / nsites; - - - util::array<double> cdf(hist.nvalues()); //cumulative probability distribution - util::array<double> myu(hist.nvalues()); // mean value for separation - - /* cdf & myu generation */ - cdf[0] = pdf[0]; - myu[0] = 0.0; /* 0.0 times prob[0] equals zero */ - - for(int i = 1; i < maxval; ++i) - { - cdf[i] = cdf[i-1] + pdf[i]; - myu[i] = myu[i-1] + i*pdf[i]; - } - - /* sigma maximization - sigma stands for inter-class variance - and determines optimal threshold value */ - int threshold = 0; - double max_sigma = 0.0; - util::array<double> sigma(hist.nvalues()); // inter-class variance - - for(int i = 0; i < maxval - 1; ++i) - { - if(cdf[i] != 0.0 && cdf[i] != 1.0) - { - double p1p2 = cdf[i] * (1.0 - cdf[i]); - double mu1mu2diff = myu[maxval - 1] * cdf[i] - myu[i]; - sigma[i] = mu1mu2diff * mu1mu2diff / p1p2; - } - else - sigma[i] = 0.0; - if(sigma[i] > max_sigma) - { - max_sigma = sigma[i]; - threshold = i; - } - } + mln_value(I) threshold = otsu_threshold(input); // Computing final result. mln_ch_value(I,bool) output = global_threshold(input, threshold); diff --git a/scribo/scribo/binarization/otsu.hh b/scribo/scribo/binarization/otsu_threshold.hh similarity index 84% copy from scribo/scribo/binarization/otsu.hh copy to scribo/scribo/binarization/otsu_threshold.hh index c96a207..ab663d0 100644 --- a/scribo/scribo/binarization/otsu.hh +++ b/scribo/scribo/binarization/otsu_threshold.hh @@ -23,8 +23,8 @@ // exception does not however invalidate any other reasons why the // executable file might be covered by the GNU General Public License. -#ifndef SCRIBO_BINARIZATION_OTSU_HH -# define SCRIBO_BINARIZATION_OTSU_HH +#ifndef SCRIBO_BINARIZATION_OTSU_THRESHOLD_HH +# define SCRIBO_BINARIZATION_OTSU_THRESHOLD_HH # include <mln/core/concept/image.hh> # include <mln/util/array.hh> @@ -33,8 +33,6 @@ # include <mln/geom/nrows.hh> # include <mln/histo/compute.hh> -# include <scribo/binarization/global_threshold.hh> - namespace scribo { @@ -43,29 +41,28 @@ namespace scribo using namespace mln; - /*! An implementation of Otsu's binarization algorithm. + /*! Compute a global binarization threshold using Otsu's algorithm. It is based on Ocropus's implementation. http://code.google.com/p/ocropus/ \param[in] input A gray-scale image. - \return A binary image. True for foreground, False for - background. + \return A global threshold value. */ template <typename I> - mln_ch_value(I,bool) - otsu(const Image& input); + mln_value(I) + otsu_threshold(const Image& input); # ifndef MLN_INCLUDE_ONLY template <typename I> - mln_ch_value(I,bool) - otsu(const Image& input_) + mln_value(I) + otsu_threshold(const Image& input_) { - trace::entering("scribo::binarization::otsu"); + trace::entering("scribo::binarization::otsu_threshold"); const I& input = exact(input_); mln_precondition(input.is_valid()); @@ -101,7 +98,7 @@ namespace scribo /* sigma maximization sigma stands for inter-class variance and determines optimal threshold value */ - int threshold = 0; + mln_value(I) threshold = literal::zero; double max_sigma = 0.0; util::array<double> sigma(hist.nvalues()); // inter-class variance @@ -122,10 +119,8 @@ namespace scribo } } - // Computing final result. - mln_ch_value(I,bool) output = global_threshold(input, threshold); - - return output; + trace::exiting("scribo::binarization::otsu_threshold"); + return threshold; } # endif // ! MLN_INCLUDE_ONLY @@ -134,4 +129,4 @@ namespace scribo } // end of namespace scribo -#endif // ! SCRIBO_BINARIZATION_OTSU_HH +#endif // ! SCRIBO_BINARIZATION_OTSU_THRESHOLD_HH -- 1.7.2.5

1 0

olena-2.0-11-ge300aac Add Niblack's binarization algorithm.
by Guillaume Lazzara 29 Nov '11

29 Nov '11

* scribo/binarization/all.hh: Update includes. * scribo/binarization/internal/compute_local_threshold.hh, * scribo/binarization/internal/compute_sauvola_threshold.hh, * scribo/binarization/internal/first_pass_functor.hh, * scribo/binarization/internal/local_threshold_debug.hh, * scribo/binarization/internal/sauvola_debug.hh, * scribo/binarization/internal/sauvola_formula.hh, * scribo/binarization/sauvola.hh, * scribo/binarization/sauvola_ms.hh, * scribo/binarization/sauvola_threshold.hh, * scribo/binarization/sauvola_threshold_image.hh: Revamp code in order to share some parts with Niblack's algorithm. * scribo/binarization/internal/niblack_formula.hh, * scribo/binarization/niblack.hh, * scribo/binarization/niblack_threshold.hh: New. * src/binarization/Makefile.am * tests/binarization/Makefile.am: Add new targets. * src/binarization/niblack.cc: New tool. * tests/binarization/niblack.cc: New test. * tests/binarization/niblack.ref.pbm: New test data. --- scribo/ChangeLog | 31 ++ scribo/scribo/binarization/all.hh | 5 +- .../internal/compute_local_threshold.hh | 224 +++++++++++++++ .../internal/compute_sauvola_threshold.hh | 285 ------------------ .../binarization/internal/first_pass_functor.hh | 24 +- .../binarization/internal/local_threshold_debug.hh | 88 ++++++ .../binarization/internal/niblack_formula.hh | 105 +++++++ .../scribo/binarization/internal/sauvola_debug.hh | 87 ------ .../binarization/internal/sauvola_formula.hh | 121 ++++++++ scribo/scribo/binarization/niblack.hh | 218 ++++++++++++++ scribo/scribo/binarization/niblack_threshold.hh | 299 +++++++++++++++++++ scribo/scribo/binarization/sauvola.hh | 24 +- scribo/scribo/binarization/sauvola_ms.hh | 21 +- scribo/scribo/binarization/sauvola_threshold.hh | 296 +++++++++++++++++++ .../scribo/binarization/sauvola_threshold_image.hh | 301 -------------------- scribo/src/binarization/Makefile.am | 12 +- scribo/src/binarization/niblack.cc | 106 +++++++ .../binarization/pgm_sauvola_threshold_image.cc | 7 +- scribo/tests/binarization/Makefile.am | 3 + scribo/tests/binarization/niblack.cc | 52 ++++ scribo/tests/binarization/niblack.ref.pbm | Bin 0 -> 16498 bytes 21 files changed, 1597 insertions(+), 712 deletions(-) create mode 100644 scribo/scribo/binarization/internal/compute_local_threshold.hh delete mode 100644 scribo/scribo/binarization/internal/compute_sauvola_threshold.hh create mode 100644 scribo/scribo/binarization/internal/local_threshold_debug.hh create mode 100644 scribo/scribo/binarization/internal/niblack_formula.hh delete mode 100644 scribo/scribo/binarization/internal/sauvola_debug.hh create mode 100644 scribo/scribo/binarization/internal/sauvola_formula.hh create mode 100644 scribo/scribo/binarization/niblack.hh create mode 100644 scribo/scribo/binarization/niblack_threshold.hh create mode 100644 scribo/scribo/binarization/sauvola_threshold.hh delete mode 100644 scribo/scribo/binarization/sauvola_threshold_image.hh create mode 100644 scribo/src/binarization/niblack.cc create mode 100644 scribo/tests/binarization/niblack.cc create mode 100644 scribo/tests/binarization/niblack.ref.pbm diff --git a/scribo/ChangeLog b/scribo/ChangeLog index 5aa2a06..0923b28 100644 --- a/scribo/ChangeLog +++ b/scribo/ChangeLog @@ -1,3 +1,34 @@ +2011-10-17 Guillaume Lazzara <z(a)lrde.epita.fr> + + Add Niblack's binarization algorithm. + + * scribo/binarization/all.hh: Update includes. + + * scribo/binarization/internal/compute_local_threshold.hh, + * scribo/binarization/internal/compute_sauvola_threshold.hh, + * scribo/binarization/internal/first_pass_functor.hh, + * scribo/binarization/internal/local_threshold_debug.hh, + * scribo/binarization/internal/sauvola_debug.hh, + * scribo/binarization/internal/sauvola_formula.hh, + * scribo/binarization/sauvola.hh, + * scribo/binarization/sauvola_ms.hh, + * scribo/binarization/sauvola_threshold.hh, + * scribo/binarization/sauvola_threshold_image.hh: Revamp code in + order to share some parts with Niblack's algorithm. + + * scribo/binarization/internal/niblack_formula.hh, + * scribo/binarization/niblack.hh, + * scribo/binarization/niblack_threshold.hh: New. + + * src/binarization/Makefile.am + * tests/binarization/Makefile.am: Add new targets. + + * src/binarization/niblack.cc: New tool. + + * tests/binarization/niblack.cc: New test. + + * tests/binarization/niblack.ref.pbm: New test data. + 2011-10-14 Guillaume Lazzara <z(a)lrde.epita.fr> Add a new tool for global thresholding. diff --git a/scribo/scribo/binarization/all.hh b/scribo/scribo/binarization/all.hh index 6f40505..5530861 100644 --- a/scribo/scribo/binarization/all.hh +++ b/scribo/scribo/binarization/all.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2010 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2010, 2011 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -50,6 +51,6 @@ namespace scribo # include <scribo/binarization/sauvola.hh> # include <scribo/binarization/sauvola_ms.hh> # include <scribo/binarization/sauvola_ms_split.hh> -# include <scribo/binarization/sauvola_threshold_image.hh> +# include <scribo/binarization/sauvola_threshold.hh> #endif // ! SCRIBO_BINARIZATION_ALL_HH diff --git a/scribo/scribo/binarization/internal/compute_local_threshold.hh b/scribo/scribo/binarization/internal/compute_local_threshold.hh new file mode 100644 index 0000000..147ef0f --- /dev/null +++ b/scribo/scribo/binarization/internal/compute_local_threshold.hh @@ -0,0 +1,224 @@ +// Copyright (C) 2010, 2011 EPITA Research and Development Laboratory +// (LRDE) +// +// This file is part of Olena. +// +// Olena is free software: you can redistribute it and/or modify it under +// the terms of the GNU General Public License as published by the Free +// Software Foundation, version 2 of the License. +// +// Olena is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with Olena. If not, see <http://www.gnu.org/licenses/>. +// +// As a special exception, you may use this file as part of a free +// software project without restriction. Specifically, if other files +// instantiate templates or use macros or inline functions from this +// file, or you compile this file and link it with other files to produce +// an executable, this file does not by itself cause the resulting +// executable to be covered by the GNU General Public License. This +// exception does not however invalidate any other reasons why the +// executable file might be covered by the GNU General Public License. + +#ifndef SCRIBO_BINARIZATION_INTERNAL_COMPUTE_LOCAL_THRESHOLD_HH +# define SCRIBO_BINARIZATION_INTERNAL_COMPUTE_LOCAL_THRESHOLD_HH + + +/// \file +/// +/// \brief Compute a threshold with Local's binarization formula. + +# include <algorithm> +# include <cmath> + +# include <mln/core/image/image2d.hh> +# include <mln/value/int_u8.hh> + +# include <scribo/binarization/internal/local_threshold_debug.hh> + + + +// extern mln::image2d<double> skewness; + +namespace scribo +{ + + namespace binarization + { + + namespace internal + { + + using namespace mln; + + + /*! \brief Compute a point wise threshold according to a local + binarization formula. + + \param[in] p A site. + \param[in] simple An integral image of mean values. + \param[in] squared An integral image of squared mean values. + \param[in] win_width Window width. + \param[in] k Control 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 + for grayscale documents). + \param[in] formula The function to use to compute the local + threshold. + + \return A threshold. + */ + template <typename P, typename J, typename F> + double + compute_local_threshold(const P& p, + const J& simple, + const J& squared, + int win_width, double K, double R, + const F& formula); + + + +# ifndef MLN_INCLUDE_ONLY + + + template <typename P, typename J, typename F> + double + compute_local_threshold(const P& p, + const J& simple, + const J& squared, + int win_width, double K, double R, + const F& formula) + { + mln_precondition(simple.nrows() == squared.nrows()); + mln_precondition(simple.ncols() == squared.ncols()); + + // Window half width. + int w_2 = win_width >> 1; + + int row_min = std::max(0, p.row() - w_2 - 1); + int col_min = std::max(0, p.col() - w_2 - 1); + + int row_max = std::min(static_cast<int>(simple.nrows()) - 1, + p.row() + w_2); + int col_max = std::min(static_cast<int>(simple.ncols()) - 1, + p.col() + w_2); + + + double wh = (row_max - row_min) * (col_max - col_min); + + // Mean. + double m_x_y_tmp = (simple.at_(row_max, col_max) + + simple.at_(row_min, col_min) + - simple.at_(row_max, col_min) + - simple.at_(row_min, col_max)); + + double m_x_y = m_x_y_tmp / wh; + +# ifdef SCRIBO_LOCAL_THRESHOLD_DEBUG + // Store local mean + debug_mean(p) = m_x_y * mean_debug_factor; +# endif // ! SCRIBO_LOCAL_THRESHOLD_DEBUG + + // Standard deviation. + double s_x_y_tmp = (squared.at_(row_max, col_max) + + squared.at_(row_min, col_min) + - squared.at_(row_max, col_min) + - squared.at_(row_min, col_max)); + + double s_x_y = std::sqrt((s_x_y_tmp - (m_x_y_tmp * m_x_y_tmp) / wh) / (wh - 1.f)); + +# ifdef SCRIBO_LOCAL_THRESHOLD_DEBUG + // Store local standard deviation + debug_stddev(p) = s_x_y * stddev_debug_factor; +# endif // ! SCRIBO_LOCAL_THRESHOLD_DEBUG + + // Thresholding. + // skewness_ = skewness(p); + // b = (p == point2d(5,5)); + double t_x_y = formula(m_x_y, s_x_y, K, R); + +# ifdef SCRIBO_LOCAL_THRESHOLD_DEBUG + double alpha = K * (1 - s_x_y / R); + debug_alpham(p) = alpha * m_x_y * alpham_debug_factor; + debug_alphacond(p) = (s_x_y < (alpha * m_x_y / 2.)); +# endif // !SCRIBO_LOCAL_THRESHOLD_DEBUG + + return t_x_y; + } + + + template <typename P, typename J, typename F> + double + compute_local_threshold_single_image(const P& p, + const J& integral, + int win_width, + double K, double R, + const F& formula) + { + // Window half width. + int w_2 = win_width >> 1; + + int row_min = std::max(0, p.row() - w_2); + int col_min = std::max(0, p.col() - w_2); + + int row_max = std::min(static_cast<int>(integral.nrows()) - 1, + p.row() + w_2); + int col_max = std::min(static_cast<int>(integral.ncols()) - 1, + p.col() + w_2); + + + double wh = (row_max - row_min + 1) * (col_max - col_min + 1); + + // Mean. + double m_x_y_tmp = (integral.at_(row_max, col_max).first() + + integral.at_(row_min, col_min).first() + - integral.at_(row_max, col_min).first() + - integral.at_(row_min, col_max).first()); + + double m_x_y = m_x_y_tmp / wh; + +# ifdef SCRIBO_LOCAL_THRESHOLD_DEBUG + // Store local mean + debug_mean(p) = m_x_y * mean_debug_factor; +# endif // ! SCRIBO_LOCAL_THRESHOLD_DEBUG + + // Standard deviation. + double s_x_y_tmp = (integral.at_(row_max, col_max).second() + + integral.at_(row_min, col_min).second() + - integral.at_(row_max, col_min).second() + - integral.at_(row_min, col_max).second()); + + double s_x_y = std::sqrt((s_x_y_tmp - (m_x_y_tmp * m_x_y_tmp) / wh) / (wh - 1.f)); + +# ifdef SCRIBO_LOCAL_THRESHOLD_DEBUG + // Store local standard deviation + debug_stddev(p) = s_x_y * stddev_debug_factor; +# endif // !SCRIBO_LOCAL_THRESHOLD_DEBUG + + // Thresholding. + double t_x_y = formula(m_x_y, s_x_y, K, R); + +# ifdef SCRIBO_LOCAL_THRESHOLD_DEBUG + double alpha = K * (1 - s_x_y / R); + debug_alpham(p) = alpha * m_x_y * alpham_debug_factor; + debug_alphacond(p) = (s_x_y < (alpha * m_x_y / 2.)); +# endif // !SCRIBO_LOCAL_THRESHOLD_DEBUG + + return t_x_y; + } + + +#endif // ! MLN_INCLUDE_ONLY + + } // end of namespace scribo::binarization::internal + + } // end of namespace scribo::binarization + +} // end of namespace scribo + +#endif // ! SCRIBO_BINARIZATION_INTERNAL_COMPUTE_LOCAL_THRESHOLD_HH diff --git a/scribo/scribo/binarization/internal/compute_sauvola_threshold.hh b/scribo/scribo/binarization/internal/compute_sauvola_threshold.hh deleted file mode 100644 index d3ca07f..0000000 --- a/scribo/scribo/binarization/internal/compute_sauvola_threshold.hh +++ /dev/null @@ -1,285 +0,0 @@ -// Copyright (C) 2010 EPITA Research and Development Laboratory (LRDE) -// -// This file is part of Olena. -// -// Olena is free software: you can redistribute it and/or modify it under -// the terms of the GNU General Public License as published by the Free -// Software Foundation, version 2 of the License. -// -// Olena is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -// General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with Olena. If not, see <http://www.gnu.org/licenses/>. -// -// As a special exception, you may use this file as part of a free -// software project without restriction. Specifically, if other files -// instantiate templates or use macros or inline functions from this -// file, or you compile this file and link it with other files to produce -// an executable, this file does not by itself cause the resulting -// executable to be covered by the GNU General Public License. This -// exception does not however invalidate any other reasons why the -// executable file might be covered by the GNU General Public License. - -#ifndef SCRIBO_BINARIZATION_INTERNAL_COMPUTE_SAUVOLA_THRESHOLD_HH -# define SCRIBO_BINARIZATION_INTERNAL_COMPUTE_SAUVOLA_THRESHOLD_HH - - -/// \file -/// -/// \brief Compute a threshold with Sauvola's binarization formula. - -# include <algorithm> -# include <cmath> - -# include <mln/core/image/image2d.hh> -# include <mln/value/int_u8.hh> - -# include <scribo/binarization/internal/sauvola_debug.hh> - - -// Setup default Sauvola's formulae parameters values. -// These macros may be used in other variant of Sauvola's algorithm. -// -// Values are set according to the following reference: "Automatic -// Evaluation of Document Binarization Results", Badekas and al, 2005 -// -// Badekas et al. said 0.34 was best. -# define SCRIBO_DEFAULT_SAUVOLA_K 0.34 -// -// 128 is best for grayscale documents. -# define SCRIBO_DEFAULT_SAUVOLA_R 128 - - -namespace scribo -{ - - namespace binarization - { - - namespace internal - { - - using namespace mln; - - - /*! \brief Compute a point wise threshold according Sauvola's - binarization. - - \param[in] p A site. - \param[in] simple An integral image of mean values. - \param[in] squared An integral image of squared mean values. - \param[in] win_width Window width. - \param[in] k Control 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 - for grayscale documents). - - \return A threshold. - */ - template <typename P, typename J> - double - compute_sauvola_threshold(const P& p, - const J& simple, - const J& squared, - int win_width, double K, double R); - - /// \overload - /// K is set to 0.34 and R to 128. - // - template <typename P, typename J> - double - compute_sauvola_threshold(const P& p, - const J& simple, - const J& squared, - int win_width); - - - -# ifndef MLN_INCLUDE_ONLY - - - - /*! \brief compute Sauvola's threshold applying directly the formula. - - \param[in] m_x_y Mean value. - \param[in] s_x_y Standard deviation. - \param[in] k Control 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 - for grayscale documents). - - \return A threshold. - */ - inline - double - sauvola_threshold_formula(const double m_x_y, const double s_x_y, - const double K, const double R) - { - return m_x_y * (1.0 + K * ((s_x_y / R) - 1.0)); - } - - /// \overload - /// K is set to 0.34 and R to 128. - // - inline - double - sauvola_threshold_formula(double m_x_y, double s_x_y) - { - return sauvola_threshold_formula(m_x_y, s_x_y, - SCRIBO_DEFAULT_SAUVOLA_K, - SCRIBO_DEFAULT_SAUVOLA_R); - } - - - - template <typename P, typename J> - double - compute_sauvola_threshold(const P& p, - const J& simple, - const J& squared, - int win_width, double K, double R) - { - mln_precondition(simple.nrows() == squared.nrows()); - mln_precondition(simple.ncols() == squared.ncols()); - - // Window half width. - int w_2 = win_width >> 1; - - int row_min = std::max(0, p.row() - w_2 - 1); - int col_min = std::max(0, p.col() - w_2 - 1); - - int row_max = std::min(static_cast<int>(simple.nrows()) - 1, - p.row() + w_2); - int col_max = std::min(static_cast<int>(simple.ncols()) - 1, - p.col() + w_2); - - - double wh = (row_max - row_min) * (col_max - col_min); - - // Mean. - double m_x_y_tmp = (simple.at_(row_max, col_max) - + simple.at_(row_min, col_min) - - simple.at_(row_max, col_min) - - simple.at_(row_min, col_max)); - - double m_x_y = m_x_y_tmp / wh; - -# ifdef SCRIBO_SAUVOLA_DEBUG - // Store local mean - debug_mean(p) = m_x_y * mean_debug_factor; -# endif // ! SCRIBO_SAUVOLA_DEBUG - - // Standard deviation. - double s_x_y_tmp = (squared.at_(row_max, col_max) - + squared.at_(row_min, col_min) - - squared.at_(row_max, col_min) - - squared.at_(row_min, col_max)); - - double s_x_y = std::sqrt((s_x_y_tmp - (m_x_y_tmp * m_x_y_tmp) / wh) / (wh - 1.f)); - -# ifdef SCRIBO_SAUVOLA_DEBUG - // Store local standard deviation - debug_stddev(p) = s_x_y * stddev_debug_factor; -# endif // ! SCRIBO_SAUVOLA_DEBUG - - // Thresholding. - double t_x_y = sauvola_threshold_formula(m_x_y, s_x_y, K, R); - -# ifdef SCRIBO_SAUVOLA_DEBUG - double alpha = K * (1 - s_x_y / R); - debug_alpham(p) = alpha * m_x_y * alpham_debug_factor; - debug_alphacond(p) = (s_x_y < (alpha * m_x_y / 2.)); -# endif // !SCRIBO_SAUVOLA_DEBUG - - return t_x_y; - } - - - template <typename P, typename J> - double - compute_sauvola_threshold_single_image(const P& p, - const J& integral, - int win_width, - double K, double R) - { - // Window half width. - int w_2 = win_width >> 1; - - int row_min = std::max(0, p.row() - w_2); - int col_min = std::max(0, p.col() - w_2); - - int row_max = std::min(static_cast<int>(integral.nrows()) - 1, - p.row() + w_2); - int col_max = std::min(static_cast<int>(integral.ncols()) - 1, - p.col() + w_2); - - - double wh = (row_max - row_min + 1) * (col_max - col_min + 1); - - // Mean. - double m_x_y_tmp = (integral.at_(row_max, col_max).first() - + integral.at_(row_min, col_min).first() - - integral.at_(row_max, col_min).first() - - integral.at_(row_min, col_max).first()); - - double m_x_y = m_x_y_tmp / wh; - -# ifdef SCRIBO_SAUVOLA_DEBUG - // Store local mean - debug_mean(p) = m_x_y * mean_debug_factor; -# endif // ! SCRIBO_SAUVOLA_DEBUG - - // Standard deviation. - double s_x_y_tmp = (integral.at_(row_max, col_max).second() - + integral.at_(row_min, col_min).second() - - integral.at_(row_max, col_min).second() - - integral.at_(row_min, col_max).second()); - - double s_x_y = std::sqrt((s_x_y_tmp - (m_x_y_tmp * m_x_y_tmp) / wh) / (wh - 1.f)); - -# ifdef SCRIBO_SAUVOLA_DEBUG - // Store local standard deviation - debug_stddev(p) = s_x_y * stddev_debug_factor; -# endif // !SCRIBO_SAUVOLA_DEBUG - - // Thresholding. - double t_x_y = sauvola_threshold_formula(m_x_y, s_x_y, K, R); - -# ifdef SCRIBO_SAUVOLA_DEBUG - double alpha = K * (1 - s_x_y / R); - debug_alpham(p) = alpha * m_x_y * alpham_debug_factor; - debug_alphacond(p) = (s_x_y < (alpha * m_x_y / 2.)); -# endif // !SCRIBO_SAUVOLA_DEBUG - - return t_x_y; - } - - - - template <typename P, typename J> - double - compute_sauvola_threshold(const P& p, - const J& simple, - const J& squared, - int win_width) - { - return compute_sauvola_threshold(p, simple, squared, win_width, - SCRIBO_DEFAULT_SAUVOLA_K, - SCRIBO_DEFAULT_SAUVOLA_R); - } - - -#endif // ! MLN_INCLUDE_ONLY - - } // end of namespace scribo::binarization::internal - - } // end of namespace scribo::binarization - -} // end of namespace scribo - -#endif // ! SCRIBO_BINARIZATION_INTERNAL_COMPUTE_SAUVOLA_THRESHOLD_HH diff --git a/scribo/scribo/binarization/internal/first_pass_functor.hh b/scribo/scribo/binarization/internal/first_pass_functor.hh index 0b1a7ac..8da401b 100644 --- a/scribo/scribo/binarization/internal/first_pass_functor.hh +++ b/scribo/scribo/binarization/internal/first_pass_functor.hh @@ -37,7 +37,11 @@ # include <mln/value/int_u8.hh> # include <mln/data/fill.hh> -# include <scribo/binarization/sauvola_threshold_image.hh> +# include <scribo/binarization/internal/sauvola_formula.hh> + +# ifdef SCRIBO_LOCAL_THRESHOLD_DEBUG +# include <scribo/binarization/internal/local_threshold_debug.hh> +# endif // ! SCRIBO_LOCAL_THRESHOLD_DEBUG namespace scribo @@ -67,8 +71,11 @@ namespace scribo mln::util::array<int> dp; double K_; + double R_; + + sauvola_formula formula_; - first_pass_functor(const I& input, double K); + first_pass_functor(const I& input, double K, double R); void exec(double mean, double stddev); void finalize(); @@ -88,10 +95,11 @@ namespace scribo template <typename I> - first_pass_functor::first_pass_functor(const I& input, double K) + first_pass_functor::first_pass_functor(const I& input, double K, double R) : input(input), pxl(input), - K_(K) + K_(K), + R_(R) { res = 0; pxl.start(); @@ -100,10 +108,10 @@ namespace scribo initialize(parent, input); initialize(msk, input); -# ifdef SCRIBO_SAUVOLA_DEBUG +# ifdef SCRIBO_LOCAL_THRESHOLD_DEBUG initialize(debug_mean, input); initialize(debug_stddev, input); -# endif // ! SCRIBO_SAUVOLA_DEBUG +# endif // ! SCRIBO_LOCAL_THRESHOLD_DEBUG mln::extension::fill(msk, false); @@ -124,9 +132,7 @@ namespace scribo unsigned p = pxl.offset(); value::int_u8 t_p; - mln::convert::from_to(sauvola_threshold_formula(mean, stddev, - K_, - SCRIBO_DEFAULT_SAUVOLA_R), + mln::convert::from_to(formula_(mean, stddev, K_, R_), t_p); msk.element(p) = input.element(p) < t_p; diff --git a/scribo/scribo/binarization/internal/local_threshold_debug.hh b/scribo/scribo/binarization/internal/local_threshold_debug.hh new file mode 100644 index 0000000..a9da06c --- /dev/null +++ b/scribo/scribo/binarization/internal/local_threshold_debug.hh @@ -0,0 +1,88 @@ +// Copyright (C) 2010, 2011 EPITA Research and Development Laboratory +// (LRDE) +// +// This file is part of Olena. +// +// Olena is free software: you can redistribute it and/or modify it under +// the terms of the GNU General Public License as published by the Free +// Software Foundation, version 2 of the License. +// +// Olena is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with Olena. If not, see <http://www.gnu.org/licenses/>. +// +// As a special exception, you may use this file as part of a free +// software project without restriction. Specifically, if other files +// instantiate templates or use macros or inline functions from this +// file, or you compile this file and link it with other files to produce +// an executable, this file does not by itself cause the resulting +// executable to be covered by the GNU General Public License. This +// exception does not however invalidate any other reasons why the +// executable file might be covered by the GNU General Public License. + +#ifndef SCRIBO_BINARIZATION_INTERNAL_LOCAL_THRESHOLD_DEBUG_HH +# define SCRIBO_BINARIZATION_INTERNAL_LOCAL_THRESHOLD_DEBUG_HH + +/// \file +/// +/// \brief Declare all debug related variables for local based +/// algorithms. + + +/// FIXME: A struct may be a bit better... + + +# ifdef SCRIBO_LOCAL_THRESHOLD_DEBUG + +# ifndef MLN_INCLUDE_ONLY + + +namespace scribo +{ + + namespace binarization + { + + using namespace mln; + + namespace internal + { + + char* stddev_image_output = 0; + char* mean_image_output = 0; + char* threshold_image_output = 0; + + char* scale_image_output = 0; + + char* alpham_image_output = 0; + char* alphacond_image_output = 0; + + // Declare debug images. + image2d<double> debug_stddev; + image2d<double> debug_mean; + image2d<double> debug_threshold; + + image2d<double> debug_alpham; + image2d<bool> debug_alphacond; + + double mean_debug_factor = 1.0; + double stddev_debug_factor = 1.0; + double alpham_debug_factor = 2.0; + + } // end of namespace scribo::binarization::internal + + } // end of namespace scribo::binarization + +} // end of namespace scribo + + +# endif // ! MLN_INCLUDE_ONLY + +# endif // ! SCRIBO_LOCAL_THRESHOLD_DEBUG + + +#endif // ! SCRIBO_BINARIZATION_INTERNAL_LOCAL_THRESHOLD_DEBUG_HH diff --git a/scribo/scribo/binarization/internal/niblack_formula.hh b/scribo/scribo/binarization/internal/niblack_formula.hh new file mode 100644 index 0000000..54dbc9b --- /dev/null +++ b/scribo/scribo/binarization/internal/niblack_formula.hh @@ -0,0 +1,105 @@ +// Copyright (C) 2011 EPITA Research and Development Laboratory (LRDE) +// +// This file is part of Olena. +// +// Olena is free software: you can redistribute it and/or modify it under +// the terms of the GNU General Public License as published by the Free +// Software Foundation, version 2 of the License. +// +// Olena is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with Olena. If not, see <http://www.gnu.org/licenses/>. +// +// As a special exception, you may use this file as part of a free +// software project without restriction. Specifically, if other files +// instantiate templates or use macros or inline functions from this +// file, or you compile this file and link it with other files to produce +// an executable, this file does not by itself cause the resulting +// executable to be covered by the GNU General Public License. This +// exception does not however invalidate any other reasons why the +// executable file might be covered by the GNU General Public License. + +#ifndef SCRIBO_BINARIZATION_INTERNAL_NIBLACK_FORMULA_HH +# define SCRIBO_BINARIZATION_INTERNAL_NIBLACK_FORMULA_HH + + +/// \file +/// +/// \brief Routines computing a threshold using Niblack's binarization +/// formula. + +// \fixme Having an unused parameter to fulfill the required interface +// may not be the best solution... + +// Setup default Niblack's formula parameters values. +# define SCRIBO_DEFAULT_NIBLACK_K -0.2 + + + +namespace scribo +{ + + namespace binarization + { + + namespace internal + { + + struct niblack_formula + { + + /*! \brief compute a threshold using Niblack's formula. + + \param[in] m_x_y Mean value. + \param[in] s_x_y Standard deviation. + \param[in] k Control 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 + for grayscale documents). Unused in this formula. + + \return A threshold. + */ + double operator()(const double m_x_y, const double s_x_y, + const double K, const double R) const; + + /*! + \overload K = 0.34. + */ + double operator()(const double m_x_y, const double s_x_y) const; + + }; + + +# ifndef MLN_INCLUDE_ONLY + + inline + double + niblack_formula::operator()(const double m_x_y, const double s_x_y, + const double K, const double /*R*/) const + { + return m_x_y + K * s_x_y; + } + + inline + double + niblack_formula::operator()(const double m_x_y, const double s_x_y) const + { + return (*this)(m_x_y, s_x_y, + SCRIBO_DEFAULT_NIBLACK_K, 128); + } + + +# endif // ! MLN_INCLUDE_ONLY + + } // end of namespace scribo::binarization::internal + + } // end of namespace scribo::binarization + +} // end of namespace scribo + +#endif // ! SCRIBO_BINARIZATION_INTERNAL_NIBLACK_FORMULA_HH diff --git a/scribo/scribo/binarization/internal/sauvola_debug.hh b/scribo/scribo/binarization/internal/sauvola_debug.hh deleted file mode 100644 index 0f8ccf0..0000000 --- a/scribo/scribo/binarization/internal/sauvola_debug.hh +++ /dev/null @@ -1,87 +0,0 @@ -// Copyright (C) 2010 EPITA Research and Development Laboratory (LRDE) -// -// This file is part of Olena. -// -// Olena is free software: you can redistribute it and/or modify it under -// the terms of the GNU General Public License as published by the Free -// Software Foundation, version 2 of the License. -// -// Olena is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -// General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with Olena. If not, see <http://www.gnu.org/licenses/>. -// -// As a special exception, you may use this file as part of a free -// software project without restriction. Specifically, if other files -// instantiate templates or use macros or inline functions from this -// file, or you compile this file and link it with other files to produce -// an executable, this file does not by itself cause the resulting -// executable to be covered by the GNU General Public License. This -// exception does not however invalidate any other reasons why the -// executable file might be covered by the GNU General Public License. - -#ifndef SCRIBO_BINARIZATION_INTERNAL_SAUVOLA_DEBUG_HH -# define SCRIBO_BINARIZATION_INTERNAL_SAUVOLA_DEBUG_HH - -/// \file -/// -/// \brief Declare all debug related variables for Sauvola* -/// algorithms. - - -/// FIXME: A struct may be a bit better... - - -# ifdef SCRIBO_SAUVOLA_DEBUG - -# ifndef MLN_INCLUDE_ONLY - - -namespace scribo -{ - - namespace binarization - { - - using namespace mln; - - namespace internal - { - - char* stddev_image_output = 0; - char* mean_image_output = 0; - char* threshold_image_output = 0; - - char* scale_image_output = 0; - - char* alpham_image_output = 0; - char* alphacond_image_output = 0; - - // Declare debug images. - image2d<double> debug_stddev; - image2d<double> debug_mean; - image2d<double> debug_threshold; - - image2d<double> debug_alpham; - image2d<bool> debug_alphacond; - - double mean_debug_factor = 1.0; - double stddev_debug_factor = 1.0; - double alpham_debug_factor = 2.0; - - } // end of namespace scribo::binarization::internal - - } // end of namespace scribo::binarization - -} // end of namespace scribo - - -# endif // ! MLN_INCLUDE_ONLY - -# endif // ! SCRIBO_SAUVOLA_DEBUG - - -#endif // ! SCRIBO_BINARIZATION_INTERNAL_SAUVOLA_DEBUG_HH diff --git a/scribo/scribo/binarization/internal/sauvola_formula.hh b/scribo/scribo/binarization/internal/sauvola_formula.hh new file mode 100644 index 0000000..adbef13 --- /dev/null +++ b/scribo/scribo/binarization/internal/sauvola_formula.hh @@ -0,0 +1,121 @@ +// Copyright (C) 2011 EPITA Research and Development Laboratory (LRDE) +// +// This file is part of Olena. +// +// Olena is free software: you can redistribute it and/or modify it under +// the terms of the GNU General Public License as published by the Free +// Software Foundation, version 2 of the License. +// +// Olena is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with Olena. If not, see <http://www.gnu.org/licenses/>. +// +// As a special exception, you may use this file as part of a free +// software project without restriction. Specifically, if other files +// instantiate templates or use macros or inline functions from this +// file, or you compile this file and link it with other files to produce +// an executable, this file does not by itself cause the resulting +// executable to be covered by the GNU General Public License. This +// exception does not however invalidate any other reasons why the +// executable file might be covered by the GNU General Public License. + +#ifndef SCRIBO_BINARIZATION_INTERNAL_SAUVOLA_FORMULA_HH +# define SCRIBO_BINARIZATION_INTERNAL_SAUVOLA_FORMULA_HH + + +/// \file +/// +/// \brief Routines computing a threshold using Sauvola's binarization +/// formula. + + +// Setup default Sauvola's formula parameters values. +// These macros may be used in other variant of Sauvola's algorithms. +// +// Values are set according to the following reference: "Automatic +// Evaluation of Document Binarization Results", Badekas and al, 2005 +// +// Badekas et al. said 0.34 was best for Sauvola. +# define SCRIBO_DEFAULT_SAUVOLA_K 0.34 +// +// 128 is best for grayscale documents. +# define SCRIBO_DEFAULT_SAUVOLA_R 128 + + +namespace scribo +{ + + namespace binarization + { + + namespace internal + { + + struct sauvola_formula + { + + /*! \brief Compute a threshold using Sauvola's formula. + + \param[in] m_x_y Mean value. + \param[in] s_x_y Standard deviation. + \param[in] k Control 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 + for grayscale documents). + + \return A threshold. + */ + double operator()(const double m_x_y, const double s_x_y, + const double K, const double R) const; + + /*! + \overload K = 0.34 and R = 128. + */ + double operator()(const double m_x_y, const double s_x_y) const; + + }; + + +# ifndef MLN_INCLUDE_ONLY + + // bool b; + // double skewness_; + + inline + double + sauvola_formula::operator()(const double m_x_y, const double s_x_y, + const double K, const double R) const + { + // if (b) + // std::cout << skewness_ << " - " << (K * -1 * skewness_) << std::endl; + // volatile double new_t = ((skewness_ < 0) ? -skewness_ : 1 * m_x_y * (1.0 + K * ((s_x_y / R) - 1.0))); + // volatile double old_t = (m_x_y * (1.0 + K * ((s_x_y / R) - 1.0))); + // if (skewness_ > 0) + // if (new_t != old_t) + // std::cout << skewness_ << " - " << new_t << " vs " << old_t << std::endl; + + return m_x_y * (1.0 + K * ((s_x_y / R) - 1.0)); + } + + inline + double + sauvola_formula::operator()(const double m_x_y, const double s_x_y) const + { + return (*this)(m_x_y, s_x_y, + SCRIBO_DEFAULT_SAUVOLA_K, SCRIBO_DEFAULT_SAUVOLA_R); + } + +# endif // ! MLN_INCLUDE_ONLY + + } // end of namespace scribo::binarization::internal + + } // end of namespace scribo::binarization + +} // end of namespace scribo + +#endif // ! SCRIBO_BINARIZATION_INTERNAL_SAUVOLA_FORMULA_HH diff --git a/scribo/scribo/binarization/niblack.hh b/scribo/scribo/binarization/niblack.hh new file mode 100644 index 0000000..e66e7b4 --- /dev/null +++ b/scribo/scribo/binarization/niblack.hh @@ -0,0 +1,218 @@ +// Copyright (C) 2011 EPITA Research and Development Laboratory (LRDE) +// +// This file is part of Olena. +// +// Olena is free software: you can redistribute it and/or modify it under +// the terms of the GNU General Public License as published by the Free +// Software Foundation, version 2 of the License. +// +// Olena is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with Olena. If not, see <http://www.gnu.org/licenses/>. +// +// As a special exception, you may use this file as part of a free +// software project without restriction. Specifically, if other files +// instantiate templates or use macros or inline functions from this +// file, or you compile this file and link it with other files to produce +// an executable, this file does not by itself cause the resulting +// executable to be covered by the GNU General Public License. This +// exception does not however invalidate any other reasons why the +// executable file might be covered by the GNU General Public License. + +#ifndef SCRIBO_BINARIZATION_NIBLACK_HH +# define SCRIBO_BINARIZATION_NIBLACK_HH + +/// \file +/// +/// + +# include <mln/core/concept/image.hh> +# include <mln/data/transform.hh> +# include <mln/value/int_u8.hh> + +# include <scribo/binarization/niblack_threshold.hh> +# include <scribo/binarization/local_threshold.hh> +# include <scribo/binarization/internal/local_threshold_debug.hh> + +# ifdef SCRIBO_LOCAL_THRESHOLD_DEBUG +# include <mln/io/pgm/save.hh> +# include <mln/io/pbm/save.hh> +# include <mln/data/saturate.hh> +# endif // ! SCRIBO_LOCAL_THRESHOLD_DEBUG + +namespace scribo +{ + + namespace binarization + { + + using namespace mln; + + + /*! \brief Convert an image into a binary image. + + \input[in] input An image. + \input[in] window_size The window size. + \input[in] K Niblack's formulae constant. + + \return A binary image. + + */ + template <typename I> + mln_ch_value(I, bool) + niblack(const Image& input, unsigned window_size, double K); + + + + /*! \brief Convert an image into a binary image. + + Niblack's formulae constant K is set to 0.34. + + \input[in] input An image. + \input[in] window_size The window size. + + \return A binary image. + + */ + template <typename I> + mln_ch_value(I, bool) + niblack(const Image& input, unsigned window_size); + + + /// \overload + /// The window size is set to 11. + // + template <typename I> + mln_ch_value(I, bool) + niblack(const Image& input); + + +# ifndef MLN_INCLUDE_ONLY + + + // Implementations. + + namespace impl + { + + namespace generic + { + + template <typename I> + mln_ch_value(I, bool) + niblack(const Image& input, unsigned window_size, double K) + { + trace::entering("scribo::binarization::impl::generic::niblack"); + mln_precondition(exact(input).is_valid()); + + mln_ch_value(I,value::int_u8) + threshold_image = binarization::niblack_threshold(input, window_size, K); + + mln_ch_value(I, bool) + output = local_threshold(input, threshold_image); + + trace::exiting("scribo::binarization::impl::generic::niblack"); + return output; + } + + } // end of namespace scribo::binarization::impl::generic + + + } // end of namespace scribo::binarization::impl + + + + // Dispatch + + namespace internal + { + + template <typename I> + mln_ch_value(I, bool) + niblack_dispatch(const mln_value(I)&, + const Image& input, unsigned window_size, + double K) + { + return impl::generic::niblack(input, window_size, K); + } + + + template <typename I> + mln_ch_value(I, bool) + niblack_dispatch(const Image& input, unsigned window_size, + double K) + { + typedef mln_value(I) V; + return niblack_dispatch(V(), input, window_size, K); + } + + } // end of namespace scribo::binarization::internal + + + + // Facades + + template <typename I> + mln_ch_value(I, bool) + niblack(const Image& input, unsigned window_size, double K) + { + trace::entering("scribo::binarization::niblack"); + + mln_precondition(exact(input).is_valid()); + + mln_ch_value(I, bool) + output = internal::niblack_dispatch(input, window_size, K); + +# ifdef SCRIBO_LOCAL_THRESHOLD_DEBUG + if (internal::stddev_image_output) + io::pgm::save(data::saturate(value::int_u8(), internal::debug_stddev), + internal::stddev_image_output); + if (internal::mean_image_output) + io::pgm::save(data::saturate(value::int_u8(), internal::debug_mean), + internal::mean_image_output); + if (internal::threshold_image_output) + io::pgm::save(data::saturate(value::int_u8(), internal::debug_threshold), + internal::threshold_image_output); + + if (internal::alpham_image_output) + io::pgm::save(data::saturate(value::int_u8(), internal::debug_alpham), + internal::alpham_image_output); + if (internal::alphacond_image_output) + io::pbm::save(internal::debug_alphacond, internal::alphacond_image_output); +# endif // ! SCRIBO_LOCAL_THRESHOLD_DEBUG + + + trace::exiting("scribo::binarization::niblack"); + return output; + } + + + template <typename I> + mln_ch_value(I, bool) + niblack(const Image& input, unsigned window_size) + { + return niblack(input, window_size, SCRIBO_DEFAULT_NIBLACK_K); + } + + + template <typename I> + mln_ch_value(I, bool) + niblack(const Image& input) + { + return niblack(input, 11); + } + + +# endif // ! MLN_INCLUDE_ONLY + + + } // end of namespace scribo::binarization + +} // end of namespace scribo + + +#endif // ! SCRIBO_BINARIZATION_NIBLACK_HH diff --git a/scribo/scribo/binarization/niblack_threshold.hh b/scribo/scribo/binarization/niblack_threshold.hh new file mode 100644 index 0000000..db4a74e --- /dev/null +++ b/scribo/scribo/binarization/niblack_threshold.hh @@ -0,0 +1,299 @@ +// Copyright (C) 2011 EPITA Research and Development Laboratory (LRDE) +// +// This file is part of Olena. +// +// Olena is free software: you can redistribute it and/or modify it under +// the terms of the GNU General Public License as published by the Free +// Software Foundation, version 2 of the License. +// +// Olena is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with Olena. If not, see <http://www.gnu.org/licenses/>. +// +// As a special exception, you may use this file as part of a free +// software project without restriction. Specifically, if other files +// instantiate templates or use macros or inline functions from this +// file, or you compile this file and link it with other files to produce +// an executable, this file does not by itself cause the resulting +// executable to be covered by the GNU General Public License. This +// exception does not however invalidate any other reasons why the +// executable file might be covered by the GNU General Public License. + +#ifndef SCRIBO_BINARIZATION_NIBLACK_THRESHOLD_HH +# define SCRIBO_BINARIZATION_NIBLACK_THRESHOLD_HH + +/// \file +/// +/// Compute an image of local threshold using Niblack algorithm. + +/// \fixme return type too restrictive! +/// \fixme Revamp code and merge with sauvola_threshold.hh. + +# include <algorithm> +# include <cmath> + +# include <mln/core/image/image2d.hh> +# include <mln/value/int_u.hh> +# include <mln/value/int_u8.hh> + +# include <scribo/core/init_integral_image.hh> +# include <scribo/binarization/internal/compute_local_threshold.hh> +# include <scribo/binarization/internal/niblack_formula.hh> + + + +namespace scribo +{ + + namespace binarization + { + + using namespace mln; + + /*! \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 + input. + + \return An image of local thresholds. + + */ + template <typename I, typename J> + mln_ch_value(I, value::int_u8) + niblack_threshold(const Image& input, unsigned window_size, + double K, + Image<J>& simple, + Image<J>& squared); + + /// \overload + template <typename I> + mln_ch_value(I, value::int_u8) + niblack_threshold(const Image& input, unsigned window_size, + double K); + + /// \overload + /// K is set to 0.34 + template <typename I> + mln_ch_value(I, value::int_u8) + niblack_threshold(const Image& input, unsigned window_size); + + + /// \overload + /// The window size is set to 11. + // + template <typename I> + mln_ch_value(I, value::int_u8) + niblack_threshold(const Image& input); + + + +# ifndef MLN_INCLUDE_ONLY + + + // Implementation + + + namespace impl + { + + namespace generic + { + + template <typename I, typename J> + inline + mln_concrete(I) + niblack_threshold(const Image& input_, unsigned window_size, + double K, + Image<J>& simple_, + Image<J>& squared_) + { + trace::entering("scribo::binarization::impl::generic::niblack_threshold"); + + const I& input = exact(input_); + J& simple = exact(simple_); + J& squared = exact(squared_); + + mln_assertion(input.is_valid()); + mln_assertion(simple.is_valid()); + mln_assertion(squared.is_valid()); + + typedef mln_value(I) V; + typedef mln_site(I) P; + +# ifdef SCRIBO_LOCAL_THRESHOLD_DEBUG + initialize(internal::debug_mean, input); + initialize(internal::debug_stddev, input); + initialize(internal::debug_threshold, input); + initialize(internal::debug_alpham, input); + initialize(internal::debug_alphacond, input); +# endif // ! SCRIBO_LOCAL_THRESHOLD_DEBUG + + mln_concrete(I) output; + initialize(output, input); + + const mln::def::coord + nrows = static_cast<mln::def::coord>(input.nrows()), + ncols = static_cast<mln::def::coord>(input.ncols()); + + + internal::niblack_formula formula; + for(mln::def::coord row = 0; row < nrows; ++row) + for(mln::def::coord col = 0; col < ncols; ++col) + { + // FIXME: Setting R parameter to 128 should not be + // hard-coded. Even though it is not used in Niblack's + // formula, this parameter is used for debug images and + // should be adapted to the data range values. + double t = internal::compute_local_threshold(P(row, col), simple, + squared, window_size, + K, + 128, + formula); + mln::convert::from_to(t, output.at_(row, col)); + +# ifdef SCRIBO_LOCAL_THRESHOLD_DEBUG + internal::debug_threshold.at_(row, col) = t; +# endif // ! SCRIBO_LOCAL_THRESHOLD_DEBUG + } + + trace::exiting("scribo::binarization::impl::generic::niblack_threshold"); + return output; + } + + } // end of namespace scribo::binarization::impl::generic + + + + template <typename I, typename J> + inline + mln_concrete(I) + niblack_threshold_gl(const I& input, unsigned window_size, + double K, + Image<J>& simple, + Image<J>& squared) + { + return impl::generic::niblack_threshold(input, window_size, K, + simple, squared); + } + + + } // end of namespace scribo::binarization::impl + + + + + // Dispatch + + namespace internal + { + + template <unsigned n, typename I, typename J> + inline + mln_ch_value(I, value::int_u<n>) + niblack_threshold_dispatch(const value::int_u<n>&, const I& input, + unsigned window_size, + double K, + J& simple, + J& squared) + { + return impl::niblack_threshold_gl(input, window_size, K, + simple, squared); + } + + + template <typename I, typename J> + inline + mln_ch_value(I, value::int_u8) + niblack_threshold_dispatch(const mln_value(I)&, const I& input, + unsigned window_size, + double K, + J& simple, + J& squared) + { + // No dispatch for this kind of value type. + mlc_abort(I)::check(); + + typedef mln_ch_value(I,bool) output_t; + return output_t(); + } + + + } // end of namespace scribo::binarization::internal + + + + template <typename I, typename J> + mln_ch_value(I, value::int_u8) + niblack_threshold(const Image& input, unsigned window_size, + double K, + Image<J>& simple, + Image<J>& squared) + { + trace::entering("scribo::binarization::niblack_threshold"); + + mln_precondition(mln_site_(I)::dim == 2); + mln_precondition(exact(input).is_valid()); + + typedef mln_value(I) value_t; + mln_ch_value(I, value::int_u8) + output = internal::niblack_threshold_dispatch(value_t(), + exact(input), + window_size, + K, + exact(simple), + exact(squared)); + + trace::exiting("scribo::text::ppm2pbm"); + return output; + } + + + template <typename I> + inline + mln_ch_value(I, value::int_u8) + niblack_threshold(const Image& input, unsigned window_size, + double K) + { + mln_ch_value(I, double) + simple = init_integral_image(input, scribo::internal::identity_), + squared = init_integral_image(input, scribo::internal::square_); + + return niblack_threshold(input, window_size, + K, simple, squared); + } + + + template <typename I> + inline + mln_ch_value(I, value::int_u8) + niblack_threshold(const Image& input, unsigned window_size) + { + return niblack_threshold(input, window_size, + SCRIBO_DEFAULT_NIBLACK_K); + } + + + template <typename I> + inline + mln_ch_value(I, value::int_u8) + niblack_threshold(const Image& input) + { + return niblack_threshold(input, 11); + } + + +# endif // ! MLN_INCLUDE_ONLY + + } // end of namespace scribo::binarization + +} // end of namespace scribo + + +#endif // ! SCRIBO_BINARIZATION_NIBLACK_THRESHOLD_HH diff --git a/scribo/scribo/binarization/sauvola.hh b/scribo/scribo/binarization/sauvola.hh index 45891c3..fc3e104 100644 --- a/scribo/scribo/binarization/sauvola.hh +++ b/scribo/scribo/binarization/sauvola.hh @@ -1,5 +1,5 @@ -// 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. // @@ -35,15 +35,15 @@ # include <mln/data/transform.hh> # include <mln/value/int_u8.hh> -# include <scribo/binarization/sauvola_threshold_image.hh> +# include <scribo/binarization/sauvola_threshold.hh> # include <scribo/binarization/local_threshold.hh> -# include <scribo/binarization/internal/sauvola_debug.hh> +# include <scribo/binarization/internal/local_threshold_debug.hh> -# ifdef SCRIBO_SAUVOLA_DEBUG +# ifdef SCRIBO_LOCAL_THRESHOLD_DEBUG # include <mln/io/pgm/save.hh> # include <mln/io/pbm/save.hh> # include <mln/data/saturate.hh> -# endif // ! SCRIBO_SAUVOLA_DEBUG +# endif // ! SCRIBO_LOCAL_THRESHOLD_DEBUG namespace scribo { @@ -110,11 +110,11 @@ namespace scribo trace::entering("scribo::binarization::impl::generic::sauvola"); mln_precondition(exact(input).is_valid()); + mln_ch_value(I,value::int_u8) + threshold_image = binarization::sauvola_threshold(input, window_size, K); + mln_ch_value(I, bool) - output = local_threshold(input, - binarization::sauvola_threshold_image(input, - window_size, - K)); + output = local_threshold(input, threshold_image); trace::exiting("scribo::binarization::impl::generic::sauvola"); return output; @@ -168,7 +168,7 @@ namespace scribo mln_ch_value(I, bool) output = internal::sauvola_dispatch(input, window_size, K); -# ifdef SCRIBO_SAUVOLA_DEBUG +# ifdef SCRIBO_LOCAL_THRESHOLD_DEBUG if (internal::stddev_image_output) io::pgm::save(data::saturate(value::int_u8(), internal::debug_stddev), internal::stddev_image_output); @@ -184,7 +184,7 @@ namespace scribo internal::alpham_image_output); if (internal::alphacond_image_output) io::pbm::save(internal::debug_alphacond, internal::alphacond_image_output); -# endif // ! SCRIBO_SAUVOLA_DEBUG +# endif // ! SCRIBO_LOCAL_THRESHOLD_DEBUG trace::exiting("scribo::binarization::sauvola"); diff --git a/scribo/scribo/binarization/sauvola_ms.hh b/scribo/scribo/binarization/sauvola_ms.hh index c1a3414..36629f9 100644 --- a/scribo/scribo/binarization/sauvola_ms.hh +++ b/scribo/scribo/binarization/sauvola_ms.hh @@ -60,16 +60,15 @@ # include <scribo/core/macros.hh> -# include <scribo/binarization/sauvola_threshold_image.hh> # include <scribo/binarization/internal/first_pass_functor.hh> # include <scribo/canvas/integral_browsing.hh> -# ifdef SCRIBO_SAUVOLA_DEBUG -# include <scribo/binarization/internal/sauvola_debug.hh> +# ifdef SCRIBO_LOCAL_THRESHOLD_DEBUG +# include <scribo/binarization/internal/local_threshold_debug.hh> # include <mln/io/pgm/save.hh> # include <scribo/make/debug_filename.hh> -# endif // ! SCRIBO_SAUVOLA_DEBUG +# endif // ! SCRIBO_LOCAL_THRESHOLD_DEBUG @@ -179,7 +178,7 @@ namespace scribo // 1st pass scribo::binarization::internal::first_pass_functor< image2d<int_u8> > - f(sub, K); + f(sub, K, SCRIBO_DEFAULT_SAUVOLA_R); scribo::canvas::integral_browsing(integral_sum_sum_2, ratio, w_local_w, w_local_h, @@ -259,10 +258,10 @@ namespace scribo } // end of 2nd pass -# ifdef SCRIBO_SAUVOLA_DEBUG +# ifdef SCRIBO_LOCAL_THRESHOLD_DEBUG io::pbm::save(f.msk, scribo::make::debug_filename(internal::threshold_image_output).c_str()); -# endif // ! SCRIBO_SAUVOLA_DEBUG +# endif // ! SCRIBO_LOCAL_THRESHOLD_DEBUG return f.t_sub; } @@ -923,18 +922,18 @@ namespace scribo } -# ifdef SCRIBO_SAUVOLA_DEBUG +# ifdef SCRIBO_LOCAL_THRESHOLD_DEBUG if (internal::scale_image_output) io::pgm::save(e_2, internal::scale_image_output); -# endif // ! SCRIBO_SAUVOLA_DEBUG +# endif // ! SCRIBO_LOCAL_THRESHOLD_DEBUG // Propagate scale values. e_2 = transform::influence_zone_geodesic(e_2, c8()); -// # ifdef SCRIBO_SAUVOLA_DEBUG +// # ifdef SCRIBO_LOCAL_THRESHOLD_DEBUG // if (internal::scale_image_output) // io::pgm::save(e_2, internal::scale_image_output); -// # endif // ! SCRIBO_SAUVOLA_DEBUG +// # endif // ! SCRIBO_LOCAL_THRESHOLD_DEBUG // Binarize image2d<bool> diff --git a/scribo/scribo/binarization/sauvola_threshold.hh b/scribo/scribo/binarization/sauvola_threshold.hh new file mode 100644 index 0000000..df46e95 --- /dev/null +++ b/scribo/scribo/binarization/sauvola_threshold.hh @@ -0,0 +1,296 @@ +// Copyright (C) 2009, 2010, 2011 EPITA Research and Development +// Laboratory (LRDE) +// +// This file is part of Olena. +// +// Olena is free software: you can redistribute it and/or modify it under +// the terms of the GNU General Public License as published by the Free +// Software Foundation, version 2 of the License. +// +// Olena is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with Olena. If not, see <http://www.gnu.org/licenses/>. +// +// As a special exception, you may use this file as part of a free +// software project without restriction. Specifically, if other files +// instantiate templates or use macros or inline functions from this +// file, or you compile this file and link it with other files to produce +// an executable, this file does not by itself cause the resulting +// executable to be covered by the GNU General Public License. This +// exception does not however invalidate any other reasons why the +// executable file might be covered by the GNU General Public License. + +#ifndef SCRIBO_BINARIZATION_SAUVOLA_THRESHOLD_HH +# define SCRIBO_BINARIZATION_SAUVOLA_THRESHOLD_HH + +/// \file +/// +/// Compute an image of local threshold using Sauvola algorithm. + +/// \fixme return type too restrictive! + +# include <algorithm> +# include <cmath> + +# include <mln/core/image/image2d.hh> +# include <mln/value/int_u.hh> +# include <mln/value/int_u8.hh> + +# include <scribo/core/init_integral_image.hh> +# include <scribo/binarization/internal/compute_local_threshold.hh> +# include <scribo/binarization/internal/sauvola_formula.hh> + + + +namespace scribo +{ + + namespace binarization + { + + using namespace mln; + + /*! \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. + + \return An image of local thresholds. + + */ + template <typename I, typename J> + mln_ch_value(I, value::int_u8) + sauvola_threshold(const Image& input, unsigned window_size, + double K, + Image<J>& simple, + Image<J>& squared); + + /// \overload + template <typename I> + mln_ch_value(I, value::int_u8) + sauvola_threshold(const Image& input, unsigned window_size, + double K); + + /// \overload + /// K is set to 0.34 + template <typename I> + mln_ch_value(I, value::int_u8) + sauvola_threshold(const Image& input, unsigned window_size); + + + /// \overload + /// The window size is set to 11. + // + template <typename I> + mln_ch_value(I, value::int_u8) + sauvola_threshold(const Image& input); + + + +# ifndef MLN_INCLUDE_ONLY + + + // Implementation + + + namespace impl + { + + namespace generic + { + + template <typename I, typename J> + inline + mln_concrete(I) + sauvola_threshold(const Image& input_, unsigned window_size, + double K, + Image<J>& simple_, + Image<J>& squared_) + { + trace::entering("scribo::binarization::impl::generic::sauvola_threshold"); + + const I& input = exact(input_); + J& simple = exact(simple_); + J& squared = exact(squared_); + + mln_assertion(input.is_valid()); + mln_assertion(simple.is_valid()); + mln_assertion(squared.is_valid()); + + typedef mln_value(I) V; + typedef mln_site(I) P; + +# ifdef SCRIBO_LOCAL_THRESHOLD_DEBUG + initialize(internal::debug_mean, input); + initialize(internal::debug_stddev, input); + initialize(internal::debug_threshold, input); + initialize(internal::debug_alpham, input); + initialize(internal::debug_alphacond, input); +# endif // ! SCRIBO_LOCAL_THRESHOLD_DEBUG + + // Sauvola Algorithm with I.I. + + mln_concrete(I) output; + initialize(output, input); + + const mln::def::coord + nrows = static_cast<mln::def::coord>(input.nrows()), + ncols = static_cast<mln::def::coord>(input.ncols()); + + internal::sauvola_formula formula; + for(mln::def::coord row = 0; row < nrows; ++row) + for(mln::def::coord col = 0; col < ncols; ++col) + { + double t = internal::compute_local_threshold(P(row, col), simple, + squared, window_size, + K, + SCRIBO_DEFAULT_SAUVOLA_R, + formula); + mln::convert::from_to(t, output.at_(row, col)); + +# ifdef SCRIBO_LOCAL_THRESHOLD_DEBUG + internal::debug_threshold.at_(row, col) = t; +# endif // ! SCRIBO_LOCAL_THRESHOLD_DEBUG + } + + trace::exiting("scribo::binarization::impl::generic::sauvola_threshold"); + return output; + } + + } // end of namespace scribo::binarization::impl::generic + + + + template <typename I, typename J> + inline + mln_concrete(I) + sauvola_threshold_gl(const I& input, unsigned window_size, + double K, + Image<J>& simple, + Image<J>& squared) + { + return impl::generic::sauvola_threshold(input, window_size, K, + simple, squared); + } + + + } // end of namespace scribo::binarization::impl + + + + + // Dispatch + + namespace internal + { + + template <unsigned n, typename I, typename J> + inline + mln_ch_value(I, value::int_u<n>) + sauvola_threshold_dispatch(const value::int_u<n>&, const I& input, + unsigned window_size, + double K, + J& simple, + J& squared) + { + return impl::sauvola_threshold_gl(input, window_size, K, + simple, squared); + } + + + template <typename I, typename J> + inline + mln_ch_value(I, value::int_u8) + sauvola_threshold_dispatch(const mln_value(I)&, const I& input, + unsigned window_size, + double K, + J& simple, + J& squared) + { + // No dispatch for this kind of value type. + mlc_abort(I)::check(); + + typedef mln_ch_value(I,bool) output_t; + return output_t(); + } + + + } // end of namespace scribo::binarization::internal + + + + template <typename I, typename J> + mln_ch_value(I, value::int_u8) + sauvola_threshold(const Image& input, unsigned window_size, + double K, + Image<J>& simple, + Image<J>& squared) + { + trace::entering("scribo::binarization::sauvola_threshold"); + + mln_precondition(mln_site_(I)::dim == 2); + mln_precondition(exact(input).is_valid()); + + typedef mln_value(I) value_t; + mln_ch_value(I, value::int_u8) + output = internal::sauvola_threshold_dispatch(value_t(), + exact(input), + window_size, + K, + exact(simple), + exact(squared)); + + trace::exiting("scribo::text::ppm2pbm"); + return output; + } + + + template <typename I> + inline + mln_ch_value(I, value::int_u8) + sauvola_threshold(const Image& input, unsigned window_size, + double K) + { + mln_ch_value(I, double) + simple = init_integral_image(input, scribo::internal::identity_), + squared = init_integral_image(input, scribo::internal::square_); + + return sauvola_threshold(input, window_size, + K, simple, squared); + } + + + template <typename I> + inline + mln_ch_value(I, value::int_u8) + sauvola_threshold(const Image& input, unsigned window_size) + { + return sauvola_threshold(input, window_size, + SCRIBO_DEFAULT_SAUVOLA_K); + } + + + template <typename I> + inline + mln_ch_value(I, value::int_u8) + sauvola_threshold(const Image& input) + { + return sauvola_threshold(input, 11); + } + + +# endif // ! MLN_INCLUDE_ONLY + + } // end of namespace scribo::binarization + +} // end of namespace scribo + + +#endif // ! SCRIBO_BINARIZATION_SAUVOLA_THRESHOLD_HH diff --git a/scribo/scribo/binarization/sauvola_threshold_image.hh b/scribo/scribo/binarization/sauvola_threshold_image.hh deleted file mode 100644 index 94cd688..0000000 --- a/scribo/scribo/binarization/sauvola_threshold_image.hh +++ /dev/null @@ -1,301 +0,0 @@ -// Copyright (C) 2009, 2010 EPITA Research and Development Laboratory -// (LRDE) -// -// This file is part of Olena. -// -// Olena is free software: you can redistribute it and/or modify it under -// the terms of the GNU General Public License as published by the Free -// Software Foundation, version 2 of the License. -// -// Olena is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -// General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with Olena. If not, see <http://www.gnu.org/licenses/>. -// -// As a special exception, you may use this file as part of a free -// software project without restriction. Specifically, if other files -// instantiate templates or use macros or inline functions from this -// file, or you compile this file and link it with other files to produce -// an executable, this file does not by itself cause the resulting -// executable to be covered by the GNU General Public License. This -// exception does not however invalidate any other reasons why the -// executable file might be covered by the GNU General Public License. - -#ifndef SCRIBO_BINARIZATION_SAUVOLA_THRESHOLD_IMAGE_HH -# define SCRIBO_BINARIZATION_SAUVOLA_THRESHOLD_IMAGE_HH - -/// \file -/// -/// Compute an image of local threshold using Sauvola algorithm. - -/// \fixme return type too restrictive! - -# include <algorithm> -# include <cmath> - -# include <mln/core/image/image2d.hh> -# include <mln/value/int_u.hh> -# include <mln/value/int_u8.hh> - -# include <scribo/core/init_integral_image.hh> -# include <scribo/binarization/internal/compute_sauvola_threshold.hh> - - - -namespace scribo -{ - - namespace binarization - { - - using namespace mln; - - /*! \brief Compute an image of local threshold using Sauvola algorithm. - - \input[in] input An 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. - - \return An image of local thresholds. - - */ - template <typename I, typename J> - mln_ch_value(I, value::int_u8) - sauvola_threshold_image(const Image& input, unsigned window_size, - double K, - Image<J>& simple, - Image<J>& squared); - - /// \overload - template <typename I> - mln_ch_value(I, value::int_u8) - sauvola_threshold_image(const Image& input, unsigned window_size, - double K); - - /// \overload - /// K is set to 0.34 - template <typename I> - mln_ch_value(I, value::int_u8) - sauvola_threshold_image(const Image& input, unsigned window_size); - - - /// \overload - /// The window size is set to 11. - // - template <typename I> - mln_ch_value(I, value::int_u8) - sauvola_threshold_image(const Image& input); - - - -# ifndef MLN_INCLUDE_ONLY - - - // Implementation - - - namespace impl - { - - namespace generic - { - - template <typename I, typename J> - inline - mln_concrete(I) - sauvola_threshold_image(const Image& input_, unsigned window_size, - double K, - Image<J>& simple_, - Image<J>& squared_) - { - trace::entering("scribo::binarization::impl::generic::sauvola_threshold_image"); - - const I& input = exact(input_); - J& simple = exact(simple_); - J& squared = exact(squared_); - - mln_assertion(input.is_valid()); - mln_assertion(simple.is_valid()); - mln_assertion(squared.is_valid()); - - typedef mln_value(I) V; - typedef mln_site(I) P; - -# ifdef SCRIBO_SAUVOLA_DEBUG - initialize(internal::debug_mean, input); - initialize(internal::debug_stddev, input); - initialize(internal::debug_threshold, input); - initialize(internal::debug_alpham, input); - initialize(internal::debug_alphacond, input); -# endif // ! SCRIBO_SAUVOLA_DEBUG - - // Sauvola Algorithm with I.I. - - mln_concrete(I) output; - initialize(output, input); - - const mln::def::coord - nrows = static_cast<mln::def::coord>(input.nrows()), - ncols = static_cast<mln::def::coord>(input.ncols()); - - - for(mln::def::coord row = 0; row < nrows; ++row) - for(mln::def::coord col = 0; col < ncols; ++col) - { -# ifdef SCRIBO_SAUVOLA_DEBUG - - double t = internal::compute_sauvola_threshold(P(row, col), simple, - squared, window_size, - K, - SCRIBO_DEFAULT_SAUVOLA_R); - mln::convert::from_to(t, output.at_(row, col)); - internal::debug_threshold.at_(row, col) = t; -# else - mln::convert::from_to( - internal::compute_sauvola_threshold(P(row, col), simple, - squared, window_size, - K, - SCRIBO_DEFAULT_SAUVOLA_R), - output.at_(row, col)); -# endif // ! SCRIBO_SAUVOLA_DEBUG - } - - trace::exiting("scribo::binarization::impl::generic::sauvola_threshold"); - return output; - } - - } // end of namespace scribo::binarization::impl::generic - - - - template <typename I, typename J> - inline - mln_concrete(I) - sauvola_threshold_image_gl(const I& input, unsigned window_size, - double K, - Image<J>& simple, - Image<J>& squared) - { - return impl::generic::sauvola_threshold_image(input, window_size, K, - simple, squared); - } - - - } // end of namespace scribo::binarization::impl - - - - - // Dispatch - - namespace internal - { - - template <unsigned n, typename I, typename J> - inline - mln_ch_value(I, value::int_u<n>) - sauvola_threshold_image_dispatch(const value::int_u<n>&, const I& input, - unsigned window_size, - double K, - J& simple, - J& squared) - { - return impl::sauvola_threshold_image_gl(input, window_size, K, - simple, squared); - } - - - template <typename I, typename J> - inline - mln_ch_value(I, value::int_u8) - sauvola_threshold_image_dispatch(const mln_value(I)&, const I& input, - unsigned window_size, - double K, - J& simple, - J& squared) - { - // No dispatch for this kind of value type. - mlc_abort(I)::check(); - - typedef mln_ch_value(I,bool) output_t; - return output_t(); - } - - - } // end of namespace scribo::binarization::internal - - - - template <typename I, typename J> - mln_ch_value(I, value::int_u8) - sauvola_threshold_image(const Image& input, unsigned window_size, - double K, - Image<J>& simple, - Image<J>& squared) - { - trace::entering("scribo::binarization::sauvola_threshold_image"); - - mln_precondition(mln_site_(I)::dim == 2); - mln_precondition(exact(input).is_valid()); - - typedef mln_value(I) value_t; - mln_ch_value(I, value::int_u8) - output = internal::sauvola_threshold_image_dispatch(value_t(), - exact(input), - window_size, - K, - exact(simple), - exact(squared)); - - trace::exiting("scribo::text::ppm2pbm"); - return output; - } - - - template <typename I> - inline - mln_ch_value(I, value::int_u8) - sauvola_threshold_image(const Image& input, unsigned window_size, - double K) - { - mln_ch_value(I, double) - simple = init_integral_image(input, scribo::internal::identity_), - squared = init_integral_image(input, scribo::internal::square_); - - return sauvola_threshold_image(input, window_size, - K, simple, squared); - } - - - template <typename I> - inline - mln_ch_value(I, value::int_u8) - sauvola_threshold_image(const Image& input, unsigned window_size) - { - return sauvola_threshold_image(input, window_size, - SCRIBO_DEFAULT_SAUVOLA_K); - } - - - template <typename I> - inline - mln_ch_value(I, value::int_u8) - sauvola_threshold_image(const Image& input) - { - return sauvola_threshold_image(input, 11); - } - - -# endif // ! MLN_INCLUDE_ONLY - - } // end of namespace scribo::binarization - -} // end of namespace scribo - - -#endif // ! SCRIBO_BINARIZATION_SAUVOLA_THRESHOLD_IMAGE_HH diff --git a/scribo/src/binarization/Makefile.am b/scribo/src/binarization/Makefile.am index 315e621..567972a 100644 --- a/scribo/src/binarization/Makefile.am +++ b/scribo/src/binarization/Makefile.am @@ -46,6 +46,7 @@ if HAVE_MAGICKXX sauvola_ms_debug utilexec_PROGRAMS = \ + niblack \ otsu \ sauvola \ sauvola_ms \ @@ -60,6 +61,13 @@ if HAVE_MAGICKXX $(MAGICKXX_LDFLAGS) + niblack_SOURCES = niblack.cc + niblack_CPPFLAGS = $(AM_CPPFLAGS) \ + $(MAGICKXX_CPPFLAGS) + niblack_LDFLAGS = $(AM_LDFLAGS) \ + $(MAGICKXX_LDFLAGS) + + otsu_SOURCES = otsu.cc otsu_CPPFLAGS = $(AM_CPPFLAGS) \ $(MAGICKXX_CPPFLAGS) @@ -80,7 +88,7 @@ if HAVE_MAGICKXX sauvola_debug_SOURCES = sauvola_debug.cc sauvola_debug_CPPFLAGS = $(AM_CPPFLAGS) \ - -DSCRIBO_SAUVOLA_DEBUG \ + -DSCRIBO_LOCAL_THRESHOLD_DEBUG \ $(MAGICKXX_CPPFLAGS) sauvola_debug_LDFLAGS = $(AM_LDFLAGS) \ $(MAGICKXX_LDFLAGS) @@ -94,7 +102,7 @@ if HAVE_MAGICKXX sauvola_ms_debug_SOURCES = sauvola_ms_debug.cc sauvola_ms_debug_CPPFLAGS = $(AM_CPPFLAGS) \ - -DSCRIBO_SAUVOLA_DEBUG \ + -DSCRIBO_LOCAL_THRESHOLD_DEBUG \ $(MAGICKXX_CPPFLAGS) sauvola_ms_debug_LDFLAGS = $(AM_LDFLAGS) \ $(MAGICKXX_LDFLAGS) diff --git a/scribo/src/binarization/niblack.cc b/scribo/src/binarization/niblack.cc new file mode 100644 index 0000000..4b7ed91 --- /dev/null +++ b/scribo/src/binarization/niblack.cc @@ -0,0 +1,106 @@ +// Copyright (C) 2011 EPITA Research and Development Laboratory (LRDE) +// +// This file is part of Olena. +// +// Olena is free software: you can redistribute it and/or modify it under +// the terms of the GNU General Public License as published by the Free +// Software Foundation, version 2 of the License. +// +// Olena is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with Olena. If not, see <http://www.gnu.org/licenses/>. +// +// As a special exception, you may use this file as part of a free +// software project without restriction. Specifically, if other files +// instantiate templates or use macros or inline functions from this +// file, or you compile this file and link it with other files to produce +// an executable, this file does not by itself cause the resulting +// executable to be covered by the GNU General Public License. This +// exception does not however invalidate any other reasons why the +// executable file might be covered by the GNU General Public License. + +#include <mln/core/image/image2d.hh> +#include <mln/value/int_u8.hh> +#include <mln/io/magick/load.hh> +#include <mln/io/pbm/save.hh> +#include <mln/data/transform.hh> +#include <mln/fun/v2v/rgb_to_luma.hh> + +#include <scribo/binarization/niblack.hh> +#include <scribo/debug/option_parser.hh> +#include <scribo/debug/logger.hh> + +static const scribo::debug::arg_data arg_desc[] = +{ + { "input.*", "An image." }, + { "output.pbm", "A binary image." }, + {0, 0} +}; + + +// --enable/disable-<name> +static const scribo::debug::toggle_data toggle_desc[] = +{ + // name, description, default value + {0, 0, false} +}; + + +// --<name> <args> +static const scribo::debug::opt_data opt_desc[] = +{ + // name, description, arguments, check args function, number of args, default arg + { "debug-prefix", "Enable debug image outputs. Prefix image name with that " + "given prefix.", "<prefix>", 0, 1, 0 }, + { "k", "Niblack's formulae parameter", "<value>", 0, 1, "-0.2" }, + { "verbose", "Enable verbose mode", 0, 0, 0, 0 }, + { "win-size", "Window size", "<size>", 0, 1, "101" }, + {0, 0, 0, 0, 0, 0} +}; + + + +int main(int argc, char *argv[]) +{ + using namespace mln; + + scribo::debug::option_parser options(arg_desc, toggle_desc, opt_desc); + + if (!options.parse(argc, argv)) + return 1; + + // Enable debug output. + if (options.is_set("debug-prefix")) + { + scribo::debug::logger().set_filename_prefix(options.opt_value("debug-prefix").c_str()); + scribo::debug::logger().set_level(scribo::debug::All); + } + + Magick::InitializeMagick(*argv); + + trace::entering("main"); + + bool verbose = options.is_set("verbose"); + unsigned w = atoi(options.opt_value("win-size").c_str()); + double k = atof(options.opt_value("k").c_str()); + + if (verbose) + std::cout << "Using w=" << w << " and k=" << k << std::endl; + + image2d<value::rgb8> input; + io::magick::load(input, options.arg("input.*")); + + // Convert to Gray level image. + image2d<value::int_u8> + input_1_gl = data::transform(input, mln::fun::v2v::rgb_to_luma<value::int_u8>()); + + image2d<bool> out = scribo::binarization::niblack(input_1_gl, w, k); + + io::pbm::save(out, options.arg("output.pbm")); + + trace::exiting("main"); +} diff --git a/scribo/src/binarization/pgm_sauvola_threshold_image.cc b/scribo/src/binarization/pgm_sauvola_threshold_image.cc index a38784a..69e2e15 100644 --- a/scribo/src/binarization/pgm_sauvola_threshold_image.cc +++ b/scribo/src/binarization/pgm_sauvola_threshold_image.cc @@ -1,4 +1,5 @@ -// Copyright (C) 2010 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2010, 2011 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -25,7 +26,7 @@ #include <mln/io/pgm/all.hh> -#include <scribo/binarization/sauvola.hh> +#include <scribo/binarization/sauvola_threshold.hh> #include <scribo/debug/usage.hh> const char *args_desc[][2] = @@ -67,7 +68,7 @@ int main(int argc, char *argv[]) image2d<value::int_u8> input; io::pgm::load(input, argv[1]); - image2d<value::int_u8> out = scribo::binarization::sauvola_threshold_image(input, w, k); + image2d<value::int_u8> out = scribo::binarization::sauvola_threshold(input, w, k); io::pgm::save(out, argv[2]); diff --git a/scribo/tests/binarization/Makefile.am b/scribo/tests/binarization/Makefile.am index b8ab2d9..a2962bb 100644 --- a/scribo/tests/binarization/Makefile.am +++ b/scribo/tests/binarization/Makefile.am @@ -21,6 +21,7 @@ include $(top_srcdir)/scribo/tests/tests.mk EXTRA_DIST = \ + niblack.res.pbm \ sauvola_ms.ref.pbm \ sauvola.ref.pbm \ otsu.ref.pbm @@ -28,6 +29,7 @@ EXTRA_DIST = \ check_PROGRAMS = \ global_threshold \ local_threshold \ + niblack \ otsu \ sauvola \ sauvola_ms @@ -35,6 +37,7 @@ check_PROGRAMS = \ global_threshold_SOURCES = global_threshold.cc local_threshold_SOURCES = local_threshold.cc +niblack_SOURCES = niblack.cc otsu_SOURCES = otsu.cc sauvola_SOURCES = sauvola.cc sauvola_ms_SOURCES = sauvola_ms.cc diff --git a/scribo/tests/binarization/niblack.cc b/scribo/tests/binarization/niblack.cc new file mode 100644 index 0000000..99a58e2 --- /dev/null +++ b/scribo/tests/binarization/niblack.cc @@ -0,0 +1,52 @@ +// Copyright (C) 2011 EPITA Research and Development Laboratory (LRDE) +// +// This file is part of Olena. +// +// Olena is free software: you can redistribute it and/or modify it under +// the terms of the GNU General Public License as published by the Free +// Software Foundation, version 2 of the License. +// +// Olena is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with Olena. If not, see <http://www.gnu.org/licenses/>. +// +// As a special exception, you may use this file as part of a free +// software project without restriction. Specifically, if other files +// instantiate templates or use macros or inline functions from this +// file, or you compile this file and link it with other files to produce +// an executable, this file does not by itself cause the resulting +// executable to be covered by the GNU General Public License. This +// exception does not however invalidate any other reasons why the +// executable file might be covered by the GNU General Public License. + +/// \file + +#include <mln/core/image/image2d.hh> +#include <mln/data/compare.hh> +#include <mln/value/int_u8.hh> +#include <mln/io/pgm/load.hh> +#include <mln/io/pbm/load.hh> +#include <mln/io/pbm/save.hh> + +#include <scribo/binarization/niblack.hh> + +#include "tests/data.hh" + +int main() +{ + using namespace mln; + + image2d<value::int_u8> input; + io::pgm::load(input, MILENA_IMG_DIR "/lena.pgm"); + + image2d<bool> bin = scribo::binarization::niblack(input, 101); + + image2d<bool> ref; + io::pbm::load(ref, SCRIBO_TESTS_DIR "binarization/niblack.ref.pbm"); + + mln_assertion(bin == ref); +} diff --git a/scribo/tests/binarization/niblack.ref.pbm b/scribo/tests/binarization/niblack.ref.pbm new file mode 100644 index 0000000000000000000000000000000000000000..7a3435193f1961f8161b71f8f60f3102d5ebbf87 GIT binary patch literal 16498 zcmcJWe~=tynaAIrne0r$k{v>nr3mQ>P{66jZiF-O64Dbu;7T-<TBWDn?FI=ys*sI< z{E(3DCDEWqvEjHMcmm7)ablHsWwh!<3voImkXS}GrIv;QnN9*MYQhX8u#?PezxREf z=Y6}UcOzca)jbs5@B6&Z=Y8Jyd4KfVJ)5g9ns;{Pigh=yyJhWd>#nU_b64eKH{P`F z=Czfj7YtS^H{5pH`oA6+7$MCCH{EjWx(n8=zwx%U7hHD>sE=IzH=kNv`NX<g*R8$f z3pZ5O-h6H4vURtwyJ=+o7uVf<Tji>?*NmXjkz4MnoPX6PF8jz|%=@dQAFSa2dF?4p z(o!S?K4;`I{d7$dI{uwfc}bT)A8Q@M)H7xO-~2TEbot+E{TuiC&-g#m`M>Z}dM5wy zO#eUoEw`k}@pEmfrpIG_+nJ9z8z<r?wX5$`%8{avpZrsg;%Bltena#}iO&f?f*wDh z+b?Zix$EUO;wNhHG>wkfy}sZ{7{OGsx}%P8O8oa3t=6}G?q8k{F1kFvLXY23pZ;ay zaGyFprgfl{FQ!qU#tG(^d|H%Rw^!)@_^$Hj{py0ww+2S^fvWXCb?sNy5T6?o(?E@L zVn+X;s_p2nsI_X|>g#^_({p~j6Ycle?)(3J<D}N1QZ>%%pe%Qpf873QU+d=6tG{!; zQo;TAeRO&tu5}W=^T{P!w2qV`e60Gr`6oG3_x0f;fBg5#+4IW&mGA$y*0rO7_1|*# z?jYVw=Z+1e_?NM4jO)px>;LUq<v9M8=T6n1+Oo2$lq-&|{p>C@&yHV9mBv{w{g<@9 zN5A^~84GgiltO&pffrVcJTQ&+du%uTvq21fQ{{ZlHq~q6oS+_Bn?}9X_mcOa{$Q~1 z!>^rt`tJu`K3cZ^r^2Nd@oKFz7O7YGjv7gdoN4HHCja@?^1_@_%kF>AvCHZswb1gl z=A5k>vnKDcX{bs=oal-_=U<qU|IFh`J-NHke|TJD{VSPU(?1C=_raU_8>stywio{% zryH@J9)EVrhM=HE3abx{oUEq;%j*wpF8f#j(o!shLv?1vzwp!AfBK7;eyS9lul&ON zo!*1f&w&?0|8O{fl^Hhh(k$MR>=^6m+HZpVc4zZkb;a5TgQ4%$#wrPae8I|E!o%x7 zY8KQ4xkooBSFi7S@7EmFtJLY?gZoa~5#JXC*8lOLZ`H8?=J;fYUiZ}~LHlQr_}A^p z)5n~kgwlOiUb1`bV;fLtX50@}zc`-oky5{^6K?nmIgRDtSU6lodsHq^_YPn2#3CdO z|H^~^fG&q8v1O>#q#!bXBt}!(-+5&@0Hdl(l?R<uzK*0BvA5pWHxAzMi3<{5;(sbB zwLYvrJAV)eq&lxUxcYrnq)hzZ{%U;-7LeqieoheKIePk@+QpBL{wK;v9F_aV4MjA> zv_Izks>$uApr0nZ%pWtDoh28o+QT%Ouhf<swoyf5*txq=L*ThK>a=KSBy#Cw_;T}9 zsgV3DHM~6Kr*$1ji#ckv;idiJe@egjqoM><6$+@gK)h+c*mt=9@L^g-;|E#8rEUF( zZO%ScP^&5hwE!7w$tE4HErL4Z-^6(8@QuZ1g-7!%m#FU}0H&<XK+JqNlXs=I_8;$= z_f_HPn#-MwtKr2W=GFvIOWw4f`L>Sre-*B(pirbjp-tLP#ae%rI4Y()MEXA<8QodA zV7IV*4T#UgPmjWq*PJ1QU&guG^zkn)wDIE#IAbj37WlM_L5x;-k8`!w@!ifagM2CQ zH4}dw!jhQ`e=+A)eEiw-t0_)%FhCTIrQ9N)SN{zEuC8f4b;h1=>dU%$Yy@figm1zy zBDG{q{DvquRe$-6twBJA-I8s8)8nV;41R<r_Ywb%m8+I?qnyt2EjS8Dk2^_M{N8?a z`pdmRg$gqwhUVHDFk7z8v#CqD`p4=|hpN)eQUJ34JM<7B$?!7%`trMeTUH!2vdGcw zff!4<bp~YktyY%nr%^cF)^9I&WXuIL*9;$frprbv{g?IMcuU`{hSB1{kkXVa@0v$$ zh98q$^z>V*N?RM2Z7LaF56JM__KW|9*c^#l_pMhqd9uQ64OxC%hR^cS|C-nwTh><R z7wX7F7M>Y@lu3~gCYZFcarldW^QJ2N9VKOq#L_24mz;n%rMt$SshI615-VJ@<8M}P zGOE&k!yg`cOASey;v(UfCzi3mO(JId&pBf<)w+A{s4+}CFw?(zKo~pm?@8|MYg)-} z8QKoKJJ0@mhM2ESzjS^dKW30M%}n<{dZ8hSq++Bd@V}V(NMQ!=IT#G+DNdV#f$dEH zVZytx<n|kr`kqxU)`Z4Y%x3dJ!c$*`H`E_?VR_J2Mq=#jNcpV9#ncNl;g!pU@o){x z+e%~%XSClAjN!ZcABTQ($l_+1p^`+yiIi{AsukXqqH!G#z0FBnWMtokZxSz7s|0fO z@M*7G-a0x_`>`|OF_8A(XXtHDSI!*$qpcv20Gx>DRz<1*?=dq~J63g{nXr6#Lf&=@ zj{)MP{{zgddFc0Q@nt`+nF`EApW$BsYCrQ*ot!`G4_4J<=iO~4ps9Lh{8K(4|6P1M zQ7)HOT=Ki8jDHhA@o#5;GOU<jN&8EeGI9aJ`r+++{D!GO`Y+F4*`ZJni5BfwssB+X z7MFs+shs?CgPR#VqyOQF_yMl|W~IXUrT+L1Q$fV0e~Rz0e-4M^GVzkSxBAgabh`B~ z12BU(?iC`JwqMTQcss0qWo?+RnF>s(ZFPLNLCx|W&wBE=YT4t@`Gzo4CBqwCPGNXW z{BhKDar)55z|a5S_1hnvutd^-Iee1Zw5iv@K&I`d=dYfQlqy{F?7bI0N;#5%Dxm(y zWXfVDB~FFi{2DF;-`a6|&vm!f#Fjo62+vE^+K>{b+Q_yaxy9N?X{gjvb@@wsuD8wQ z&XWHqIfTN7rO)sZk1g7NL$^_O$=uQ7ryOEWbRkpX!&$rwZ`3J?$1;9@3=qHk**n)h zRYw5}G<^OI5}q`W(DLHng>_8fTF_g4c>5Cq;|dM0zmOWiLJCOeq0EIw_%)h7CqaMK zhx1FFJ#0yr5GroJ-9+v534Oy$`(?%ls#-p$aBlwn6Sjf~JfWfTL}mDVKqmwjI`Pk? z(2NEpRp_A?O%dY7zb^_gSH;mRKZMfn#r)28s@j}4#&XgoK2k;{%~f+Y5ue7N_iudD z3CgOcqIyAyusM<uw-pJ?7pdWHqM#JY%4lxyPIY?H|5?15zJ)&Gt^b1K8GaDm-CW4m zC`-cK^(lU*aUKm}S>#bmh?jtTl1d{L>{Yq5`wK-+%l8QCB!66xxdxk%an<k9KI%dt zypI&s9VqpDwSOKmyGSDw*ry`-ZeVx^AKzf@!a(?qx=xcV=csZisGN!Zn-HKv8vlrA zF%p!AoRaV@&cA~qD$A*!1q+A2v{-jM(uloJH?siPS}E*zQFr{O$d(U$rJI%p(ckJO zAd(P(PsTJ0Acl9DPvYm${)1TcE2q3D>hE2l_meRMUTErCp5qA>$gtc05KKFCbkCjj z;hnc2FeZG=`&<nyY_#|zCTek^Y2mIM8eNX0v-6HeBIPFg9nBY%h2|3xTZ;-;YQON~ zNX0pvck|zT<Br|x;+6{q2^IUZ_#9LyaA6=`2aw{anfqY>tLxQ@2nH-Oc(zIWyD*_I zl%^(n^(s8~rF!J-3WesNO8jI4n9WO%sHS(eB7Bw22QJ*~xXE@$&Gfnb9!zvZ&JZso zaZCDNT1I8V>MV8X(w$2JwYW&eEFq5{t}bOGP!PkDiu<1%r?Lu4=C3^zsnQ~<StPRl zSrx(r(&b;~{}7Br<t)hc|6={?N?qg$j4OJKOkh5v;7&r_!;PwBzT_em_Cs|`>8(NB zeB?z??xj46NT_?bB|HarH<iS9KVOmdW%$teCld&P<|gs?p$Ph`%4zABsu><L-sSj{ zPdojgA)ap1|M^G-bD{cz{%&Y|K}Eu5f%I97xkr{~|0RzN!B6PPhoxd-Ndj^Mo?<?O zPy0WDcTdnNw^;Wf;y!GxFdw1}3hAtrL*qgvRpO(>MkrM8J@M(!vnd}4sE&}L6`%}h z%aa}&7dPQu9g}~jUw3Z3&+b)ZMf`y9zFA@>ycxc(^#*Kyg{5Q7=LS`gI4hC$?`5WM z*1y)rI`p=?#yj}HFb{9d@_bA}5w$j=y9@>KN&FDo?bMOAz5bs5kY|%`c|PU^C<Gtk z2I2PM4vqBRsp~ceVo*Q)W<cRjj_ZgS+z{nS7*52W+R$I`RI&d)s_**dFhx3*4!H|J z`BDv1)b33G^FP-6$^VjHG^S1uXm!=egoTgE#3P3*iAx2zQ#~|n)VBTjMFzj4H9B{b zKYEQdVtKRX#TsQuB=G~kqowAR;iI{M)Ul<>fwUi2>))qR@Gfo~w%loczNLDUdg9pr zeH?zW5Q(Y2K%C)5;!_FkssEhbM00bv*51<0%ziRNJW%E$8Q>1_k<9SUs;OcNr>D}> zZ@3|Kbet@V(4#+)HH#Yw7vP@w&$;mybmZ()#$LL3Gu(BB4{U**5fl>5D>>_5eOD8& zPI+Xo&EYq$`4+&9fkMJl-bFdbPc7NlNAdewt9qO}+Rcag8hDx%#y=-*NMuQ$r-^q? zZf@E(Bm98!`nZ|%;-5w`X}|Ej#OF$0n2!+MsX7_(1^0;K?;>T^Uxt_VyTm)CJMJ$A z6kVT;`GPxsvVf6?l;J7tiGRzF<Mdh9Y876rM3O1kRCP4cCv8OGGXXLQ!^bYRO=o$q zvW(X9>kl8P2x>VRJf;35?~HYbS6>R2ub0-bxm;Rmq$S}uyvO=(|4xnl&pDv(+U5$C zPQh4tO_~&t2#^UyX8z{t)38xj^eP>CY^h^c?zpP4(DYe&pG#0tGJkR4@(};x;A&m< zHU08$Rxk%4{L8%(KI4BDpL1#*_|K_oz8RRk?-)Coplg)pL8TO&nowri?_kAX{w#f_ zHyWikX~-m9v`d$!s>qZT-V87*O4~m~{*{yKA2pWd{O<{G!YA|pL_GXsA{2UVw3ZV7 z*eAZFO!$O19^l_aq0FC&j(3Q@++RmJ4{B+7i&Dh%-K@VXFZ=K3TIfHdT=6tJmD&3y zbNJD@n=eYn_!s`n$ft&s0t{68=rNx{`3b^M2pii&q+BSa{ns~{KdFkA9wgHSUCbQp zup#A{r>H|R{QNta=e=o?N`?0*i6?;E&Hn3>ZU%o^#qj9q7?qCG#Yk+!C;PW6>Wu$o ziup2ij>|nVnxG5BhEI5pb=mfxR?!rQ@;QB&2~v*hIBx`6n;x6?oAQkRa{}g7$(7Y3 zRrrP<m#pD^$r)b851*5$LDfM|%fhil_70O|E+OTjRK^clt|;)e%$Y1_bA;Rd5lIhv z@!w<GA0#in7RlUa@B;~tTH6&I->`beGDJ2*yd4ZA-GncpRm1qj7B^CMNv$hQA)*mx zL6XKr`ri+bHsCz=Em^e23b&(4lKa}lyC@O90DeC<fIhvU`|Lv7;1sV1u45)o{w01C z)#dnn;A&p-4L0Y?9aGmQ3zBUKA~EexdD;Lx3?Fa5VuNeDZ2{9(o1MkuZ%aa7??^~V zywLIz4foYG*;zau04Es!!_5SzjZ6lOREC%MQU9@l<7%4+iyE07+D=yy<~@@!Ri!-M zr1R6si@&k*UwOi$aC>)N2PJ%!@)C1iNaIa6QSb~gPqG>N4~;)|2Yi+C6LWqHHTI?o z;cfY>_9G&0^4$eiHL{!v>1rebgM}_Ki^ojx^Z|4FfK83;yd7o_p$zfVP?lLd{QLFM zlxM4l#<&}T5O0?sjh_p38h`lL6K809Zku3cE7@3i7arBdsQb6etgY<e?fX1G(eUG= zXtP=W)U2SWW4wr31JrorSa<mT9KWroTYYkPGl!7dk8J7+A8-Hf;y;?N@z()eK<%;R zi8-|@K%0~KZQ5_vFSS2(?}<EfaFOUu47$Ww`E$JIB|kmz-mE9fzGq?V3~<R~#ww(# z%#0uTZ+heR<3<6DY1PN=Bgt%oZu>0Wg|?gb>yJW%b(W7iF77Y9;B-a9VcvtD#k3{E z$7k^F6{?l7iwA*f6;r;G=TLbD|H*7VnvT!o@Q($H^j!TTpZ4QKnnmV)qo53xcKL6Q zY#8BEdWQ?V_`+bJXRL9H`q<PrnwO1#u2h!Ak!3BPK3w7~=->~%VkcC-HOJt)%o|+O zpIN!cbop;Sgz3|Oie4G;8jJH-`Y?}`%iEXbcY^nj>GI#%alqF;rY=6@>skN<=PhfF zy^l_~>GG%c6W{Is3p?cDM}KAbLzJuHs|g>?;1A8_qZI)k9w+f6;Jro_w<LU^SVi-U z1z-7iD^2~k!w=2n;cG;e?{kecnlDurjbeHqcq%ph$F?>VEtcUPKeA(VEI_$h<Qa1; z{d{)$--Kc+P5DN&sL1Ee@yUs>M-^bO+&4U|`ZCKu9z?O5;SayCXbm43{fWM?z`tei z!<?$X(0M%lZTs86yZvLK9ej295bb)ger!IKVzBlTOA;bj94YA`i~^K<C^7K^KRNZd zM`xFg_Fzus`AsljL5|vxF8||?Bjcg0i*JwmwD#ND3sgRj&tXN|T6CX&FYMwEmrW++ z8|`~}_}lmthi?fmSnQ%Y5*WEW{2VgU9J7_Byw*8ByiUf$_>f3%Ln~b}g}}AX!^cf# z74aTYX8d@ga`X{s8l<|CeoVNN3`hdZ9v;4gpT5%Y*1r$4llX<FL4n$h|5b8y;Zq}N zlBfT4fQ$#m`UfAM&C_Qh!pLn!v9lfJB%K0G#n5L3f{b$JQ~wQ|J;qVo2zyn&iJ#(= z;cNDwdtzvCJ$1F=t$$BXSzh4_C?=rlvy&yHapd9WFi{=+vxA3(^^bJNi%HYKpJ4Ui zcf@q~6!91XbO{NTP8B&9N$Vf!)_8}?-oT%4_28!<wcMjDnGlxcza1Ff`gdVLhu@C> z3cB8lK9uhCfk9gAKLU{Y-$ywYg<byl^Seu5gpx(78qBrB7xAGbgqjmnrGA}q9ui&r zK_32t5lZ^iW_6MszOX>MRseMuA0p>=@rd<)es;Gal$4y_Lf;k?lLS4~e`ve-y;bCB ze5`+@xA5*k8>=eiO1-WbzF6h(bDzYiNcEBYns^rp!v`qY!tYLjs^CKkLSR=PUjOlP zqYQt-^JsMORg~=FBV#~|7ks}RK0FNqts_NZnuM`(kn7?r2+<hv?SOd5@<Cs-pyl90 z(xv=f%DE^v?H@*n>a=_5D5rS)!?z?6ScJZWKjnG+To@Rh4&XJmM@NY-Ewwx%KWxI! z9@%Pt*|f&+Rjdq;OCBy^_CPKi<t#4XePiZY-LYzx-)Z@ddav-;Z?U#YtuW!|8As~& zLl0#6Uj%q`<FGT`QJ-hNJThkapyHYECwzRvm0AAp74O}&%$BQ#C@Wv;CVbg7;ZL?N zeJIHAxeb9w-^?0tbf+qmP?(28Bt+OkXdu4T9SV`7*&u<*X=+*n`3SoQJvvnp3Xuqg zWDfDIu5%W0DWBg+JbFAC;laW4r;ylo@fO$dy&2xw_;|usR8JL!sjo;Ct$)k6k3R#8 zBC=*+HSv(C2oD~7L{>Q}6lr4FhcNHjest>*WYhL5z0G6eNiv%g;!{AD4@jSGUs_j? zP5A<Scdg;S*PyP<iLiXBP=vnz2GDnHAN&tHy4ug@RUhVI3Eu#n2+P+K7+3m7GXdf0 z_NC(x+0=htzd~mRpZT(b-Qmsz$J~{py9CVWDQ?t7*_Y<(qh7~H7S)!R-*4=2I}tzq zaK`_8bgPT6`pP+YB0h~t`_~!%Uv<ar)PY2U&{yvY^Se@>j<e80QeJ=FWM%wM0uLaT zAF-==fHt~$HJi__KYTZ0KE~{a|G{og6e7cujS+-66MyZ}26(mb%a!X}L!P3u_^Ia% zFD3W@j=t48YMA_AwwzWIL^^>k`p`l|OC|AcWGNidf278cL8C(GU+GU5kC^xY)ZM&3 zhAfT0@JQ7VJxsF@`VIZq4Z8&X1E{<BsTVgOoAKWuApBqQI{qi{>HKqzw}|;wiyV`e z8yp8P@7fad#%%vRtbDSS{x4fh5ByYS^KpZ!BmeUE8=f)7*hBxT$EYNg!1@=}#+ueI zf5h+{zd~I~Vu#0nZ!bkA74RX<F^yO-)s{R}MV7os{Kuu_^&aNK`L5*6HB@d0bG!W< zD%I8xyprM9h-EZi4VKY|9&aXJ?c!T%L9>tY$@raP%p)B8D>xYtKb=-F!~cOmEgT!} z=Iz7`3aT{hl=-}s;fDg4+wE&Fk}h4+{u^I8Jb6OHr|$7g65fo;(F*=x=o0Wr`!QYG zzKa)-Ld6LkH9tFj!1o0(XMd=cTz`P_2~U3_8+%&!6jVOQ7n0u)p(X(zlD+YNtU?Dw z<TE^NpS|-{kIMD-=j((e0zQH{+e67)?h@oP{YSjw-X5HNa=qo^c*0V``X_&oH>s{3 zQ=iNqp9|vNqPiITV4sIPP9sKU@SUwx0VMHX_Td~21HWGN^j4UUES~sxji$<U7f;I# zf6d<c0G-?ly_Lme7`SvLvHf>Br}cME#JBK<`WZesE*!p?46$mBeWcEd2yspRaTQQD zjentry)Un$eTzxGuzC*+5oHrE>`LcFRA70|AfJri$*>QL@$fd{3k$1vBi~Bqs}5AL ziGrj()8|vJtN#VqNBBOqZ58&9o`s6`qBqe1A9n~WGyIe5g-`r1fl*ZKtd2IKAisd8 z?<Cy1L?e7N_=E3Mxq^fzN8r~E-;SREogXkiL1AYew&EXFEWiIrh4~_KJb&gQ0shkJ zYq`0BI>@`{*i<A7w&fg}!PnwymM0)8K9?Vz#BUJJTCUeWV*asjG^ds2+Y`J3lK5dc z`}lma<+c3iF7RrQ_|Dn;BiS&+M<a#5&VWEoa;$z;m9jj45nPNowC#zb#Z8;?PNYiI xZ2+MVqdS5uuTRlYm9Qj!6o2YLe$yru$vnX=kO4df%VMXDD_d!O{2_nq{{VOx_M89! literal 0 HcmV?d00001 -- 1.7.2.5

1 0