Olena-patches June 2013

olena-patches@lrde.epita.fr

5 participants
104 discussions

olena: olena-2.0-617-g6b25e26 doc/doc.css: Add a new CSS class.

by Guillaume Lazzara

--- ChangeLog | 4 ++++ doc/doc.css | 12 ++++++++++++ 2 files changed, 16 insertions(+), 0 deletions(-) diff --git a/ChangeLog b/ChangeLog index 7333963..f8973ce 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2013-05-16 Guillaume Lazzara <z(a)lrde.epita.fr> + + * doc/doc.css: Add a new CSS class. + 2013-05-15 Guillaume Lazzara <z(a)lrde.epita.fr> Add more links into main documentation. diff --git a/doc/doc.css b/doc/doc.css index 72a4b19..7801988 100644 --- a/doc/doc.css +++ b/doc/doc.css @@ -25,3 +25,15 @@ table.itable width:850px; table-layout:fixed; } + + +table.typedeftable td +{ + vertical-align: top; +} + +table.typedeftable +{ + width:600px; + table-layout:fixed; +} -- 1.7.2.5

10 years, 11 months

olena: olena-2.0-616-g43941b5 Add summaries of common typedefs in concrete images.

by Guillaume Lazzara

* mln/core/image/image1d.hh, * mln/core/image/image2d.hh, * mln/core/image/image3d.hh: Here. --- milena/ChangeLog | 8 ++++++++ milena/mln/core/image/image1d.hh | 36 ++++++++++++++++++++++++++++-------- milena/mln/core/image/image2d.hh | 36 ++++++++++++++++++++++++++++-------- milena/mln/core/image/image3d.hh | 36 ++++++++++++++++++++++++++++-------- 4 files changed, 92 insertions(+), 24 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index a9bfc7e..319a05d 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,13 @@ 2013-05-16 Guillaume Lazzara <z(a)lrde.epita.fr> + Add summaries of common typedefs in concrete images. + + * mln/core/image/image1d.hh, + * mln/core/image/image2d.hh, + * mln/core/image/image3d.hh: Here. + +2013-05-16 Guillaume Lazzara <z(a)lrde.epita.fr> + Add more "See also" references. * mln/core/alias/box1d.hh, diff --git a/milena/mln/core/image/image1d.hh b/milena/mln/core/image/image1d.hh index b5ed229..b67b084 100644 --- a/milena/mln/core/image/image1d.hh +++ b/milena/mln/core/image/image1d.hh @@ -125,14 +125,34 @@ namespace mln template <typename V> struct image1d; - /// Basic 1D image class. - /// - /// The parameter \c V is the type of pixel values. This image class - /// stores data in memory and has a virtual border with constant - /// thickness before and after data. - /// - /// \ingroup modimageconcrete - // + /*! \brief Basic 1D image class. + + The parameter \c V is the type of pixel values. + + \note This image class stores data in memory and has a virtual + border with constant thickness before and after data. + + <table class="doxtable typedeftable"> + <tr><th>Type name</th><th>Class name</th></tr> + <tr><td>%box</td><td>mln::box1d</td></tr> + <tr><td>%bkd_piter</td><td>box_bkd_piter_< mln::point1d ></td></tr> + <tr><td>%bkd_pixter</td><td>mln::bkd_pixter1d<image1d<V> ></td></tr> + <tr><td>%Compatible neighborhoods</td><td>mln::neighb1d</td></tr> + <tr><td>%Compatible windows</td><td>mln::window1d</td></tr> + <tr><td>%Domain</td><td>mln::box1d</td></tr> + <tr><td>%Dpoint</td><td>mln::dpoint1d</td></tr> + <tr><td>%fwd_piter</td><td>box_fwd_piter_< mln::point1d ></td></tr> + <tr><td>%fwd_pixter</td><td>mln::fwd_pixter1d<image1d<V> ></td></tr> + <tr><td>%Grid</td><td>mln::grid::tick</td></tr> + <tr><td>%Piter</td><td>box_fwd_piter_< mln::point1d ></td></tr> + <tr><td>%Pixter</td><td>mln::fwd_pixter1d<image1d<V> ></td></tr> + <tr><td>%PSite</td><td>mln::point1d</td></tr> + <tr><td>%Site</td><td>mln::point1d</td></tr> + <tr><td>%Value</td><td>V</td></tr> + </table> + + \ingroup modimageconcrete + */ template <typename V> struct image1d : public internal::image_primary< V, box1d, image1d<V> > diff --git a/milena/mln/core/image/image2d.hh b/milena/mln/core/image/image2d.hh index fee7b34..a2d38cb 100644 --- a/milena/mln/core/image/image2d.hh +++ b/milena/mln/core/image/image2d.hh @@ -122,14 +122,34 @@ namespace mln - /// Basic 2D image class. - /// - /// The parameter \c V is the type of pixel values. This image class - /// stores data in memory and has a virtual border with constant - /// thickness around data. - /// - /// \ingroup modimageconcrete - // + /*! \brief Basic 2D image class. + + The parameter \c V is the type of pixel values. + + \note This image class stores data in memory and has a virtual + border with constant thickness around data. + + <table class="doxtable typedeftable"> + <tr><th>Type name</th><th>Class name</th></tr> + <tr><td>%box</td><td>mln::box2d</td></tr> + <tr><td>%bkd_piter</td><td>box_bkd_piter_< mln::point2d ></td></tr> + <tr><td>%bkd_pixter</td><td>mln::bkd_pixter2d<image2d<V> ></td></tr> + <tr><td>%Compatible neighborhoods</td><td>mln::neighb2d</td></tr> + <tr><td>%Compatible windows</td><td>mln::window2d</td></tr> + <tr><td>%Domain</td><td>mln::box2d</td></tr> + <tr><td>%Dpoint</td><td>mln::dpoint2d</td></tr> + <tr><td>%fwd_piter</td><td>box_fwd_piter_< mln::point2d ></td></tr> + <tr><td>%fwd_pixter</td><td>mln::fwd_pixter2d<image2d<V> ></td></tr> + <tr><td>%Grid</td><td>mln::grid::square</td></tr> + <tr><td>%Piter</td><td>box_fwd_piter_< mln::point2d ></td></tr> + <tr><td>%Pixter</td><td>mln::fwd_pixter2d<image2d<V> ></td></tr> + <tr><td>%PSite</td><td>mln::point2d</td></tr> + <tr><td>%Site</td><td>mln::point2d</td></tr> + <tr><td>%Value</td><td>V</td></tr> + </table> + + \ingroup modimageconcrete + */ template <typename V> class image2d : public internal::image_primary< V, mln::box2d, image2d<V> > { diff --git a/milena/mln/core/image/image3d.hh b/milena/mln/core/image/image3d.hh index 22924c3..bb3ad31 100644 --- a/milena/mln/core/image/image3d.hh +++ b/milena/mln/core/image/image3d.hh @@ -121,14 +121,34 @@ namespace mln - /// Basic 3D image class. - /// - /// The parameter \c V is the type of pixel values. This image class - /// stores data in memory and has a virtual border with constant - /// thickness around data. - /// - /// \ingroup modimageconcrete - // + /*! \brief Basic 3D image class. + + The parameter \c V is the type of pixel values. + + \note This image class stores data in memory and has a virtual + border with constant thickness around data. + + <table class="doxtable typedeftable"> + <tr><th>Type name</th><th>Class name</th></tr> + <tr><td>%box</td><td>mln::box3d</td></tr> + <tr><td>%bkd_piter</td><td>box_bkd_piter_< mln::point3d ></td></tr> + <tr><td>%bkd_pixter</td><td>mln::bkd_pixter3d<image3d<V> ></td></tr> + <tr><td>%Compatible neighborhoods</td><td>mln::neighb3d</td></tr> + <tr><td>%Compatible windows</td><td>mln::window3d</td></tr> + <tr><td>%Domain</td><td>mln::box3d</td></tr> + <tr><td>%Dpoint</td><td>mln::dpoint3d</td></tr> + <tr><td>%fwd_piter</td><td>box_fwd_piter_< mln::point3d ></td></tr> + <tr><td>%fwd_pixter</td><td>mln::fwd_pixter3d<image3d<V> ></td></tr> + <tr><td>%Grid</td><td>mln::grid::cube</td></tr> + <tr><td>%Piter</td><td>box_fwd_piter_< mln::point3d ></td></tr> + <tr><td>%Pixter</td><td>mln::fwd_pixter3d<image3d<V> ></td></tr> + <tr><td>%PSite</td><td>mln::point3d</td></tr> + <tr><td>%Site</td><td>mln::point3d</td></tr> + <tr><td>%Value</td><td>V</td></tr> + </table> + + \ingroup modimageconcrete + */ template <typename V> struct image3d : public internal::image_primary< V, box3d, image3d<V> > { -- 1.7.2.5

10 years, 11 months

olena: olena-2.0-615-g8e83344 Add more "See also" references.

by Guillaume Lazzara

* mln/core/alias/box1d.hh, * mln/core/alias/box2d.hh, * mln/core/alias/box3d.hh, * mln/core/alias/point1d.hh, * mln/core/alias/point2d.hh, * mln/core/alias/point3d.hh, * mln/core/grids.hh, * mln/core/pixter1d.hh, * mln/core/pixter2d.hh, * mln/core/pixter3d.hh, * mln/core/site_set/box_piter.hh: Here. --- milena/ChangeLog | 16 ++++++++++++++++ milena/mln/core/alias/box1d.hh | 2 +- milena/mln/core/alias/box2d.hh | 2 +- milena/mln/core/alias/box3d.hh | 2 +- milena/mln/core/alias/point1d.hh | 4 ++++ milena/mln/core/alias/point2d.hh | 4 ++++ milena/mln/core/alias/point3d.hh | 4 ++++ milena/mln/core/grids.hh | 14 +++++++++++++- milena/mln/core/pixter1d.hh | 2 ++ milena/mln/core/pixter2d.hh | 4 ++-- milena/mln/core/pixter3d.hh | 2 ++ milena/mln/core/site_set/box_piter.hh | 4 ++-- 12 files changed, 52 insertions(+), 8 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index f14e23c..a9bfc7e 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,3 +1,19 @@ +2013-05-16 Guillaume Lazzara <z(a)lrde.epita.fr> + + Add more "See also" references. + + * mln/core/alias/box1d.hh, + * mln/core/alias/box2d.hh, + * mln/core/alias/box3d.hh, + * mln/core/alias/point1d.hh, + * mln/core/alias/point2d.hh, + * mln/core/alias/point3d.hh, + * mln/core/grids.hh, + * mln/core/pixter1d.hh, + * mln/core/pixter2d.hh, + * mln/core/pixter3d.hh, + * mln/core/site_set/box_piter.hh: Here. + 2013-05-15 Guillaume Lazzara <z(a)lrde.epita.fr> Be more precise about relationship between sites and iterators. diff --git a/milena/mln/core/alias/box1d.hh b/milena/mln/core/alias/box1d.hh index df7398f..35003b0 100644 --- a/milena/mln/core/alias/box1d.hh +++ b/milena/mln/core/alias/box1d.hh @@ -68,7 +68,7 @@ namespace mln -----X--------X---------X--------> \endverbatim - \sa mln::make::box1d. + \sa mln::make::box1d mln::image1d mln::point1d \ingroup modsitesetbasic */ diff --git a/milena/mln/core/alias/box2d.hh b/milena/mln/core/alias/box2d.hh index 8aa7e3b..13d4399 100644 --- a/milena/mln/core/alias/box2d.hh +++ b/milena/mln/core/alias/box2d.hh @@ -75,7 +75,7 @@ namespace mln v \endverbatim - \sa mln::make::box2d. + \sa mln::make::box2d mln::image2d mln::point2d \ingroup modsitesetbasic */ diff --git a/milena/mln/core/alias/box3d.hh b/milena/mln/core/alias/box3d.hh index 020f85b..a7d11d5 100644 --- a/milena/mln/core/alias/box3d.hh +++ b/milena/mln/core/alias/box3d.hh @@ -78,7 +78,7 @@ namespace mln \endverbatim - \sa mln::make::box3d. + \sa mln::make::box3d mln::image3d mln::point3d \ingroup modsitesetbasic */ diff --git a/milena/mln/core/alias/point1d.hh b/milena/mln/core/alias/point1d.hh index a989116..462ddd2 100644 --- a/milena/mln/core/alias/point1d.hh +++ b/milena/mln/core/alias/point1d.hh @@ -49,6 +49,8 @@ namespace mln \brief Point defined on the 1D ruler grid with integer coordinates. + + \see mln::image1d mln::box1d */ /// \cond ALIAS typedef point<grid::tick, def::coord> point1d; @@ -60,6 +62,8 @@ namespace mln \brief Point defined on the 1D ruler grid with floating-point coordinates. + + \see mln::image1d mln::box1d */ /// \cond ALIAS typedef point<grid::tick, def::coordf> point1df; diff --git a/milena/mln/core/alias/point2d.hh b/milena/mln/core/alias/point2d.hh index 04db631..901f68b 100644 --- a/milena/mln/core/alias/point2d.hh +++ b/milena/mln/core/alias/point2d.hh @@ -49,6 +49,8 @@ namespace mln \brief Point defined on the 2D square grid with integer coordinates. + + \see mln::image2d mln::box2d */ /// \cond ALIAS typedef point<mln::grid::square, mln::def::coord> point2d; @@ -61,6 +63,8 @@ namespace mln \brief Point defined on the 2D square grid with floating-point coordinates. + + \see mln::image2d mln::box2d */ /// \cond ALIAS typedef point<mln::grid::square, mln::def::coordf> point2df; diff --git a/milena/mln/core/alias/point3d.hh b/milena/mln/core/alias/point3d.hh index a82df39..2686ae0 100644 --- a/milena/mln/core/alias/point3d.hh +++ b/milena/mln/core/alias/point3d.hh @@ -48,6 +48,8 @@ namespace mln \brief Point defined on the 3D square grid with integer coordinates. + + \see mln::image3d mln::box3d */ /// \cond ALIAS typedef point<grid::cube, def::coord> point3d; @@ -60,6 +62,8 @@ namespace mln \brief Point defined on the 3D square grid with floating-point coordinates. + + \see mln::image3d mln::box3d */ /// \cond ALIAS typedef point<grid::cube, def::coordf> point3df; diff --git a/milena/mln/core/grids.hh b/milena/mln/core/grids.hh index b215d1c..5949323 100644 --- a/milena/mln/core/grids.hh +++ b/milena/mln/core/grids.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. // @@ -42,24 +43,35 @@ namespace mln namespace grid { + /*! \brief Regular 1D grid (line). + \see mln::image1d + */ struct tick : public Regular_Grid< tick > { typedef metal::true_ aligned; enum { dim = 1 }; }; + /*! \brief Regular square 2D grid (square). + \see mln::image2d + */ struct square : public Regular_Grid< square > { typedef metal::true_ aligned; enum { dim = 2 }; }; + /*! \brief Regular hexagonal 2D grid (square). + */ struct hexa : public Regular_Grid< hexa > { typedef metal::false_ aligned; enum { dim = 2 }; }; + /*! \brief Regular 3D grid (cube). + \see mln::image3d + */ struct cube : public Regular_Grid< cube > { typedef metal::true_ aligned; diff --git a/milena/mln/core/pixter1d.hh b/milena/mln/core/pixter1d.hh index 8c76129..27080f9 100644 --- a/milena/mln/core/pixter1d.hh +++ b/milena/mln/core/pixter1d.hh @@ -43,6 +43,7 @@ namespace mln /*! \brief Forward pixel iterator on a 1-D image with border. + \see mln::image1d */ template <typename I> class fwd_pixter1d : @@ -71,6 +72,7 @@ namespace mln /*! \brief Backward pixel iterator on a 1-D image with border. + \see mln::image1d */ template <typename I> class bkd_pixter1d : diff --git a/milena/mln/core/pixter2d.hh b/milena/mln/core/pixter2d.hh index 2837543..c753f5f 100644 --- a/milena/mln/core/pixter2d.hh +++ b/milena/mln/core/pixter2d.hh @@ -44,8 +44,8 @@ namespace mln `------------------*/ /*! - \internal \brief Forward pixel iterator on a 2-D image with border. + \see mln::image2d */ template <typename I> class fwd_pixter2d @@ -91,8 +91,8 @@ namespace mln `------------------*/ /*! - \internal \brief Backward pixel iterator on a 2-D image with border. + \see mln::image2d */ template <typename I> class bkd_pixter2d diff --git a/milena/mln/core/pixter3d.hh b/milena/mln/core/pixter3d.hh index 31d115c..b12a068 100644 --- a/milena/mln/core/pixter3d.hh +++ b/milena/mln/core/pixter3d.hh @@ -46,6 +46,7 @@ namespace mln /*! \brief Forward pixel iterator on a 3-D image with border. + \see mln::image3d */ template <typename I> class fwd_pixter3d @@ -102,6 +103,7 @@ namespace mln /*! \brief Backward pixel iterator on a 3-D image with border. + \see mln::image3d */ template <typename I> class bkd_pixter3d diff --git a/milena/mln/core/site_set/box_piter.hh b/milena/mln/core/site_set/box_piter.hh index 0d32567..744e3a9 100644 --- a/milena/mln/core/site_set/box_piter.hh +++ b/milena/mln/core/site_set/box_piter.hh @@ -44,7 +44,7 @@ namespace mln The parameter \c P is the type of points. - \see mln::box + \see mln::box mln::image1d mln::image2d mln::image3d */ template <typename P> class box_fwd_piter_ : public internal::site_set_iterator_base< box<P>, @@ -93,7 +93,7 @@ namespace mln The parameter \c P is the type of points. - \see mln::box + \see mln::box mln::image1d mln::image2d mln::image3d */ template <typename P> class box_bkd_piter_ : public internal::site_set_iterator_base< box<P>, -- 1.7.2.5

10 years, 11 months

olena: branch exp/newdoc updated: olena-2.0-617-g6b25e26

by git＠lrde.epita.fr

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 6b25e2661de9de9b528528f78cb61afd7aa3acd1 (commit) via 43941b5833cfbf5011c8643a20a0ac98854e7a94 (commit) via 8e83344582d31b39f6c7a9ebd39471c96974f79e (commit) from 38af4980d93b128f944d972d6492e3a5e3a250f2 (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 ----------------------------------------------------------------- 6b25e26 doc/doc.css: Add a new CSS class. 43941b5 Add summaries of common typedefs in concrete images. 8e83344 Add more "See also" references. ----------------------------------------------------------------------- Summary of changes: ChangeLog | 4 +++ doc/doc.css | 12 +++++++++++ milena/ChangeLog | 24 ++++++++++++++++++++++ milena/mln/core/alias/box1d.hh | 2 +- milena/mln/core/alias/box2d.hh | 2 +- milena/mln/core/alias/box3d.hh | 2 +- milena/mln/core/alias/point1d.hh | 4 +++ milena/mln/core/alias/point2d.hh | 4 +++ milena/mln/core/alias/point3d.hh | 4 +++ milena/mln/core/grids.hh | 14 +++++++++++- milena/mln/core/image/image1d.hh | 36 +++++++++++++++++++++++++------- milena/mln/core/image/image2d.hh | 36 +++++++++++++++++++++++++------- milena/mln/core/image/image3d.hh | 36 +++++++++++++++++++++++++------- milena/mln/core/pixter1d.hh | 2 + milena/mln/core/pixter2d.hh | 4 +- milena/mln/core/pixter3d.hh | 2 + milena/mln/core/site_set/box_piter.hh | 4 +- 17 files changed, 160 insertions(+), 32 deletions(-) hooks/post-receive -- Olena, a generic and efficient image processing platform

10 years, 11 months

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

2004

Olena-patches June 2013