[Olena-patches] olena: olena-2.0-556-g0df5023 Create sub-modules in image geometry module.

* doc/mln/geom/geom.dox: Add cropping sub-module. * doc/mln/transformation.dox: Add new sub-modules. * mln/binarization/threshold.hh: Move to conversion module. * mln/geom/crop.hh, * mln/geom/crop_without_localization.hh, * mln/geom/horizontal_symmetry.hh, * mln/geom/rotate.hh, * mln/geom/translate.hh, * mln/geom/vertical_symmetry.hh, * mln/registration/icp.hh, * mln/subsampling/antialiased.hh, * mln/upscaling/art/scale2x.hh, * mln/upscaling/art/scale3x.hh: Move to newly created sub-modules. --- milena/ChangeLog | 21 +++++++++++++ milena/doc/mln/geom/geom.dox | 7 ++++ milena/doc/mln/transformation.dox | 41 ++++++++++++++++++++++++++ milena/mln/binarization/threshold.hh | 2 +- milena/mln/geom/crop.hh | 2 +- milena/mln/geom/crop_without_localization.hh | 2 +- milena/mln/geom/horizontal_symmetry.hh | 2 +- milena/mln/geom/rotate.hh | 10 +++--- milena/mln/geom/translate.hh | 10 +++--- milena/mln/geom/vertical_symmetry.hh | 2 +- milena/mln/registration/icp.hh | 4 +- milena/mln/subsampling/antialiased.hh | 4 +- milena/mln/upscaling/art/scale2x.hh | 2 +- milena/mln/upscaling/art/scale3x.hh | 2 +- 14 files changed, 90 insertions(+), 21 deletions(-) create mode 100644 milena/doc/mln/geom/geom.dox create mode 100644 milena/doc/mln/transformation.dox diff --git a/milena/ChangeLog b/milena/ChangeLog index bd4a0d2..334f804 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,26 @@ 2013-04-19 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + Create sub-modules in image geometry module. + + * doc/mln/geom/geom.dox: Add cropping sub-module. + + * doc/mln/transformation.dox: Add new sub-modules. + + * mln/binarization/threshold.hh: Move to conversion module. + + * mln/geom/crop.hh, + * mln/geom/crop_without_localization.hh, + * mln/geom/horizontal_symmetry.hh, + * mln/geom/rotate.hh, + * mln/geom/translate.hh, + * mln/geom/vertical_symmetry.hh, + * mln/registration/icp.hh, + * mln/subsampling/antialiased.hh, + * mln/upscaling/art/scale2x.hh, + * mln/upscaling/art/scale3x.hh: Move to newly created sub-modules. + +2013-04-19 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + * doc/mln/convert.dox: Fix typos. 2013-04-19 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; diff --git a/milena/doc/mln/geom/geom.dox b/milena/doc/mln/geom/geom.dox new file mode 100644 index 0000000..fae82c5 --- /dev/null +++ b/milena/doc/mln/geom/geom.dox @@ -0,0 +1,7 @@ +/*! \defgroup geomcrop Cropping + * + * \brief All crop algorithms. + * + * \ingroup mlngeom +*/ + diff --git a/milena/doc/mln/transformation.dox b/milena/doc/mln/transformation.dox new file mode 100644 index 0000000..6b005e4 --- /dev/null +++ b/milena/doc/mln/transformation.dox @@ -0,0 +1,41 @@ +/*! \defgroup transformationrotate Rotation + * + * \brief All Rotation algorithms. + * + * \ingroup mlntransformation + */ + +/*! \defgroup transformationtranslate Translation + * + * \brief All translation algorithms. + * + * \ingroup mlntransformation + */ + +/*! \defgroup transformationupscaling Upscaling + * + * \brief All upscaling algorithms. + * + * \ingroup mlntransformation + */ + +/*! \defgroup transformationsubsampling Subsampling + * + * \brief All subsampling algorithms. + * + * \ingroup mlntransformation + */ + +/*! \defgroup transformationregistration Registration + * + * \brief All registration algorithms. + * + * \ingroup mlntransformation + */ + +/*! \defgroup transformationsymmetry Symmetry + * + * \brief All symmetry algorithms. + * + * \ingroup mlntransformation + */ diff --git a/milena/mln/binarization/threshold.hh b/milena/mln/binarization/threshold.hh index f2b1996..80dbd06 100644 --- a/milena/mln/binarization/threshold.hh +++ b/milena/mln/binarization/threshold.hh @@ -51,7 +51,7 @@ namespace mln If input(p) is greater or equal than the threshold, the value in the output image in the same point will be TRUE, else FALSE. - \ingroup mlngeom + \ingroup convert */ template <typename I> mln_ch_value(I, bool) diff --git a/milena/mln/geom/crop.hh b/milena/mln/geom/crop.hh index 7f557be..328fbe4 100644 --- a/milena/mln/geom/crop.hh +++ b/milena/mln/geom/crop.hh @@ -43,7 +43,7 @@ namespace mln /*! \brief Crop an image - \ingroup mlntransformation + \ingroup transformationcrop */ template <typename I, typename B> mln_concrete(I) crop(const Image<I>& input, const Box<B>& b); diff --git a/milena/mln/geom/crop_without_localization.hh b/milena/mln/geom/crop_without_localization.hh index b2a5858..6c5a395 100644 --- a/milena/mln/geom/crop_without_localization.hh +++ b/milena/mln/geom/crop_without_localization.hh @@ -45,7 +45,7 @@ namespace mln /*! \brief Crop an image. Localization between input and output * may not be preserved. - \ingroup mlntransformation + \ingroup transformationcrop */ template <typename I, typename B> mln_concrete(I) crop_without_localization(const Image<I>& input, diff --git a/milena/mln/geom/horizontal_symmetry.hh b/milena/mln/geom/horizontal_symmetry.hh index 558c26d..d5b075b 100644 --- a/milena/mln/geom/horizontal_symmetry.hh +++ b/milena/mln/geom/horizontal_symmetry.hh @@ -43,7 +43,7 @@ namespace mln /*! \brief Perfoms a horizontal symmetry. - \ingroup mlntransformation + \ingroup transformationsymmetry */ template <typename I> mln_concrete(I) diff --git a/milena/mln/geom/rotate.hh b/milena/mln/geom/rotate.hh index ce0dbef..e9e8f64 100644 --- a/milena/mln/geom/rotate.hh +++ b/milena/mln/geom/rotate.hh @@ -79,7 +79,7 @@ namespace mln \return An image with the same domain as \p input. - \ingroup mlntransformation + \ingroup transformationrotate */ template <typename I, typename Ext, typename S> mln_concrete(I) @@ -89,7 +89,7 @@ namespace mln /*! \overload - \ingroup mlntransformation + \ingroup transformationrotate */ template <typename I, typename Ext> mln_concrete(I) @@ -99,7 +99,7 @@ namespace mln /*! \overload Use literal::zero as default value for the extension. - \ingroup mlntransformation + \ingroup transformationrotate */ template <typename I> mln_concrete(I) @@ -111,7 +111,7 @@ namespace mln FIXME: the return type may be too generic and may lead to invalid covariance. - \ingroup mlntransformation + \ingroup transformationrotate */ template <typename B> B @@ -121,7 +121,7 @@ namespace mln The rotation center \p ref is set to box.pcenter(). - \ingroup mlntransformation + \ingroup transformationrotate */ template <typename B> B diff --git a/milena/mln/geom/translate.hh b/milena/mln/geom/translate.hh index 73a0f72..52b5431 100644 --- a/milena/mln/geom/translate.hh +++ b/milena/mln/geom/translate.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2009, 2012 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2009, 2012, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -68,7 +68,7 @@ namespace mln \return An image with the same domain as \p input. - \ingroup mlntransformation + \ingroup transformationtranslate */ template <typename I, typename V, typename Ext, typename S> mln_concrete(I) @@ -79,7 +79,7 @@ namespace mln /*! \overload - \ingroup mlntransformation + \ingroup transformationtranslate */ template <typename I, typename V, typename Ext> mln_concrete(I) @@ -91,7 +91,7 @@ namespace mln /*! \overload Use literal::zero as default value for the extension. - \ingroup mlntransformation + \ingroup transformationtranslate */ template <typename I, typename V> mln_concrete(I) diff --git a/milena/mln/geom/vertical_symmetry.hh b/milena/mln/geom/vertical_symmetry.hh index 9ae2885..9dd4017 100644 --- a/milena/mln/geom/vertical_symmetry.hh +++ b/milena/mln/geom/vertical_symmetry.hh @@ -43,7 +43,7 @@ namespace mln /*! \brief Perfoms a vertical symmetry. - \ingroup mlntransformation + \ingroup transformationsymmetry */ template <typename I> mln_concrete(I) diff --git a/milena/mln/registration/icp.hh b/milena/mln/registration/icp.hh index 1176802..12ce306 100644 --- a/milena/mln/registration/icp.hh +++ b/milena/mln/registration/icp.hh @@ -109,7 +109,7 @@ namespace mln * * This implementation is based on \cite besl1992pami. * - * \ingroup mlntransformation + * \ingroup transformationregistration */ template <typename P, typename F> std::pair<algebra::quat,mln_vec(P)> @@ -130,7 +130,7 @@ namespace mln * \return the rigid transformation which may be use later to create * a registered image. * - * \ingroup mlntransformation + * \ingroup transformationregistration */ template <typename P, typename F> composed< translation<P::dim,float>,rotation<P::dim,float> > diff --git a/milena/mln/subsampling/antialiased.hh b/milena/mln/subsampling/antialiased.hh index 1bf5f57..8a811f4 100644 --- a/milena/mln/subsampling/antialiased.hh +++ b/milena/mln/subsampling/antialiased.hh @@ -55,7 +55,7 @@ namespace mln values. It can be larger than the minimum size required to store all the image values. - \ingroup mlntransformation + \ingroup transformationsubsampling */ template <typename I> inline @@ -71,7 +71,7 @@ namespace mln The output_domain is set to the minimum domain size required to store all the image values. This is the common use case. - \ingroup mlntransformation + \ingroup transformationsubsampling */ template <typename I> mln_concrete(I) diff --git a/milena/mln/upscaling/art/scale2x.hh b/milena/mln/upscaling/art/scale2x.hh index 2d50bee..59c5efe 100644 --- a/milena/mln/upscaling/art/scale2x.hh +++ b/milena/mln/upscaling/art/scale2x.hh @@ -59,7 +59,7 @@ namespace mln Source: http://en.wikipedia.org/wiki/Pixel_art_scaling_algorithms - \ingroup mlntransformation + \ingroup transformationupscaling */ template <typename I> mln_concrete(I) diff --git a/milena/mln/upscaling/art/scale3x.hh b/milena/mln/upscaling/art/scale3x.hh index 4400a79..3c55592 100644 --- a/milena/mln/upscaling/art/scale3x.hh +++ b/milena/mln/upscaling/art/scale3x.hh @@ -59,7 +59,7 @@ namespace mln Source: http://en.wikipedia.org/wiki/Pixel_art_scaling_algorithms - \ingroup mlntransformation + \ingroup transformationupscaling */ template <typename I> mln_concrete(I) -- 1.7.2.5