[Olena-patches] olena-2.0-551-g61eb85a Introduce image transformation module in documentation.

* doc/mln/main.dox: Create new group. * 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 this new group. --- milena/ChangeLog | 17 +++++++++++++++++ milena/doc/mln/main.dox | 7 +++++++ milena/mln/geom/crop.hh | 6 +++--- milena/mln/geom/crop_without_localization.hh | 6 +++--- milena/mln/geom/horizontal_symmetry.hh | 6 +++--- milena/mln/geom/rotate.hh | 10 +++++----- milena/mln/geom/translate.hh | 8 ++++---- milena/mln/geom/vertical_symmetry.hh | 6 +++--- milena/mln/registration/icp.hh | 3 +++ milena/mln/subsampling/antialiased.hh | 12 ++++++++++-- milena/mln/upscaling/art/scale2x.hh | 6 +++--- milena/mln/upscaling/art/scale3x.hh | 6 +++--- 12 files changed, 64 insertions(+), 29 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index e081229..c4a23a0 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,22 @@ 2013-04-19 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + Introduce image transformation module in documentation. + + * doc/mln/main.dox: Create new group. + + * 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 this new group. + +2013-04-19 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + Make template parameter name more consistant with naming conventions. diff --git a/milena/doc/mln/main.dox b/milena/doc/mln/main.dox index 8cf0f87..8ee0e92 100644 --- a/milena/doc/mln/main.dox +++ b/milena/doc/mln/main.dox @@ -95,3 +95,10 @@ * * \ingroup modroutines */ + +/*! \defgroup mlntransformation Image Transformation + * + * \brief All transformation algorithms. + * + * \ingroup modroutines + */ diff --git a/milena/mln/geom/crop.hh b/milena/mln/geom/crop.hh index 38841f7..7f557be 100644 --- a/milena/mln/geom/crop.hh +++ b/milena/mln/geom/crop.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2011, 2012 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2011, 2012, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -43,7 +43,7 @@ namespace mln /*! \brief Crop an image - \ingroup mlngeom + \ingroup mlntransformation */ 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 9236d33..b2a5858 100644 --- a/milena/mln/geom/crop_without_localization.hh +++ b/milena/mln/geom/crop_without_localization.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2011, 2012 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2011, 2012, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -45,7 +45,7 @@ namespace mln /*! \brief Crop an image. Localization between input and output * may not be preserved. - \ingroup mlngeom + \ingroup mlntransformation */ 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 cff3479..558c26d 100644 --- a/milena/mln/geom/horizontal_symmetry.hh +++ b/milena/mln/geom/horizontal_symmetry.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2010, 2012 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2010, 2012, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -43,7 +43,7 @@ namespace mln /*! \brief Perfoms a horizontal symmetry. - \ingroup mlngeom + \ingroup mlntransformation */ template <typename I> mln_concrete(I) diff --git a/milena/mln/geom/rotate.hh b/milena/mln/geom/rotate.hh index c7b5b3a..ce0dbef 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 mlngeom + \ingroup mlntransformation */ template <typename I, typename Ext, typename S> mln_concrete(I) @@ -89,7 +89,7 @@ namespace mln /*! \overload - \ingroup mlngeom + \ingroup mlntransformation */ 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 mlngeom + \ingroup mlntransformation */ 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 mlngeom + \ingroup mlntransformation */ template <typename B> B @@ -121,7 +121,7 @@ namespace mln The rotation center \p ref is set to box.pcenter(). - \ingroup mlngeom + \ingroup mlntransformation */ template <typename B> B diff --git a/milena/mln/geom/translate.hh b/milena/mln/geom/translate.hh index a949a8c..73a0f72 100644 --- a/milena/mln/geom/translate.hh +++ b/milena/mln/geom/translate.hh @@ -64,11 +64,11 @@ namespace mln of the domain before the translation. \param[in] output_domain The domain of the output image. An invalid domain, causes the routine - to use the translated input_ domain. + to use the translated input domain. \return An image with the same domain as \p input. - \ingroup mlngeom + \ingroup mlntransformation */ template <typename I, typename V, typename Ext, typename S> mln_concrete(I) @@ -79,7 +79,7 @@ namespace mln /*! \overload - \ingroup mlngeom + \ingroup mlntransformation */ 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 mlngeom + \ingroup mlntransformation */ 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 019b866..9ae2885 100644 --- a/milena/mln/geom/vertical_symmetry.hh +++ b/milena/mln/geom/vertical_symmetry.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2010, 2012 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2010, 2012, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -43,7 +43,7 @@ namespace mln /*! \brief Perfoms a vertical symmetry. - \ingroup mlngeom + \ingroup mlntransformation */ template <typename I> mln_concrete(I) diff --git a/milena/mln/registration/icp.hh b/milena/mln/registration/icp.hh index 7c82202..1176802 100644 --- a/milena/mln/registration/icp.hh +++ b/milena/mln/registration/icp.hh @@ -109,6 +109,7 @@ namespace mln * * This implementation is based on \cite besl1992pami. * + * \ingroup mlntransformation */ template <typename P, typename F> std::pair<algebra::quat,mln_vec(P)> @@ -128,6 +129,8 @@ namespace mln * * \return the rigid transformation which may be use later to create * a registered image. + * + * \ingroup mlntransformation */ 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 378f452..1bf5f57 100644 --- a/milena/mln/subsampling/antialiased.hh +++ b/milena/mln/subsampling/antialiased.hh @@ -51,7 +51,11 @@ namespace mln \param[in] output_domain Force output domain. \param[in] border_thickness Force output border thickness. - \ingroup mlngeom + \p output_domain should be large enough to store all the image + values. It can be larger than the minimum size required to store + all the image values. + + \ingroup mlntransformation */ template <typename I> inline @@ -63,7 +67,11 @@ namespace mln /*! \overload - \ingroup mlngeom + + 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 */ template <typename I> mln_concrete(I) diff --git a/milena/mln/upscaling/art/scale2x.hh b/milena/mln/upscaling/art/scale2x.hh index e4a5ae8..2d50bee 100644 --- a/milena/mln/upscaling/art/scale2x.hh +++ b/milena/mln/upscaling/art/scale2x.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. // @@ -59,7 +59,7 @@ namespace mln Source: http://en.wikipedia.org/wiki/Pixel_art_scaling_algorithms - \ingroup mlngeom + \ingroup mlntransformation */ template <typename I> mln_concrete(I) diff --git a/milena/mln/upscaling/art/scale3x.hh b/milena/mln/upscaling/art/scale3x.hh index 5bd94b6..4400a79 100644 --- a/milena/mln/upscaling/art/scale3x.hh +++ b/milena/mln/upscaling/art/scale3x.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. // @@ -59,7 +59,7 @@ namespace mln Source: http://en.wikipedia.org/wiki/Pixel_art_scaling_algorithms - \ingroup mlngeom + \ingroup mlntransformation */ template <typename I> mln_concrete(I) -- 1.7.2.5