[Olena-patches] last-svn-commit-199-g0448a2b Add more documentation on the detach procedure.

* mln/make/detachment.hh: Here. Typo. * mln/topo/detach.hh: Typo. --- milena/ChangeLog | 8 ++++++++ milena/mln/make/detachment.hh | 10 ++++++++-- milena/mln/topo/detach.hh | 10 +++++----- 3 files changed, 21 insertions(+), 7 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index f83deda..ebcec24 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,3 +1,11 @@ +2010-09-01 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + + Add more documentation on the detach procedure. + + * mln/make/detachment.hh: Here. + Typo. + * mln/topo/detach.hh: Typo. + 2010-08-18 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; * mln/topo/skeleton/breadth_first_thinning.hh: Reindent. diff --git a/milena/mln/make/detachment.hh b/milena/mln/make/detachment.hh index 16f4954..16a8c92 100644 --- a/milena/mln/make/detachment.hh +++ b/milena/mln/make/detachment.hh @@ -41,7 +41,7 @@ namespace mln { /** \brief Compute the detachment of the cell corresponding to the - facet \a f to the image \a ima. + facet \a f from the image \a ima. \pre \a f is a facet (it does not belong to any face of higher dimension). @@ -53,7 +53,13 @@ namespace mln couprie.08.pami). We use the following (equivalent) definition: an N-face F in CELL is not in the detachment of CELL from IMA if it is adjacent to at least an (N-1)-face or an (N+1)-face that - does not belong to CELL. */ + does not belong to CELL. + + Moreover, the term detachment does not correspond to the + complex resulting from the collapsing of CELL onto IMA, but + the part that is removed, i.e., the detached part CELL - + ATTACHMENT. It would be wise to rename this routine to + something else. */ template <unsigned D, typename G, typename V> p_set< complex_psite<D, G> > detachment(const complex_psite<D, G>& f, diff --git a/milena/mln/topo/detach.hh b/milena/mln/topo/detach.hh index b310423..6218739 100644 --- a/milena/mln/topo/detach.hh +++ b/milena/mln/topo/detach.hh @@ -27,7 +27,7 @@ # define MLN_TOPO_DETACH_HH /// \file -/// \brief Detachin a cell from a binary complex-based image. +/// \brief Detaching a cell from a binary complex-based image. # include <mln/core/site_set/p_set.hh> # include <mln/core/image/complex_image.hh> @@ -41,10 +41,10 @@ namespace mln { /** Detach the cell corresponding to \a f from \a ima. - - \pre \a f is a facet (it does not belong to any face of higher - dimension). - \pre \a ima is an image of Boolean values. */ + + \pre \a f is a facet (it does not belong to any face of higher + dimension). + \pre \a ima is an image of Boolean values. */ template <unsigned D, typename G> void detach(const complex_psite<D, G>& f, complex_image<D, G, bool>& ima); -- 1.5.6.5