- Olena-patches

olena-2.0-541-g83d9bff Enhance documentation in scribo.
by Guillaume Lazzara 17 Apr '13

17 Apr '13

* scribo/core/component_set.hh, * scribo/core/object_links.hh: Add missing member documentation. * scribo/debug/logger.hh: Fix an invalid object reference. --- scribo/ChangeLog | 9 ++++++ scribo/scribo/core/component_set.hh | 5 ++- scribo/scribo/core/object_links.hh | 50 ++++++++++++++++++++++++++++------- scribo/scribo/debug/logger.hh | 2 +- 4 files changed, 53 insertions(+), 13 deletions(-) diff --git a/scribo/ChangeLog b/scribo/ChangeLog index cf030cb..9f4ac2a 100644 --- a/scribo/ChangeLog +++ b/scribo/ChangeLog @@ -1,5 +1,14 @@ 2013-04-17 Guillaume Lazzara <z(a)lrde.epita.fr> + Enhance documentation in scribo. + + * scribo/core/component_set.hh, + * scribo/core/object_links.hh: Add missing member documentation. + + * scribo/debug/logger.hh: Fix an invalid object reference. + +2013-04-17 Guillaume Lazzara <z(a)lrde.epita.fr> + * scribo/core/component_set.hh: Hide internal API. 2013-04-17 Guillaume Lazzara <z(a)lrde.epita.fr> diff --git a/scribo/scribo/core/component_set.hh b/scribo/scribo/core/component_set.hh index 259a508..30769d4 100644 --- a/scribo/scribo/core/component_set.hh +++ b/scribo/scribo/core/component_set.hh @@ -256,7 +256,7 @@ namespace scribo // Misc Members - /// Return the component count. + /// Return the number of components, background excluded. mln_value(L) nelements() const; /// Return component information for a given component id \p id. @@ -357,11 +357,12 @@ namespace scribo }; + /// \relates component_set template <typename L> bool operator==(const component_set<L>& lhs, const component_set<L>& rhs); - + /// \relates component_set template <typename L> std::ostream& operator<<(std::ostream& ostr, const component_set<L>& info); diff --git a/scribo/scribo/core/object_links.hh b/scribo/scribo/core/object_links.hh index 0515d84..ef1d3ab 100644 --- a/scribo/scribo/core/object_links.hh +++ b/scribo/scribo/core/object_links.hh @@ -58,7 +58,7 @@ namespace scribo object_links_data(); object_links_data(const component_set<L>& components, unsigned size); object_links_data(const component_set<L>& components, - unsigned size, unsigned value); + unsigned size, unsigned default_link_id); mln::util::array<unsigned> comp_to_link_; component_set<L> components_; @@ -69,20 +69,41 @@ namespace scribo - /// \brief Object links representation. - /// - /// \ingroup grpstruct - // + /*! \brief Object links representation. + + This structure is meant to store link information between + components. Linking components can be considered as a first step + towards component grouping. + + It requires a component_set to be constructed. Each component + existing in the component_set may have link in an object_link + structure. If no component_set is used for construction, this + object is invalid (\sa is_valid()). + + + + \ingroup grpstruct + */ template <typename L> class object_links : public Serializable<object_links<L> > { typedef internal::object_links_data<L> data_t; public: + /// Default constructor. It produces an invalid structure. object_links(); + + /// Construct a valid object_links. Links is enabled for each + /// valid component but no link is set. Invalid components links + /// are disabled. object_links(const component_set<L>& components); - object_links(const component_set<L>& components, unsigned value); + /// Construct a valid object_links. Links is enabled for each + /// valid component and set by default towards component with id + /// \p default_link_id. Invalid components links are disabled. + object_links(const component_set<L>& components, unsigned default_link_id); + + /// Return the underlying component_set. const component_set<L>& components() const; /// Return True if this object_links structure is correctly @@ -97,6 +118,8 @@ namespace scribo /// itself to another component. bool is_linked(unsigned comp_id) const; + /// Return the number of links. This is equivalent to the number + /// of components + the background. unsigned nelements() const; /// Link related methods. @@ -116,10 +139,16 @@ namespace scribo const unsigned& operator()(unsigned comp_id) const; /// \} + /// Returns the underlying array encoding the component + /// links. Indexes in array correspond to component ids and the + /// corresponding value is the component id involved in the link. const mln::util::array<unsigned>& comp_to_link() const; + /// Initialize links. Each component is linked to itself (i.e. has + /// no link). Invalid components have linking disabled. void init(); + /// Make a deep copy of this structure. object_links<L> duplicate() const; private: @@ -127,6 +156,7 @@ namespace scribo }; + /// \relates object_links template <typename L> std::ostream& operator<<(std::ostream& ostr, const object_links<L>& links); @@ -156,8 +186,8 @@ namespace scribo template <typename L> object_links_data<L>::object_links_data(const component_set<L>& components, - unsigned size, unsigned value) - : comp_to_link_(size, value), components_(components) + unsigned size, unsigned default_link_id) + : comp_to_link_(size, default_link_id), components_(components) { }; @@ -182,10 +212,10 @@ namespace scribo template <typename L> object_links<L>::object_links(const component_set<L>& components, - unsigned value) + unsigned default_link_id) { data_ = new data_t(components, value::next(components.nelements()), - value); + default_link_id); } diff --git a/scribo/scribo/debug/logger.hh b/scribo/scribo/debug/logger.hh index 0b29aaf..ab283c3 100644 --- a/scribo/scribo/debug/logger.hh +++ b/scribo/scribo/debug/logger.hh @@ -144,7 +144,7 @@ namespace scribo inside a program. Stopping time logging will output the computed time if - Verbose mode is higher or equal to #Time. + Verbose mode is higher or equal to scribo::debug::Time. */ /// @{ void start_time_logging(); -- 1.7.2.5

1 0

olena-2.0-540-gaa8db8d scribo/core/component_set.hh: Hide internal API.
by Guillaume Lazzara 17 Apr '13

17 Apr '13

--- scribo/ChangeLog | 4 ++++ scribo/scribo/core/component_set.hh | 5 +++++ 2 files changed, 9 insertions(+), 0 deletions(-) diff --git a/scribo/ChangeLog b/scribo/ChangeLog index 39b46c5..cf030cb 100644 --- a/scribo/ChangeLog +++ b/scribo/ChangeLog @@ -1,5 +1,9 @@ 2013-04-17 Guillaume Lazzara <z(a)lrde.epita.fr> + * scribo/core/component_set.hh: Hide internal API. + +2013-04-17 Guillaume Lazzara <z(a)lrde.epita.fr> + Move documentation of component_set in its corresponding header. * doc/scribo/core/component_set.dox: Remove and move documentation... diff --git a/scribo/scribo/core/component_set.hh b/scribo/scribo/core/component_set.hh index 72bdbcd..259a508 100644 --- a/scribo/scribo/core/component_set.hh +++ b/scribo/scribo/core/component_set.hh @@ -307,6 +307,8 @@ namespace scribo // Internal methods + /// \cond INTERNAL_API + /// \internal /// Return all the component infos. // @@ -343,10 +345,13 @@ namespace scribo // mln_concrete(L) valid_comps_image_() const; + /// \endcond protected: + /// \cond INTERNAL_API /// Duplicate the underlying image and create a new component_set. void init_(const component_set<L>& model); + /// \endcond mln::util::tracked_ptr<data_t> data_; }; -- 1.7.2.5

1 0

olena-2.0-539-ge2f4e92 Move documentation of component_set in its corresponding header.
by Guillaume Lazzara 17 Apr '13

17 Apr '13

* doc/scribo/core/component_set.dox: Remove and move documentation... * scribo/core/component_set.hh: ... here. --- scribo/ChangeLog | 8 +++ scribo/doc/scribo/core/component_set.dox | 90 ------------------------------ scribo/scribo/core/component_set.hh | 88 +++++++++++++++++++++++++++++ 3 files changed, 96 insertions(+), 90 deletions(-) delete mode 100644 scribo/doc/scribo/core/component_set.dox diff --git a/scribo/ChangeLog b/scribo/ChangeLog index 3d971b9..39b46c5 100644 --- a/scribo/ChangeLog +++ b/scribo/ChangeLog @@ -1,5 +1,13 @@ 2013-04-17 Guillaume Lazzara <z(a)lrde.epita.fr> + Move documentation of component_set in its corresponding header. + + * doc/scribo/core/component_set.dox: Remove and move documentation... + + * scribo/core/component_set.hh: ... here. + +2013-04-17 Guillaume Lazzara <z(a)lrde.epita.fr> + * doc/Doxyfile.in: Expand more macros. 2013-04-17 Guillaume Lazzara <z(a)lrde.epita.fr> diff --git a/scribo/doc/scribo/core/component_set.dox b/scribo/doc/scribo/core/component_set.dox deleted file mode 100644 index ccde17c..0000000 --- a/scribo/doc/scribo/core/component_set.dox +++ /dev/null @@ -1,90 +0,0 @@ -/*! - \class scribo::component_set - - This structure is used to store rich information related to - components in an image. - - It can be constructed directly from a labeled image and the number - of components, or using primitive::extract::components (easier and - recommanded) with a binary image. - - \code - mln::image2d<bool> ima; - mln::io::pbm::load(ima, "document.pbm"); - - typedef scribo::def::lbl_type V; - typedef mln::image2d<V> L; - V ncomps; - component_set<L> comps = primitive::extract::components(ima, c4(), ncomps); - \endcode - - Each component is associated to an id, \ref component_id_t. This - id is equivalent to the component label in the label image (\ref - labeled_image()). - - A component_set is considered as valid if it has been initialized - (i.e. not instantiated with the default constructor). - - On construction, information is automatically computed for each - components. To iterate over all the components and get that - information, use operator()() or info(): - - \code - for_all_comps(c,comps) - { - const scribo::component_info<L>& comp_info = comps.info(c); - - // Some code here... - } - \endcode - - Among component information, a component::Tag tag is stored and - used to mark specific components. This tag can be massively - updated for all components using update_tags(). The function - passed to this method must implement the following interface: - - \code - template <typename L> - struct my_function - : mln::Function_v2b< my_function<L> > - { - // Constructor - my_function(const scribo::component_set<L>& components) - : components_(components) - { - } - - // Core function - bool operator()(const mln_value(L)& l) const - { - if (l == mln::literal::zero) - return false; - return true;// your test here - } - - /// Component set. - scribo::component_set<L> components_; - }; - \endcode - - Tags can be used to filter/make a selection of - components. Routines performing this selection/filtering - automatically are listed in \ref grpalgofiltercomp section. - - Components considered as separators in the input image (lines, - blocks, ...) may be processed separately and are useful of the - rest of the layout analysis. This structure allows you to store a - binary image of separators which will be used in some routines to - prevent wrong regrouping. Note that no component information will - be computed for separators. The separator image can be managed - with has_separators(), add_separators(), separators(), and - clear_separators(). - - scribo::component_set is the first data structure in the - hierarchical representation of a document as explained in \ref - grpstruct. - - \sa component_info, component::Tag, component::Type, grpstruct, - grpalgofiltercomp. - -*/ \ No newline at end of file diff --git a/scribo/scribo/core/component_set.hh b/scribo/scribo/core/component_set.hh index eea385b..72bdbcd 100644 --- a/scribo/scribo/core/component_set.hh +++ b/scribo/scribo/core/component_set.hh @@ -123,6 +123,94 @@ namespace scribo /*! \brief Represents all the components in a document image. + This structure is used to store rich information related to + components in an image. + + It can be constructed directly from a labeled image and the number + of components, or using primitive::extract::components (easier and + recommanded) with a binary image. + + \code + mln::image2d<bool> ima; + mln::io::pbm::load(ima, "document.pbm"); + + typedef scribo::def::lbl_type V; + typedef mln::image2d<V> L; + V ncomps; + component_set<L> comps = primitive::extract::components(ima, c4(), ncomps); + \endcode + + Each component is associated to an id, \ref component_id_t. This + id is equivalent to the component label in the label image (\ref + labeled_image()). They are labeled from 1 to nelements() + included. Id 0 is reserved for the background which is not + considered as an actual component. + + A component_set is considered as valid if it has been initialized + (i.e. not instantiated with the default constructor). + + On construction, information is automatically computed for each + components. To iterate over all the components and get that + information, use operator()() or info(): + + \code + for_all_comps(c,comps) + { + const scribo::component_info<L>& comp_info = comps.info(c); + + // Some code here... + } + \endcode + + Among component information, a component::Tag tag is stored and + used to mark specific components. This tag can be massively + updated for all components using update_tags(). The function + passed to this method must implement the following interface: + + \code + template <typename L> + struct my_function + : mln::Function_v2b< my_function<L> > + { + // Constructor + my_function(const scribo::component_set<L>& components) + : components_(components) + { + } + + // Core function + bool operator()(const mln_value(L)& l) const + { + if (l == mln::literal::zero) + return false; + return true;// your test here + } + + /// Component set. + scribo::component_set<L> components_; + }; + \endcode + + Tags can be used to filter/make a selection of + components. Routines performing this selection/filtering + automatically are listed in \ref grpalgofiltercomp section. + + Components considered as separators in the input image (lines, + blocks, ...) may be processed separately and are useful of the + rest of the layout analysis. This structure allows you to store a + binary image of separators which will be used in some routines to + prevent wrong regrouping. Note that no component information will + be computed for separators. The separator image can be managed + with has_separators(), add_separators(), separators(), and + clear_separators(). + + scribo::component_set is the first data structure in the + hierarchical representation of a document as explained in \ref + grpstruct. + + \sa component_info, component::Tag, component::Type, grpstruct, + grpalgofiltercomp. + \ingroup grpstruct */ template <typename L> -- 1.7.2.5

1 0

olena-2.0-538-g07333d2 doc/Doxyfile.in: Expand more macros.
by Guillaume Lazzara 17 Apr '13

17 Apr '13

--- scribo/ChangeLog | 4 ++++ scribo/doc/Doxyfile.in | 11 +++++++---- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/scribo/ChangeLog b/scribo/ChangeLog index dd9004e..3d971b9 100644 --- a/scribo/ChangeLog +++ b/scribo/ChangeLog @@ -1,5 +1,9 @@ 2013-04-17 Guillaume Lazzara <z(a)lrde.epita.fr> + * doc/Doxyfile.in: Expand more macros. + +2013-04-17 Guillaume Lazzara <z(a)lrde.epita.fr> + * doc/Doxyfile.in: Exclude internal symbols from documentation. 2013-04-17 Guillaume Lazzara <z(a)lrde.epita.fr> diff --git a/scribo/doc/Doxyfile.in b/scribo/doc/Doxyfile.in index f9d930c..904121c 100644 --- a/scribo/doc/Doxyfile.in +++ b/scribo/doc/Doxyfile.in @@ -227,7 +227,8 @@ EXPAND_ONLY_PREDEF = YES SEARCH_INCLUDES = YES INCLUDE_PATH = INCLUDE_FILE_PATTERNS = -PREDEFINED = "for_all(x)=for(x.start(); x.is_valid(); x.next())" \ +PREDEFINED = MLN_INCLUDE_ONLY \ + "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())" \ @@ -325,9 +326,11 @@ PREDEFINED = "for_all(x)=for(x.start(); x.is_valid(); x.next())" \ "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" - - + "mln_ch_fun_vv2v(F, L, R)=typename mln::trait::ch_value< L, typename mln_fun_vv2v(F, L, R)::result >::ret" \ + "mln_ch_convolve(I, W)=typename mln::linear::ch_convolve<I, W>::ret" \ + "mln_ch_convolve_(I, W)=mln::linear::ch_convolve<I, W>::ret" \ + "mln_ch_convolve_grad(I, W)=typename mln::trait::ch_value< I, algebra::vec< I::site::dim, typename mln::linear::ch_convolve<I,W>::ret::value > >::ret" \ + "mln_ch_convolve_grad_(I, W)=mln::trait::ch_value< I, algebra::vec< I::site::dim, mln::linear::ch_convolve<I,W>::ret::value > >::ret" EXPAND_AS_DEFINED = -- 1.7.2.5

1 0

olena-2.0-537-g1a302ad doc/Doxyfile.in: Exclude internal symbols from documentation.
by Guillaume Lazzara 17 Apr '13

17 Apr '13

--- scribo/ChangeLog | 4 ++++ scribo/doc/Doxyfile.in | 3 ++- 2 files changed, 6 insertions(+), 1 deletions(-) diff --git a/scribo/ChangeLog b/scribo/ChangeLog index 869db05..dd9004e 100644 --- a/scribo/ChangeLog +++ b/scribo/ChangeLog @@ -1,5 +1,9 @@ 2013-04-17 Guillaume Lazzara <z(a)lrde.epita.fr> + * doc/Doxyfile.in: Exclude internal symbols from documentation. + +2013-04-17 Guillaume Lazzara <z(a)lrde.epita.fr> + * doc/Doxyflile.in: Fix include paths in documentation. 2013-04-17 Guillaume Lazzara <z(a)lrde.epita.fr> diff --git a/scribo/doc/Doxyfile.in b/scribo/doc/Doxyfile.in index 0c30c9c..f9d930c 100644 --- a/scribo/doc/Doxyfile.in +++ b/scribo/doc/Doxyfile.in @@ -110,7 +110,8 @@ EXCLUDE = @top_srcdir@/scribo/demo \ @top_srcdir@/scribo/+* EXCLUDE_SYMLINKS = YES EXCLUDE_PATTERNS = *.spe.hh *.moc.cc -EXCLUDE_SYMBOLS = *_ mln::trait::* +EXCLUDE_SYMBOLS = mln::trait::* \ + scribo::*::internal::*_data EXAMPLE_PATH = @top_srcdir@/scribo/doc/examples \ @top_srcdir@/scribo/doc/outputs \ @top_srcdir@/scribo/doc/examples/split \ -- 1.7.2.5

1 0

olena-2.0-536-gb0051dc doc/Doxyflile.in: Fix include paths in documentation.
by Guillaume Lazzara 17 Apr '13

17 Apr '13

--- scribo/ChangeLog | 4 ++++ scribo/doc/Doxyfile.in | 2 +- 2 files changed, 5 insertions(+), 1 deletions(-) diff --git a/scribo/ChangeLog b/scribo/ChangeLog index 216f480..869db05 100644 --- a/scribo/ChangeLog +++ b/scribo/ChangeLog @@ -1,5 +1,9 @@ 2013-04-17 Guillaume Lazzara <z(a)lrde.epita.fr> + * doc/Doxyflile.in: Fix include paths in documentation. + +2013-04-17 Guillaume Lazzara <z(a)lrde.epita.fr> + * scribo/util/component_precise_outline.hh: Check if sites are part of the image. diff --git a/scribo/doc/Doxyfile.in b/scribo/doc/Doxyfile.in index 28371aa..0c30c9c 100644 --- a/scribo/doc/Doxyfile.in +++ b/scribo/doc/Doxyfile.in @@ -33,7 +33,7 @@ ABBREVIATE_BRIEF = ALWAYS_DETAILED_SEC = YES INLINE_INHERITED_MEMB = YES FULL_PATH_NAMES = YES -STRIP_FROM_PATH = @top_srcdir@/scribo +STRIP_FROM_PATH = STRIP_FROM_INC_PATH = @top_srcdir@/scribo SHORT_NAMES = NO JAVADOC_AUTOBRIEF = YES -- 1.7.2.5

1 0

olena-2.0-535-g13b6149 Move internal code to namespace internal.
by Guillaume Lazzara 17 Apr '13

17 Apr '13

* mln/labeling/n_max.hh: Move internal function to namespace internal. * tests/labeling/n_max.cc: Update function namespaces. --- milena/ChangeLog | 9 +++++ milena/mln/labeling/n_max.hh | 77 +++++++++++++++++++++------------------ milena/tests/labeling/n_max.cc | 5 ++- 3 files changed, 53 insertions(+), 38 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index a45676f..91b8ec9 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,14 @@ 2013-04-17 Guillaume Lazzara <z(a)lrde.epita.fr> + Move internal code to namespace internal. + + * mln/labeling/n_max.hh: Move internal function to namespace + internal. + + * tests/labeling/n_max.cc: Update function namespaces. + +2013-04-17 Guillaume Lazzara <z(a)lrde.epita.fr> + * mln/win/rectangle2d.hh: Hide internal API. 2013-04-17 Guillaume Lazzara <z(a)lrde.epita.fr> diff --git a/milena/mln/labeling/n_max.hh b/milena/mln/labeling/n_max.hh index c53949e..dbd2cf7 100644 --- a/milena/mln/labeling/n_max.hh +++ b/milena/mln/labeling/n_max.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2013 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -35,13 +36,6 @@ /// /// Construct from a count accumulator of a labeled image an array with /// the ordered n biggest labels. -/// -/// \return an array starting at index 1 -/// -/// \warning The biggest value is stocked at index 0. It generally represents -/// the background and should be ignored. However, it is still accessible -/// if necessary. - namespace mln { @@ -49,11 +43,17 @@ namespace mln namespace labeling { - template <typename L, typename V> - util::array<L> - n_max(const util::array<V>& in_arr, unsigned n); + /*! \brief Construct from a count accumulator of a labeled image an array with + the ordered n biggest labels. + \return an array starting at index 1 + \warning The biggest value is stored at index 0. It usually + represents the background and should be ignored. However, it + is still accessible if necessary. + + \ingroup labeling + */ template <typename L> util::array<mln_value(L)> n_max(const Image<L>& lbl, const mln_value(L)& nlabels, unsigned n); @@ -61,44 +61,49 @@ namespace mln # ifndef MLN_INCLUDE_ONLY - template <typename L, typename V> - util::array<L> - n_max(const util::array<V>& in_arr, unsigned n) + namespace internal { - mln_trace("mln::labeling::n_max"); - - mln_precondition(n < in_arr.nelements()); - util::array<L> output(n + 1, 0); - for (unsigned i = 0; i < n + 1; ++i) - output[i] = i; - int swap = 0; - for (int j = n - 1; j > 0; --j) + template <typename L, typename V> + util::array<L> + n_max(const util::array<V>& in_arr, unsigned n) { - if (in_arr[output[j]] < in_arr[output[j + 1]]) - { - swap = output[j]; - output[j] = output[j + 1]; - output[j + 1] = swap; - } - } + mln_trace("mln::labeling::n_max"); - for (unsigned i = n; i < in_arr.nelements(); ++i) - { - if (in_arr[i] > in_arr[output[n]]) + mln_precondition(n < in_arr.nelements()); + + util::array<L> output(n + 1, 0); + for (unsigned i = 0; i < n + 1; ++i) + output[i] = i; + int swap = 0; + for (int j = n - 1; j > 0; --j) { - output[n] = i; - for (unsigned j = n - 1; j > 0 && in_arr[output[j]] < in_arr[output[j + 1]]; --j) + if (in_arr[output[j]] < in_arr[output[j + 1]]) { swap = output[j]; output[j] = output[j + 1]; output[j + 1] = swap; } } + + for (unsigned i = n; i < in_arr.nelements(); ++i) + { + if (in_arr[i] > in_arr[output[n]]) + { + output[n] = i; + for (unsigned j = n - 1; j > 0 && in_arr[output[j]] < in_arr[output[j + 1]]; --j) + { + swap = output[j]; + output[j] = output[j + 1]; + output[j + 1] = swap; + } + } + } + + return output; } - return output; - } + } // end of namespace mln::labeling::internal template <typename L> diff --git a/milena/tests/labeling/n_max.cc b/milena/tests/labeling/n_max.cc index 1b70a7e..001ed8b 100644 --- a/milena/tests/labeling/n_max.cc +++ b/milena/tests/labeling/n_max.cc @@ -1,4 +1,5 @@ -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2013 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -55,7 +56,7 @@ int main() accu::math::count<int_u8> a_; util::array<unsigned> a = labeling::compute(a_, threshold, labels, nlabels); - util::array<label_8> arr_big = labeling::n_max<label_8>(a, 3); + util::array<label_8> arr_big = labeling::internal::n_max<label_8>(a, 3); mln_assertion(arr_big[1] == 1u); mln_assertion(arr_big[2] == 4u); -- 1.7.2.5

1 0

olena-2.0-534-g77d7b3a mln/win/rectangle2d.hh: Hide internal API.
by Guillaume Lazzara 17 Apr '13

17 Apr '13

--- milena/ChangeLog | 4 ++++ milena/mln/win/rectangle2d.hh | 13 ++++++++----- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 3275cd1..a45676f 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,9 @@ 2013-04-17 Guillaume Lazzara <z(a)lrde.epita.fr> + * mln/win/rectangle2d.hh: Hide internal API. + +2013-04-17 Guillaume Lazzara <z(a)lrde.epita.fr> + Add labeling module in documentation. * doc/mln/labeling/labeling.dox: New. Introduce labeling module. diff --git a/milena/mln/win/rectangle2d.hh b/milena/mln/win/rectangle2d.hh index 6764755..fb6f734 100644 --- a/milena/mln/win/rectangle2d.hh +++ b/milena/mln/win/rectangle2d.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -82,16 +83,18 @@ namespace mln /// Give the rectangle area. unsigned area() const; + /// Give the std vector of delta-points. + const std::vector<dpoint2d>& std_vector() const; + + + /// \cond INTERNAL_API /*! \brief Give the maximum coordinate gap between the window * center and a window point. */ unsigned delta_() const; - - /// Give the std vector of delta-points. - const std::vector<dpoint2d>& std_vector() const; - void print_(std::ostream& ostr) const; + /// \endcond protected: -- 1.7.2.5

1 0

olena-2.0-533-g9cf87e5 Add labeling module in documentation.
by Guillaume Lazzara 17 Apr '13

17 Apr '13

* doc/mln/labeling/labeling.dox: New. Introduce labeling module. * mln/labeling/background.hh, * mln/labeling/colorize.hh, * mln/labeling/compute.hh, * mln/labeling/compute_image.hh, * mln/labeling/flat_zones.hh, * mln/labeling/foreground.hh, * mln/labeling/mean_values.hh, * mln/labeling/pack.hh, * mln/labeling/regional_maxima.hh, * mln/labeling/regional_minima.hh, * mln/labeling/relabel.hh, * mln/labeling/superpose.hh, * mln/labeling/value.hh, * mln/labeling/value_and_compute.hh, * mln/labeling/wrap.hh: Set documentation as part of the labeling group. --- milena/ChangeLog | 23 +++++++ milena/doc/mln/labeling/labeling.dox | 6 ++ milena/mln/labeling/background.hh | 4 +- milena/mln/labeling/colorize.hh | 42 ++++++++----- milena/mln/labeling/compute.hh | 100 ++++++++++++++++------------- milena/mln/labeling/compute_image.hh | 74 ++++++++++++---------- milena/mln/labeling/flat_zones.hh | 18 +++--- milena/mln/labeling/foreground.hh | 8 ++- milena/mln/labeling/mean_values.hh | 11 +++- milena/mln/labeling/pack.hh | 34 +++++++--- milena/mln/labeling/regional_maxima.hh | 19 +++--- milena/mln/labeling/regional_minima.hh | 19 +++--- milena/mln/labeling/relabel.hh | 71 ++++++++++++--------- milena/mln/labeling/superpose.hh | 5 +- milena/mln/labeling/value.hh | 24 ++++--- milena/mln/labeling/value_and_compute.hh | 22 ++++--- milena/mln/labeling/wrap.hh | 35 ++++++---- 17 files changed, 314 insertions(+), 201 deletions(-) create mode 100644 milena/doc/mln/labeling/labeling.dox diff --git a/milena/ChangeLog b/milena/ChangeLog index 706b503..3275cd1 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,28 @@ 2013-04-17 Guillaume Lazzara <z(a)lrde.epita.fr> + Add labeling module in documentation. + + * doc/mln/labeling/labeling.dox: New. Introduce labeling module. + + * mln/labeling/background.hh, + * mln/labeling/colorize.hh, + * mln/labeling/compute.hh, + * mln/labeling/compute_image.hh, + * mln/labeling/flat_zones.hh, + * mln/labeling/foreground.hh, + * mln/labeling/mean_values.hh, + * mln/labeling/pack.hh, + * mln/labeling/regional_maxima.hh, + * mln/labeling/regional_minima.hh, + * mln/labeling/relabel.hh, + * mln/labeling/superpose.hh, + * mln/labeling/value.hh, + * mln/labeling/value_and_compute.hh, + * mln/labeling/wrap.hh: Set documentation as part of the labeling + group. + +2013-04-17 Guillaume Lazzara <z(a)lrde.epita.fr> + Add documentation for mln_concrete and mln_ch_value. * mln/trait/ch_value.hh, diff --git a/milena/doc/mln/labeling/labeling.dox b/milena/doc/mln/labeling/labeling.dox new file mode 100644 index 0000000..c0b09c4 --- /dev/null +++ b/milena/doc/mln/labeling/labeling.dox @@ -0,0 +1,6 @@ +/*! \defgroup labeling Image Labeling + * + * \brief All labeling routines provided in Milena. + * + * \ingroup modroutines + */ diff --git a/milena/mln/labeling/background.hh b/milena/mln/labeling/background.hh index 7441504..b60dbb2 100644 --- a/milena/mln/labeling/background.hh +++ b/milena/mln/labeling/background.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -54,6 +55,7 @@ namespace mln * value set to \c false. * * \see mln::labeling::value + * \ingroup labeling */ template <typename I, typename N, typename L> mln_ch_value(I, L) diff --git a/milena/mln/labeling/colorize.hh b/milena/mln/labeling/colorize.hh index 52a76fd..1e39e78 100644 --- a/milena/mln/labeling/colorize.hh +++ b/milena/mln/labeling/colorize.hh @@ -57,17 +57,19 @@ namespace mln } - /// Create a new color image from a labeled image and fill each component - /// with a random color. - /*! - * litera::black is used for component 0, e.g. the background. - * Min and max values for RGB values can be set through the global - * variables mln::labeling::colorize_::min_value and - * mln::labeling::colorize_::max_value. - * - * \param[in] value value type used in the returned image. - * \param[in] labeled_image A labeled image (\sa labeling::blobs). - * \param[in] nlabels Number of labels. + /*! \brief Create a new color image from a labeled image and fill each component + with a random color. + + litera::black is used for component 0, e.g. the background. + Min and max values for RGB values can be set through the global + variables mln::labeling::colorize_::min_value and + mln::labeling::colorize_::max_value. + + \param[in] value value type used in the returned image. + \param[in] labeled_image A labeled image (\sa labeling::blobs). + \param[in] nlabels Number of labels. + + \ingroup labeling */ template <typename V, typename L> mln_ch_value(L, V) @@ -76,16 +78,26 @@ namespace mln const mln_value(L)& nlabels); - /// \overload - // + /*! \overload + The number of labels is re-computed. + + \warning Computing the number of labels shall add extra + computation time. + + \ingroup labeling + */ template <typename V, typename L> mln_ch_value(L, V) colorize(const V& value, const Image<L>& labeled_image); - /// \overload - // + /*! \overload + + Colorize labeled image with value::rgb8. + + \ingroup labeling + */ template <typename L> mln_ch_value(L, mln::value::rgb8) colorize(const Image<L>& input, diff --git a/milena/mln/labeling/compute.hh b/milena/mln/labeling/compute.hh index cc4c234..cd7d727 100644 --- a/milena/mln/labeling/compute.hh +++ b/milena/mln/labeling/compute.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2008, 2009, 2010, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2010, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -60,15 +60,17 @@ namespace mln namespace labeling { - /// Compute an accumulator onto the pixel values of the image \p input. - /// for each component of the image \p label. - /// - /// \param[in] a An accumulator. - /// \param[in] input The input image. - /// \param[in] label The labeled image. - /// \param[in] nlabels The number of labels in \p label. - /// \return A util::array of accumulator result (one result per label). - // + /*! \brief Compute an accumulator onto the pixel values of the image \p input. + for each component of the image \p label. + + \param[in] a An accumulator. + \param[in] input The input image. + \param[in] label The labeled image. + \param[in] nlabels The number of labels in \p label. + \return A util::array of accumulator result (one result per label). + + \ingroup labeling + */ template <typename A, typename I, typename L> util::array<mln_result(A)> compute(const Accumulator<A>& a, @@ -77,15 +79,17 @@ namespace mln const mln_value(L)& nlabels); - /// Compute an accumulator onto the pixel values of the image \p input. - /// for each component of the image \p label. - /// - /// \param[in] a A meta-accumulator. - /// \param[in] input The input image. - /// \param[in] label The labeled image. - /// \param[in] nlabels The number of labels in \p label. - /// \return A util::array of accumulator result (one result per label). - // + /*! \brief Compute an accumulator onto the pixel values of the image \p input. + for each component of the image \p label. + + \param[in] a A meta-accumulator. + \param[in] input The input image. + \param[in] label The labeled image. + \param[in] nlabels The number of labels in \p label. + \return A util::array of accumulator result (one result per label). + + \ingroup labeling + */ template <typename A, typename I, typename L> util::array<mln_meta_accu_result(A, mln_value(I))> compute(const Meta_Accumulator<A>& a, @@ -94,14 +98,16 @@ namespace mln const mln_value(L)& nlabels); - /// Compute an accumulator onto the pixel sites of each component domain of - /// \p label. - /// - /// \param[in] a An accumulator. - /// \param[in] label The labeled image. - /// \param[in] nlabels The number of labels in \p label. - /// \return A util::array of accumulator result (one result per label). - // + /*! Compute an accumulator onto the pixel sites of each component domain of + \p label. + + \param[in] a An accumulator. + \param[in] label The labeled image. + \param[in] nlabels The number of labels in \p label. + \return A util::array of accumulator result (one result per label). + + \ingroup labeling + */ template <typename A, typename L> util::array<mln_result(A)> compute(const Accumulator<A>& a, @@ -109,14 +115,16 @@ namespace mln const mln_value(L)& nlabels); - /// Compute an accumulator onto the pixel sites of each component domain of - /// \p label. - /// - /// \param[in] a A meta-accumulator. - /// \param[in] label The labeled image. - /// \param[in] nlabels The number of labels in \p label. - /// \return A util::array of accumulator result (one result per label). - // + /*! \brief Compute an accumulator onto the pixel sites of each component domain of + \p label. + + \param[in] a A meta-accumulator. + \param[in] label The labeled image. + \param[in] nlabels The number of labels in \p label. + \return A util::array of accumulator result (one result per label). + + \ingroup labeling + */ template <typename A, typename L> util::array<mln_meta_accu_result(A, mln_psite(L))> compute(const Meta_Accumulator<A>& a, @@ -124,15 +132,17 @@ namespace mln const mln_value(L)& nlabels); - /// Compute an accumulator onto the pixel values of the image \p input. - /// for each component of the image \p label. - /// - /// \param[in] a An array of accumulator. - /// \param[in] input The input image. - /// \param[in] label The labeled image. - /// \param[in] nlabels The number of labels in \p label. - /// \return A util::array of accumulator result (one result per label). - // + /*! \brief Compute an accumulator onto the pixel values of the image \p input. + for each component of the image \p label. + + \param[in] a An array of accumulator. + \param[in] input The input image. + \param[in] label The labeled image. + \param[in] nlabels The number of labels in \p label. + \return A util::array of accumulator result (one result per label). + + \ingroup labeling + */ template <typename A, typename I, typename L> util::array<mln_result(A)> compute(util::array<A>& a, diff --git a/milena/mln/labeling/compute_image.hh b/milena/mln/labeling/compute_image.hh index 4baea29..6de1d88 100644 --- a/milena/mln/labeling/compute_image.hh +++ b/milena/mln/labeling/compute_image.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2013 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -49,16 +50,19 @@ namespace mln namespace labeling { - /// Compute an accumulator onto the pixel values of the image \p input. - /// for each component of the image \p label. - /// - /// \param[in] a The mln::p_array of accumulator result. - /// \param[in] input The input image (values). - /// \param[in] labels The label image. - /// \param[in] nlabels The count of labels. - /// - /// \return The image where labels are replaced by the result of - /// the accumulator. + /*! Compute an accumulator onto the pixel values of the image \p input. + for each component of the image \p label. + + \param[in] a The mln::p_array of accumulator result. + \param[in] input The input image (values). + \param[in] labels The label image. + \param[in] nlabels The count of labels. + + \return The image where labels are replaced by the result of + the accumulator. + + \ingroup labeling + */ template <typename A, typename I, typename L> mln_ch_value(L, mln_result(A)) compute_image(const util::array<mln_result(A)>& a, @@ -66,17 +70,19 @@ namespace mln const Image<L>& labels, const mln_value(L)& nlabels); - /// Compute an accumulator onto the pixel values of the image \p input. - /// for each component of the image \p label. - /// - /// \param[in] accu The accumulator. - /// \param[in] input The input image (values). - /// \param[in] labels The label image. - /// \param[in] nlabels The count of labels. - /// - /// \return The image where labels are replaced by the result of - /// the accumulator. - /// + /*! \brief Compute an accumulator onto the pixel values of the + image \p input. for each component of the image \p label. + + \param[in] accu The accumulator. + \param[in] input The input image (values). + \param[in] labels The label image. + \param[in] nlabels The count of labels. + + \return The image where labels are replaced by the result of + the accumulator. + + \ingroup labeling + */ template <typename A, typename I, typename L> inline mln_ch_value(L, mln_result(A)) @@ -86,17 +92,19 @@ namespace mln const mln_value(L)& nlabels); - /// Compute an accumulator onto the pixel values of the image \p input. - /// for each component of the image \p label. - /// - /// \param[in] accu The meta-accumulator. - /// \param[in] input The input image (values). - /// \param[in] labels The label image. - /// \param[in] nlabels The count of labels. - /// - /// \return The image where labels are replaced by the result of - /// the accumulator. - /// + /*! \brief Compute an accumulator onto the pixel values of the + image \p input. for each component of the image \p label. + + \param[in] accu The meta-accumulator. + \param[in] input The input image (values). + \param[in] labels The label image. + \param[in] nlabels The count of labels. + + \return The image where labels are replaced by the result of + the accumulator. + + \ingroup labeling + */ template <typename A, typename I, typename L> inline mln_ch_value(L, mln_meta_accu_result(A, mln_value(I))) diff --git a/milena/mln/labeling/flat_zones.hh b/milena/mln/labeling/flat_zones.hh index 683a17d..2d32eb4 100644 --- a/milena/mln/labeling/flat_zones.hh +++ b/milena/mln/labeling/flat_zones.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009, 2010, 2011 EPITA Research and +// Copyright (C) 2007, 2008, 2009, 2010, 2011, 2013 EPITA Research and // Development Laboratory (LRDE) // // This file is part of Olena. @@ -42,13 +42,15 @@ namespace mln namespace labeling { - /// Connected component labeling of the flat zones of an image. - /// - /// \param[in] input The input image. - /// \param[in] nbh The connexity of the flat zones. - /// \param[out] nlabels The number of labels. - /// \return The label image. - /// + /*! \brief Connected component labeling of the flat zones of an image. + + \param[in] input The input image. + \param[in] nbh The connexity of the flat zones. + \param[out] nlabels The number of labels. + \return The label image. + + \ingroup labeling + */ template <typename I, typename N, typename L> mln_ch_value(I, L) flat_zones(const Image& input, const Neighborhood<N>& nbh, diff --git a/milena/mln/labeling/foreground.hh b/milena/mln/labeling/foreground.hh index cb9c891..06bc148 100644 --- a/milena/mln/labeling/foreground.hh +++ b/milena/mln/labeling/foreground.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -40,8 +41,8 @@ namespace mln namespace labeling { - /*! Connected component labeling of the object part in a binary - * image. + /*! \brief Connected component labeling of the object part in a + * binary image. * * \param[in] input The input image. * \param[in] nbh The connexity of the foreground. @@ -54,6 +55,7 @@ namespace mln * value set to \c true. * * \see mln::labeling::value + * \ingroup labeling */ template <typename I, typename N, typename L> mln_ch_value(I, L) diff --git a/milena/mln/labeling/mean_values.hh b/milena/mln/labeling/mean_values.hh index b8cef49..6bb4cd0 100644 --- a/milena/mln/labeling/mean_values.hh +++ b/milena/mln/labeling/mean_values.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2013 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -60,6 +61,14 @@ namespace mln namespace labeling { + /*! \brief Construct an image of mean values from a labeled image. + + \param[in] input An image. + \param[in] lbl A labeled image. + \param[in] nlabels The number of computed labels. + + \ingroup labeling + */ template <typename I, typename L> mln_concrete(I) mean_colors(const Image& input, diff --git a/milena/mln/labeling/pack.hh b/milena/mln/labeling/pack.hh index 999f129..1f10ef8 100644 --- a/milena/mln/labeling/pack.hh +++ b/milena/mln/labeling/pack.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2013 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -48,21 +49,34 @@ namespace mln namespace labeling { - /// Relabel a labeled image in order to have a contiguous labeling. - /// - /// \param[in] label The labeled image. - /// \param[out] new_nlabels The number of labels after relabeling. - /// \param[out] repack_fun The function used to repack the labels. - /// - /// \return The relabeled image. - // + /*! \brief Relabel a labeled image in order to have a contiguous + labeling. + + \param[in] label The labeled image. + \param[out] new_nlabels The number of labels after relabeling. + \param[out] repack_fun The function used to repack the labels. + + \return The relabeled image. + + \ingroup labeling + */ template <typename I> mln_concrete(I) pack(const Image& label, mln_value(I)& new_nlabels, fun::i2v::array<mln_value(I)>& repack_fun); - /// \overload + /*! \overload + + Rely on a default relabeling function that guaranty contiguous + labeling. + + \warning Don't expect any label from \p label to be preserved. + + \sa make::relabelfun + + \ingroup labeling + */ template <typename I> mln_concrete(I) pack(const Image& label, mln_value(I)& new_nlabels); diff --git a/milena/mln/labeling/regional_maxima.hh b/milena/mln/labeling/regional_maxima.hh index 568fde8..da2a4c3 100644 --- a/milena/mln/labeling/regional_maxima.hh +++ b/milena/mln/labeling/regional_maxima.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development +// Copyright (C) 2007, 2008, 2009, 2013 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -44,14 +44,15 @@ namespace mln namespace labeling { - /*! Connected component labeling of the regional maxima of an - * image. - * - * \param[in] input The input image. - * \param[in] nbh The connexity of the regional maxima. - * \param[out] nlabels The number of labeled regions. - * \return The label image. - * + /*! \brief Connected component labeling of the regional maxima of an + image. + + \param[in] input The input image. + \param[in] nbh The connexity of the regional maxima. + \param[out] nlabels The number of labeled regions. + \return The label image. + + \ingroup labeling */ template <typename I, typename N, typename L> mln_ch_value(I, L) diff --git a/milena/mln/labeling/regional_minima.hh b/milena/mln/labeling/regional_minima.hh index 5a6271e..ffc4de6 100644 --- a/milena/mln/labeling/regional_minima.hh +++ b/milena/mln/labeling/regional_minima.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development +// Copyright (C) 2007, 2008, 2009, 2013 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -44,14 +44,15 @@ namespace mln namespace labeling { - /*! Connected component labeling of the regional minima of an - * image. - * - * \param[in] input The input image. - * \param[in] nbh The connexity of the regional minima. - * \param[out] nlabels The number of labeled regions. - * \return The label image. - * + /*! \brief Connected component labeling of the regional minima of + an image. + + \param[in] input The input image. + \param[in] nbh The connexity of the regional minima. + \param[out] nlabels The number of labeled regions. + \return The label image. + + \ingroup labeling */ template <typename I, typename N, typename L> mln_ch_value(I, L) diff --git a/milena/mln/labeling/relabel.hh b/milena/mln/labeling/relabel.hh index 7f304ee..1683e7d 100644 --- a/milena/mln/labeling/relabel.hh +++ b/milena/mln/labeling/relabel.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2010 EPITA Research and Development +// Copyright (C) 2008, 2009, 2010, 2013 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -47,15 +47,18 @@ namespace mln namespace labeling { - /// Remove components and relabel a labeled image. - /// \param[in] label the labeled image. - /// \param[in] nlabels the number of labels in \p label. - /// \param[out] new_nlabels the number of labels after relabeling. - /// \param[in] fv2b function returning whether a label must be replaced - /// by the background. - /// - /// \return the relabeled image. - // + /*! \brief Remove components and relabel a labeled image. + + \param[in] label the labeled image. + \param[in] nlabels the number of labels in \p label. + \param[out] new_nlabels the number of labels after relabeling. + \param[in] fv2b function returning whether a label must be replaced + by the background. + + \return the relabeled image. + + \ingroup labeling + */ template <typename I, typename F> mln_concrete(I) relabel(const Image& label, @@ -64,14 +67,16 @@ namespace mln const Function_v2b<F>& fv2b); - /// Remove components and relabel a labeled image. - /// \param[in] label the labeled image. - /// \param[in] nlabels the number of labels in \p label. - /// \param[in] fv2v function returning the new component id for each pixel - /// value. - /// - /// \return the relabeled image. - // + /*! \brief Remove components and relabel a labeled image. + + \param[in] label the labeled image. + \param[in] nlabels the number of labels in \p label. + \param[in] fv2v function returning the new component id for each pixel + value. + + \return the relabeled image. + \ingroup labeling + */ template <typename I, typename F> mln_concrete(I) relabel(const Image& label, @@ -79,12 +84,15 @@ namespace mln const Function_v2v<F>& fv2v); - /// Remove components and relabel a labeled image inplace. - /// \param[in, out] label the labeled image. - /// \param[in] nlabels the number of labels in \p label. - /// \param[in] fv2b function returning whether a label must be replaced - /// by the background. - // + /*! \brief Remove components and relabel a labeled image inplace. + + \param[in, out] label the labeled image. + \param[in] nlabels the number of labels in \p label. + \param[in] fv2b function returning whether a label must be replaced + by the background. + + \ingroup labeling + */ template <typename I, typename F> void relabel_inplace(Image& label, @@ -92,12 +100,15 @@ namespace mln const Function_v2b<F>& fv2b); - /// Remove components and relabel a labeled image inplace. - /// \param[in, out] label the labeled image. - /// \param[in] nlabels the number of labels in \p label. - /// \param[in] fv2v function returning the new component id for each - /// pixel value. - // + /*! \brief Remove components and relabel a labeled image inplace. + + \param[in, out] label the labeled image. + \param[in] nlabels the number of labels in \p label. + \param[in] fv2v function returning the new component id for each + pixel value. + + \ingroup labeling + */ template <typename I, typename F> void relabel_inplace(Image& label, diff --git a/milena/mln/labeling/superpose.hh b/milena/mln/labeling/superpose.hh index 641b4bb..2b4a7d7 100644 --- a/milena/mln/labeling/superpose.hh +++ b/milena/mln/labeling/superpose.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2009, 2010 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2009, 2010, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -66,6 +66,7 @@ namespace mln @pre \p rhs and lhs must have the same domain. @pre \p The value type of rhs must be convertible towards lhs's. + \ingroup labeling */ template <typename I, typename J> mln_concrete(I) diff --git a/milena/mln/labeling/value.hh b/milena/mln/labeling/value.hh index 069b2a1..6a60ee5 100644 --- a/milena/mln/labeling/value.hh +++ b/milena/mln/labeling/value.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2010 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2010, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -44,15 +44,17 @@ namespace mln namespace labeling { - /// \brief Connected component labeling of the image sites at a given - /// value. - /// - /// \param[in] input The input image. - /// \param[in] val The value to consider. - /// \param[in] nbh The connectivity of components. - /// \param[out] nlabels The number of labels. - /// \return The label image. - // + /*! \brief Connected component labeling of the image sites at a + given value. + + \param[in] input The input image. + \param[in] val The value to consider. + \param[in] nbh The connectivity of components. + \param[out] nlabels The number of labels. + \return The label image. + + \ingroup labeling + */ template <typename I, typename N, typename L> mln_ch_value(I, L) value(const Image& input, const mln_value(I)& val, diff --git a/milena/mln/labeling/value_and_compute.hh b/milena/mln/labeling/value_and_compute.hh index 4619e1a..913d571 100644 --- a/milena/mln/labeling/value_and_compute.hh +++ b/milena/mln/labeling/value_and_compute.hh @@ -46,16 +46,18 @@ namespace mln namespace labeling { - /// \brief Connected component labeling of the image sites at a given - /// value. - /// - /// \param[in] input The input image. - /// \param[in] val The value to consider. - /// \param[in] nbh The connectivity of components. - /// \param[out] nlabels The number of labels. - /// \param[in] accu The accumulator to be computed. - /// \return The label image. - // + /*! \brief Connected component labeling of the image sites at a given + value. + + \param[in] input The input image. + \param[in] val The value to consider. + \param[in] nbh The connectivity of components. + \param[out] nlabels The number of labels. + \param[in] accu The accumulator to be computed. + \return The label image. + + \ingroup labeling + */ template <typename I, typename N, typename L, typename A> util::couple<mln_ch_value(I,L), util::couple<util::array<mln_result(A)>, diff --git a/milena/mln/labeling/wrap.hh b/milena/mln/labeling/wrap.hh index 76426f2..1c5b64f 100644 --- a/milena/mln/labeling/wrap.hh +++ b/milena/mln/labeling/wrap.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2013 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -45,23 +46,29 @@ namespace mln namespace labeling { - /// Wrap labels such as 0 -> 0 and [1, lmax] maps to [1, - /// Lmax] (using modulus). - /// - /// \param[in] value_type The type used to wrap the label type. - /// \param[in] input The label image. - /// - /// \return A new image with values wrapped with type V. + /*! \brief Wrap labels such as 0 -> 0 and [1, lmax] maps to [1, + Lmax] (using modulus). + + \param[in] value_type The type used to wrap the label type. + \param[in] input The label image. + + \return A new image with values wrapped with type V. + + \ingroup labeling + */ template <typename V, typename I> mln_ch_value(I,V) wrap(const V& value_type, const Image& input); - /// Wrap labels such as 0 -> 0 and [1, lmax] maps to [1, - /// Lmax] (using modulus). Use label_8 as label type. - /// - /// \param[in] input The label image. - /// - /// \return A new image with values wrapped with type label_8. + /*! \brief Wrap labels such as 0 -> 0 and [1, lmax] maps to [1, + Lmax] (using modulus). Use label_8 as label type. + + \param[in] input The label image. + + \return A new image with values wrapped with type label_8. + + \ingroup labeling + */ template <typename I> mln_ch_value(I, mln::value::label_8) wrap(const Image& input); -- 1.7.2.5

1 0

olena-2.0-532-gce86917 Add documentation for mln_concrete and mln_ch_value.
by Guillaume Lazzara 17 Apr '13

17 Apr '13

* mln/trait/ch_value.hh, * mln/trait/concrete.hh: Here. --- milena/ChangeLog | 7 ++++ milena/mln/trait/ch_value.hh | 66 +++++++++++++++++++++++++++++++++++++++++- milena/mln/trait/concrete.hh | 65 ++++++++++++++++++++++++++++++++++++++++- 3 files changed, 135 insertions(+), 3 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 76aef9a..706b503 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,12 @@ 2013-04-17 Guillaume Lazzara <z(a)lrde.epita.fr> + Add documentation for mln_concrete and mln_ch_value. + + * mln/trait/ch_value.hh, + * mln/trait/concrete.hh: Here. + +2013-04-17 Guillaume Lazzara <z(a)lrde.epita.fr> + Add explanations on compilation with multiple files. * doc/examples/multi_files_f1.cc.raw, diff --git a/milena/mln/trait/ch_value.hh b/milena/mln/trait/ch_value.hh index eb120a1..87afc0a 100644 --- a/milena/mln/trait/ch_value.hh +++ b/milena/mln/trait/ch_value.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development +// Copyright (C) 2007, 2008, 2009, 2013 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -36,7 +36,16 @@ # include <mln/trait/ch_function_value.hh> +/*! Macros provided for convenience. Should be used in a templated + function only. + \relates mln::trait::ch_value +*/ # define mln_ch_value(I, V) typename mln::trait::ch_value< I, V >::ret + +/*! Macros provided for convenience. Should be used in a + non-templated function only. + \relates mln::trait::ch_value +*/ # define mln_ch_value_(I, V) mln::trait::ch_value< I, V >::ret @@ -217,6 +226,61 @@ namespace mln } // end of namespace mln::trait::impl + + /*! \brief Compute the concrete type of an image type and change + the value type. + + \tparam I An image type. + + This macro is used to compute the most appropriate concrete image + type to be used to store a copy of an image of type I. + + A concrete image type is an image type storing all its site + values in a single memory buffer. For instance, mln::image1d, + mln::image2d, mln::image3d are considered as concrete types. + Image morphers are not concrete types since they can alter, on + the fly, the domain and the values. + + This macro is usually used while writing generic algorithms to + handle all possible cases while image morphers and concrete images + are interacting. + + Compared to mln::trait::concrete, this trait can change the + value type of the computed image type. + + Few examples: + \code + mln_ch_value(mln::image2d<int>,int) => mln::image2d<int> + mln_ch_value(mln::image2d<int>,bool) => mln::image2d<bool> + \endcode + + Therefore, you can safely write the following code: + \code + template<typename I> + mln_ch_value(I,bool) my_function(const Image& ima) + { + mln_ch_value(I,bool) output; + ... + return output; + } + + int main() + { + image2d<int> ima; + image2d<bool> result = my_function(ima); + } + \endcode + + Computing a type with trait::concrete can be done using macros + mln_ch_value() and mln_ch_value_(). + + Note that, due to C++ syntax ambiguities, mln_ch_value() should + be used in a templated function whereas mln_ch_value_() shoud be + used in a non-templated function. + + If you are not sure of the concrete type that should be returned + by the macro, take a look at mln_var() which can guess it for you. + */ template <typename I, typename V> struct ch_value { diff --git a/milena/mln/trait/concrete.hh b/milena/mln/trait/concrete.hh index 935cc9a..590409c 100644 --- a/milena/mln/trait/concrete.hh +++ b/milena/mln/trait/concrete.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -32,8 +33,16 @@ # include <mln/trait/ch_value.hh> - +/*! Macros provided for convenience. Should be used in a templated + function only. + \relates mln::trait::concrete +*/ # define mln_concrete(I) typename mln::trait::concrete::ret + +/*! Macros provided for convenience. Should be used in a + non-templated function only. + \relates mln::trait::concrete +*/ # define mln_concrete_(I) mln::trait::concrete::ret @@ -43,6 +52,58 @@ namespace mln namespace trait { + /*! + \brief Compute the concrete type of an image type. + + \tparam I An image type. + + This macro is used to compute the most appropriate concrete image + type to be used to store a copy of an image of type I. + + A concrete image type is an image type storing all its site + values in a single memory buffer. For instance, mln::image1d, + mln::image2d, mln::image3d are considered as concrete types. + Image morphers are not concrete types since they can alter, on + the fly, the domain and the values. + + This macro is usually used while writing generic algorithms to + handle all possible cases while image morphers and concrete images + are interacting. + + Few examples: + + \code + mln_concrete(mln::image2d<int>) => mln::image2d<int> + mln_concrete(mln::extended<mln::image2d<int> >) => mln::image2d<int> + \endcode + + Therefore, you can safely write the following code: + \code + template<typename I> + mln_concrete(I) my_function(const Image& ima) + { + mln_ch_value(I,bool) output; + ... + return output; + } + + int main() + { + image2d<int> ima; + image2d<int> result = my_function(ima); + } + \endcode + + Computing a type with trait::concrete can be done using macros + mln_concrete() and mln_concrete_(). + + Note that, due to C++ syntax ambiguities, mln_concrete() should + be used in a templated function whereas mln_concrete_() shoud be + used in a non-templated function. + + If you are not sure of the concrete type that should be returned + by the macro, take a look at mln_var() which can guess it for you. + */ template <typename I> struct concrete { -- 1.7.2.5

1 0