- Olena-patches

olena: branch exp/newdoc updated: olena-2.0-559-ge6d70f7
by git＠lrde.epita.fr 19 Apr '13

19 Apr '13

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Olena, a generic and efficient image processing platform". The branch exp/newdoc has been updated via e6d70f78a13acfa65347e229ef04bdceb2a87f39 (commit) via 0469218d0e308d737baf56a1411993ef220b9c66 (commit) via abe7da9fbe85dbde5b55475a3efbf841bf2e0dbe (commit) via 0df50239629154b1764e5913eca0a4957b3fe8c1 (commit) via f3f7fa20ca15d18317fd31daf7e13efe88f02a45 (commit) from 64752940c947d09ef82306107adde7e9d6f33cda (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- e6d70f7 mln/core/concept/function.hh: Document function interface for each concept. 0469218 Kill Doxygen warnings. abe7da9 Specify conversion formulas for rgb to integer conversion functions. 0df5023 Create sub-modules in image geometry module. f3f7fa2 doc/mln/convert.dox: Fix typos. ----------------------------------------------------------------------- Summary of changes: milena/ChangeLog | 46 ++++++++ milena/doc/mln/convert.dox | 6 +- milena/doc/mln/geom/geom.dox | 7 + milena/doc/mln/transformation.dox | 41 +++++++ milena/mln/binarization/threshold.hh | 2 +- milena/mln/core/concept/function.hh | 160 ++++++++++++++++++++------ milena/mln/data/convert.hh | 2 +- milena/mln/fun/v2v/rgb_to_int_u.hh | 5 + milena/mln/fun/v2v/rgb_to_luma.hh | 5 + 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 +- milena/mln/value/qt/rgb32.hh | 4 +- 20 files changed, 256 insertions(+), 62 deletions(-) create mode 100644 milena/doc/mln/geom/geom.dox create mode 100644 milena/doc/mln/transformation.dox hooks/post-receive -- Olena, a generic and efficient image processing platform

1 0

olena: olena-2.0-559-ge6d70f7 mln/core/concept/function.hh: Document function interface for each concept.
by Guillaume Lazzara 19 Apr '13

19 Apr '13

--- milena/ChangeLog | 5 + milena/mln/core/concept/function.hh | 160 +++++++++++++++++++++++++++-------- 2 files changed, 130 insertions(+), 35 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index cfbca01..851fe53 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,10 @@ 2013-04-19 Guillaume Lazzara <z(a)lrde.epita.fr> + * mln/core/concept/function.hh: Document function interface for + each concept. + +2013-04-19 Guillaume Lazzara <z(a)lrde.epita.fr> + Kill Doxygen warnings. * mln/data/convert.hh: Add a missing \overload. diff --git a/milena/mln/core/concept/function.hh b/milena/mln/core/concept/function.hh index ecd9db0..1da6247 100644 --- a/milena/mln/core/concept/function.hh +++ b/milena/mln/core/concept/function.hh @@ -94,13 +94,31 @@ namespace mln /// \endcond - /// \brief Base class for implementation of function-objects from - /// Nil to value. - /// - /// The parameter \a E is the exact type. - /// - /// \ingroup modfun - // + /*! + \brief Base class for implementation of function-objects from + Nil to value. + + The parameter \a E is the exact type. + + Functions which inherit from this concept must be declared as + follows: + + \code + struct my_function + : Function_n2v<my_function> + { + typedef my_result_type result; + typedef void argument; + + result operator()() const + { + return ...; + } + }; + \endcode + + \ingroup modfun + */ template <typename E> struct Function_n2v : public Function<E> { @@ -121,13 +139,31 @@ namespace mln /// \endcond - /// \brief Base class for implementation of function-objects from - /// value to value. - /// - /// The parameter \a E is the exact type. - /// - /// \ingroup modfun - // + /*! + \brief Base class for implementation of function-objects from + value to value. + + The parameter \a E is the exact type. + + Functions which inherit from this concept must be declared as + follows: + + \code + struct my_function + : Function_v2v<my_function> + { + typedef my_result_type result; + typedef my_argument_type argument; + + result operator()(const argument& v) const + { + return ...; + } + }; + \endcode + + \ingroup modfun + */ template <typename E> struct Function_v2v : public Function<E> { @@ -149,13 +185,31 @@ namespace mln /// \endcond - /// \brief Base class for implementation of function-objects from a - /// value to a Boolean. - /// - /// The parameter \a E is the exact type. - /// - /// \ingroup modfun - // + /*! + \brief Base class for implementation of function-objects from a + value to a Boolean. + + The parameter \a E is the exact type. + + Functions which inherit from this concept must be declared as + follows: + + \code + struct my_function + : Function_v2b<my_function> + { + typedef bool result; + typedef my_argument_type argument; + + result operator()(const argument& v) const + { + return ...; + } + }; + \endcode + + \ingroup modfun + */ template <typename E> struct Function_v2b : public virtual Function_v2v<E> { @@ -178,13 +232,31 @@ namespace mln /// \endcond - /// \brief Base class for implementation of function-objects from a - /// couple of values to a value. - /// - /// The parameter \a E is the exact type. - /// - /// \ingroup modfun - // + /*! + \brief Base class for implementation of function-objects from a + couple of values to a value. + + The parameter \a E is the exact type. + + Functions which inherit from this concept must be declared as + follows: + + \code + struct my_function + : Function_vv2v<my_function> + { + typedef my_result_type result; + typedef my_argument_type argument; + + result operator()(const argument& v1, const argument& v2) const + { + return ...; + } + }; + \endcode + + \ingroup modfun + */ template <typename E> struct Function_vv2v : public Function<E> { @@ -205,13 +277,31 @@ namespace mln /// \endcond - /// \brief Base class for implementation of function-objects from a - /// couple of values to a Boolean. - /// - /// The parameter \a E is the exact type. - /// - /// \ingroup modfun - // + /*! + \brief Base class for implementation of function-objects from a + couple of values to a Boolean. + + The parameter \a E is the exact type. + + Functions which inherit from this concept must be declared as + follows: + + \code + struct my_function + : Function_vv2b<my_function> + { + typedef bool result; + typedef my_argument_type argument; + + result operator()(const argument& v1, const argument& v2) const + { + return ...; + } + }; + \endcode + + \ingroup modfun + */ template <typename E> struct Function_vv2b : public Function<E> { -- 1.7.2.5

1 0

olena: olena-2.0-560-gea3a438 mln/core/concept/function.hh: Document function interface for each concept.
by Guillaume Lazzara 19 Apr '13

19 Apr '13

--- milena/ChangeLog | 5 + milena/mln/core/concept/function.hh | 160 +++++++++++++++++++++++++++-------- 2 files changed, 130 insertions(+), 35 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index a7a9ea8..4b7d2c5 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,10 @@ 2013-04-19 Guillaume Lazzara <z(a)lrde.epita.fr> + * mln/core/concept/function.hh: Document function interface for + each concept. + +2013-04-19 Guillaume Lazzara <z(a)lrde.epita.fr> + Kill Doxygen warnings. * mln/data/convert.hh: Add a missing \overload. diff --git a/milena/mln/core/concept/function.hh b/milena/mln/core/concept/function.hh index ecd9db0..1da6247 100644 --- a/milena/mln/core/concept/function.hh +++ b/milena/mln/core/concept/function.hh @@ -94,13 +94,31 @@ namespace mln /// \endcond - /// \brief Base class for implementation of function-objects from - /// Nil to value. - /// - /// The parameter \a E is the exact type. - /// - /// \ingroup modfun - // + /*! + \brief Base class for implementation of function-objects from + Nil to value. + + The parameter \a E is the exact type. + + Functions which inherit from this concept must be declared as + follows: + + \code + struct my_function + : Function_n2v<my_function> + { + typedef my_result_type result; + typedef void argument; + + result operator()() const + { + return ...; + } + }; + \endcode + + \ingroup modfun + */ template <typename E> struct Function_n2v : public Function<E> { @@ -121,13 +139,31 @@ namespace mln /// \endcond - /// \brief Base class for implementation of function-objects from - /// value to value. - /// - /// The parameter \a E is the exact type. - /// - /// \ingroup modfun - // + /*! + \brief Base class for implementation of function-objects from + value to value. + + The parameter \a E is the exact type. + + Functions which inherit from this concept must be declared as + follows: + + \code + struct my_function + : Function_v2v<my_function> + { + typedef my_result_type result; + typedef my_argument_type argument; + + result operator()(const argument& v) const + { + return ...; + } + }; + \endcode + + \ingroup modfun + */ template <typename E> struct Function_v2v : public Function<E> { @@ -149,13 +185,31 @@ namespace mln /// \endcond - /// \brief Base class for implementation of function-objects from a - /// value to a Boolean. - /// - /// The parameter \a E is the exact type. - /// - /// \ingroup modfun - // + /*! + \brief Base class for implementation of function-objects from a + value to a Boolean. + + The parameter \a E is the exact type. + + Functions which inherit from this concept must be declared as + follows: + + \code + struct my_function + : Function_v2b<my_function> + { + typedef bool result; + typedef my_argument_type argument; + + result operator()(const argument& v) const + { + return ...; + } + }; + \endcode + + \ingroup modfun + */ template <typename E> struct Function_v2b : public virtual Function_v2v<E> { @@ -178,13 +232,31 @@ namespace mln /// \endcond - /// \brief Base class for implementation of function-objects from a - /// couple of values to a value. - /// - /// The parameter \a E is the exact type. - /// - /// \ingroup modfun - // + /*! + \brief Base class for implementation of function-objects from a + couple of values to a value. + + The parameter \a E is the exact type. + + Functions which inherit from this concept must be declared as + follows: + + \code + struct my_function + : Function_vv2v<my_function> + { + typedef my_result_type result; + typedef my_argument_type argument; + + result operator()(const argument& v1, const argument& v2) const + { + return ...; + } + }; + \endcode + + \ingroup modfun + */ template <typename E> struct Function_vv2v : public Function<E> { @@ -205,13 +277,31 @@ namespace mln /// \endcond - /// \brief Base class for implementation of function-objects from a - /// couple of values to a Boolean. - /// - /// The parameter \a E is the exact type. - /// - /// \ingroup modfun - // + /*! + \brief Base class for implementation of function-objects from a + couple of values to a Boolean. + + The parameter \a E is the exact type. + + Functions which inherit from this concept must be declared as + follows: + + \code + struct my_function + : Function_vv2b<my_function> + { + typedef bool result; + typedef my_argument_type argument; + + result operator()(const argument& v1, const argument& v2) const + { + return ...; + } + }; + \endcode + + \ingroup modfun + */ template <typename E> struct Function_vv2b : public Function<E> { -- 1.7.2.5

1 0

olena: olena-2.0-558-g0469218 Kill Doxygen warnings.
by Guillaume Lazzara 19 Apr '13

19 Apr '13

* mln/data/convert.hh: Add a missing \overload. * mln/value/qt/rgb32.hh: Do not force autolink. --- milena/ChangeLog | 8 ++++++++ milena/mln/data/convert.hh | 2 +- milena/mln/value/qt/rgb32.hh | 4 ++-- 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 48baeac..cfbca01 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,13 @@ 2013-04-19 Guillaume Lazzara <z(a)lrde.epita.fr> + Kill Doxygen warnings. + + * mln/data/convert.hh: Add a missing \overload. + + * mln/value/qt/rgb32.hh: Do not force autolink. + +2013-04-19 Guillaume Lazzara <z(a)lrde.epita.fr> + Specify conversion formulas for rgb to integer conversion functions. diff --git a/milena/mln/data/convert.hh b/milena/mln/data/convert.hh index 2c2a4f0..1f7fce3 100644 --- a/milena/mln/data/convert.hh +++ b/milena/mln/data/convert.hh @@ -59,7 +59,7 @@ namespace mln mln_ch_value(I, V) convert(const V& v, const Image& input); - /*! + /*! \overload \brief Convert the image \p input by changing the value type. \overload diff --git a/milena/mln/value/qt/rgb32.hh b/milena/mln/value/qt/rgb32.hh index 329d01d..0638180 100644 --- a/milena/mln/value/qt/rgb32.hh +++ b/milena/mln/value/qt/rgb32.hh @@ -331,13 +331,13 @@ namespace mln /*! - \brief Conversion: Conversion: #value::qt::rgb32 -> bool. + \brief Conversion: Conversion: value::qt::rgb32 -> bool. \ingroup fromto */ void from_to_(const rgb32& from, bool& to); /*! - \brief Conversion: bool -> #value::qt::rgb32. + \brief Conversion: bool -> value::qt::rgb32. \ingroup fromto */ void from_to_(const bool& from, value::qt::rgb32& to); -- 1.7.2.5

1 0

olena: olena-2.0-559-gb2a9988 Kill Doxygen warnings.
by Guillaume Lazzara 19 Apr '13

19 Apr '13

* mln/data/convert.hh: Add a missing \overload. * mln/value/qt/rgb32.hh: Do not force autolink. --- milena/ChangeLog | 8 ++++++++ milena/mln/data/convert.hh | 2 +- milena/mln/value/qt/rgb32.hh | 4 ++-- 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 48c3768..a7a9ea8 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,13 @@ 2013-04-19 Guillaume Lazzara <z(a)lrde.epita.fr> + Kill Doxygen warnings. + + * mln/data/convert.hh: Add a missing \overload. + + * mln/value/qt/rgb32.hh: Do not force autolink. + +2013-04-19 Guillaume Lazzara <z(a)lrde.epita.fr> + Specify conversion formulas for rgb to integer conversion functions. diff --git a/milena/mln/data/convert.hh b/milena/mln/data/convert.hh index 2c2a4f0..1f7fce3 100644 --- a/milena/mln/data/convert.hh +++ b/milena/mln/data/convert.hh @@ -59,7 +59,7 @@ namespace mln mln_ch_value(I, V) convert(const V& v, const Image& input); - /*! + /*! \overload \brief Convert the image \p input by changing the value type. \overload diff --git a/milena/mln/value/qt/rgb32.hh b/milena/mln/value/qt/rgb32.hh index 329d01d..0638180 100644 --- a/milena/mln/value/qt/rgb32.hh +++ b/milena/mln/value/qt/rgb32.hh @@ -331,13 +331,13 @@ namespace mln /*! - \brief Conversion: Conversion: #value::qt::rgb32 -> bool. + \brief Conversion: Conversion: value::qt::rgb32 -> bool. \ingroup fromto */ void from_to_(const rgb32& from, bool& to); /*! - \brief Conversion: bool -> #value::qt::rgb32. + \brief Conversion: bool -> value::qt::rgb32. \ingroup fromto */ void from_to_(const bool& from, value::qt::rgb32& to); -- 1.7.2.5

1 0

olena: olena-2.0-557-gabe7da9 Specify conversion formulas for rgb to integer conversion functions.
by Guillaume Lazzara 19 Apr '13

19 Apr '13

* mln/fun/v2v/rgb_to_int_u.hh, * mln/fun/v2v/rgb_to_luma.hh: Here. --- milena/ChangeLog | 8 ++++++++ milena/mln/fun/v2v/rgb_to_int_u.hh | 5 +++++ milena/mln/fun/v2v/rgb_to_luma.hh | 5 +++++ 3 files changed, 18 insertions(+), 0 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 334f804..48baeac 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,13 @@ 2013-04-19 Guillaume Lazzara <z(a)lrde.epita.fr> + Specify conversion formulas for rgb to integer conversion + functions. + + * mln/fun/v2v/rgb_to_int_u.hh, + * mln/fun/v2v/rgb_to_luma.hh: Here. + +2013-04-19 Guillaume Lazzara <z(a)lrde.epita.fr> + Create sub-modules in image geometry module. * doc/mln/geom/geom.dox: Add cropping sub-module. diff --git a/milena/mln/fun/v2v/rgb_to_int_u.hh b/milena/mln/fun/v2v/rgb_to_int_u.hh index a6a6feb..de9972d 100644 --- a/milena/mln/fun/v2v/rgb_to_int_u.hh +++ b/milena/mln/fun/v2v/rgb_to_int_u.hh @@ -50,6 +50,11 @@ namespace mln \tparam n Defines the number of bits of the integer destination type. + This function computes the mean of the three RGB components: + \verbatim + luma = (red + green + blue) / 3; + \endverbatim + \ingroup modfunv2v convert */ template <unsigned n> diff --git a/milena/mln/fun/v2v/rgb_to_luma.hh b/milena/mln/fun/v2v/rgb_to_luma.hh index 92c603a..3b6ddc2 100644 --- a/milena/mln/fun/v2v/rgb_to_luma.hh +++ b/milena/mln/fun/v2v/rgb_to_luma.hh @@ -46,6 +46,11 @@ namespace mln \brief Conversion function from a RGB value to an integer value type. + This function use the following formula: + \verbatim + luma = 0.299 * red + 0.587 * green + 0.114 * blue; + \endverbatim + \ingroup modfunv2v convert */ template <typename T_luma> -- 1.7.2.5

1 0

olena: olena-2.0-558-g4f717cc Specify conversion formulas for rgb to integer conversion functions.
by Guillaume Lazzara 19 Apr '13

19 Apr '13

* mln/fun/v2v/rgb_to_int_u.hh, * mln/fun/v2v/rgb_to_luma.hh: Here. --- milena/ChangeLog | 8 ++++++++ milena/mln/fun/v2v/rgb_to_int_u.hh | 5 +++++ milena/mln/fun/v2v/rgb_to_luma.hh | 5 +++++ 3 files changed, 18 insertions(+), 0 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 74f08aa..48c3768 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,13 @@ 2013-04-19 Guillaume Lazzara <z(a)lrde.epita.fr> + Specify conversion formulas for rgb to integer conversion + functions. + + * mln/fun/v2v/rgb_to_int_u.hh, + * mln/fun/v2v/rgb_to_luma.hh: Here. + +2013-04-19 Guillaume Lazzara <z(a)lrde.epita.fr> + Create sub-modules in image geometry module. * doc/mln/geom/geom.dox: Add cropping sub-module. diff --git a/milena/mln/fun/v2v/rgb_to_int_u.hh b/milena/mln/fun/v2v/rgb_to_int_u.hh index a6a6feb..de9972d 100644 --- a/milena/mln/fun/v2v/rgb_to_int_u.hh +++ b/milena/mln/fun/v2v/rgb_to_int_u.hh @@ -50,6 +50,11 @@ namespace mln \tparam n Defines the number of bits of the integer destination type. + This function computes the mean of the three RGB components: + \verbatim + luma = (red + green + blue) / 3; + \endverbatim + \ingroup modfunv2v convert */ template <unsigned n> diff --git a/milena/mln/fun/v2v/rgb_to_luma.hh b/milena/mln/fun/v2v/rgb_to_luma.hh index 92c603a..3b6ddc2 100644 --- a/milena/mln/fun/v2v/rgb_to_luma.hh +++ b/milena/mln/fun/v2v/rgb_to_luma.hh @@ -46,6 +46,11 @@ namespace mln \brief Conversion function from a RGB value to an integer value type. + This function use the following formula: + \verbatim + luma = 0.299 * red + 0.587 * green + 0.114 * blue; + \endverbatim + \ingroup modfunv2v convert */ template <typename T_luma> -- 1.7.2.5

1 0

olena: olena-2.0-556-g0df5023 Create sub-modules in image geometry module.
by Guillaume Lazzara 19 Apr '13

19 Apr '13

* 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 <z(a)lrde.epita.fr> + 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 <z(a)lrde.epita.fr> + * doc/mln/convert.dox: Fix typos. 2013-04-19 Guillaume Lazzara <z(a)lrde.epita.fr> 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& input, const Box& 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& 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

1 0

olena: olena-2.0-557-g602fc92 Create sub-modules in image geometry module.
by Guillaume Lazzara 19 Apr '13

19 Apr '13

* 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 6c8c7c7..74f08aa 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,26 @@ 2013-04-19 Guillaume Lazzara <z(a)lrde.epita.fr> + 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 <z(a)lrde.epita.fr> + * doc/mln/convert.dox: Fix typos. 2013-04-19 Guillaume Lazzara <z(a)lrde.epita.fr> 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& input, const Box& 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& 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

1 0

olena: olena-2.0-555-gf3f7fa2 doc/mln/convert.dox: Fix typos.
by Guillaume Lazzara 19 Apr '13

19 Apr '13

--- milena/ChangeLog | 4 ++++ milena/doc/mln/convert.dox | 6 +++--- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index b1cba37..bd4a0d2 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,9 @@ 2013-04-19 Guillaume Lazzara <z(a)lrde.epita.fr> + * doc/mln/convert.dox: Fix typos. + +2013-04-19 Guillaume Lazzara <z(a)lrde.epita.fr> + Add documentation about image conversions. * doc/mln/convert.dox: Add examples and explanations. diff --git a/milena/doc/mln/convert.dox b/milena/doc/mln/convert.dox index 158fb43..60319fd 100644 --- a/milena/doc/mln/convert.dox +++ b/milena/doc/mln/convert.dox @@ -5,7 +5,7 @@ Type conversions in Olena mainly relies on convert::from_to(). This routine works on a single value only. - Type conversion of image value types relies on data::convert. This + Type conversion of image value types relies on data::convert(). This routine relies on convert::from_to(). For each pixel value, convert::from_to() is called. @@ -47,7 +47,7 @@ \code $ g++ -I$OLN/milena main.cc ... - /my/path/to/oln/milena/mln/convert/from_to.hh:152:5: error: ‘check’ is not a member of ‘mln::metal::abort_<mln::value::rgb<8u> >’ + /my/path/to/oln/milena/mln/convert/from_to.hh:152:5: error: 'check' is not a member of 'mln::metal::abort_<mln::value::rgb<8u> >' \endcode Missing conversion is sometimes due to non-trivial @@ -114,7 +114,7 @@ \endcode - If a program requires conversions that are not provided by default + If a program requires conversions that are not provided by default, they can be defined manually by declaring a from_to_() overload. Default overloads are listed in module \ref fromto. -- 1.7.2.5

1 0