- Olena-patches

oln 10.94: Doc (transform).
by Giovanni Palma 17 Mar '04

17 Mar '04

Index: olena/ChangeLog from Giovanni Palma <giovanni(a)lrde.epita.fr> * oln/transforms/fft.hh: Add comments. * oln/transforms/dwt.hh: Likewise. * oln/transforms/wavelet_coeffs.hh: Likewise. Index: olena/oln/transforms/dwt.hh --- olena/oln/transforms/dwt.hh Thu, 07 Aug 2003 02:37:23 +0200 burrus_n (oln/i/35_dwt.hh 1.2.1.4.1.10 600) +++ olena/oln/transforms/dwt.hh Tue, 16 Mar 2004 10:21:44 +0100 palma_g (oln/i/35_dwt.hh 1.2.1.4.1.10 640) @@ -1,4 +1,4 @@ -// Copyright (C) 2001, 2002, 2003 EPITA Research and Development Laboratory +// Copyright (C) 2001, 2002, 2003, 2004 EPITA Research and Development Laboratory // // This file is part of the Olena Library. This library is free // software; you can redistribute it and/or modify it under the terms @@ -41,6 +41,9 @@ namespace oln { + /*! + ** \brief Transform algorithm implementation. + */ namespace transforms { // macros used to define all the wavelets coefficients @@ -58,6 +61,9 @@ init(); \ } + /*! + ** \brief type of dwt to perform. + */ typedef enum { dwt_std, dwt_non_std @@ -65,34 +71,47 @@ } // end of namespace transforms + /*! + ** \brief internal stuff. + */ namespace internal { - + /// \brief Value of ln(2). static const ntg::float_d ln_2_ = 0.6931471805599453092; - // - // wavelet_coeffs_<T, N, Self> - // - ////////////////////////////////////// - + /*! + ** \brief Wavelet coefficient data structure. + ** + ** \param T Coefficients data type. + ** \param N Number of coefficients. + ** \param Self Self type. + */ template <class T, unsigned N, class Self> struct wavelet_coeffs_ { - typedef T value_t; - typedef Self self_t; + typedef T value_t; ///< \brType of data used. + typedef Self self_t; ///< \brief Self type. public: // accessors + /// \brief Accessor to ith element of g. const value_t getG(unsigned i) const { return g[i]; } + /// \brief Accessor to ith element of ig. const value_t getInvG(unsigned i) const { return ig[i]; } + /// \brief Accessor to ith element of h. const value_t getH(unsigned i) const { return h[i]; } + /// \brief Accessor to ith element of ih. const value_t getInvH(unsigned i) const { return ih[i]; } - + /// \brief Give the size of the arrays. const unsigned size() const { return size_; } protected: - + /*! + ** \brief Initialization method. + ** + ** Fill coefficients. + */ void init() { for (unsigned i = 0; i < size_; i += 2) { @@ -105,28 +124,46 @@ } } + /*! + ** \brief Constructor. + */ wavelet_coeffs_(){} + /*! + ** \brief Destructor. + ** + ** Its aim is to check N is pair. + */ ~wavelet_coeffs_() { mlc::is_false<N % 2>::ensure(); } - mlc::array1d< mlc::array1d_info<N>, value_t> h; - mlc::internal::array1d_start_<value_t> wc_start; + mlc::array1d< mlc::array1d_info<N>, value_t> h; /// \brief array of value_t. + mlc::internal::array1d_start_<value_t> wc_start; /// \brief First coefficient. private: - value_t g[N]; - value_t ih[N]; - value_t ig[N]; + value_t g[N]; /// \brief array of value_t. + value_t ih[N]; /// \brief array of value_t. + value_t ig[N]; /// \brief array of value_t. enum { size_ = N }; }; - // _dwt_transform_step - + /*! + ** \brief Step of a dwt transform. + ** + ** \param I Exact type of the input image. + ** \param K type of coefficients. + ** + ** \arg im Image to process. + ** \arg p_ Point to work on. + ** \arg d Component d of p. + ** \arg n Step number. + ** \arg coeffs Coefficients. + */ template <class I, class K> void dwt_transform_step_(abstract::image<I>& im, const oln_point_type(I)& p_, @@ -169,8 +206,18 @@ delete[] tmp; } - // _dwt_transform_inv_step - + /*! + ** \brief Step of a dwt invert transform. + ** + ** \param I Exact type of the input image. + ** \param K type of coefficients. + ** + ** \arg im Image to process. + ** \arg p_ Point to work on. + ** \arg d Component d of p. + ** \arg n Step number. + ** \arg coeffs Coefficients. + */ template <class I, class K> void dwt_transform_inv_step_(abstract::image<I>& im, const oln_point_type(I)& p_, @@ -217,16 +264,28 @@ } // Functions used to iterate over all dimensions except one - + /*! + ** \brief Enum to know if you go in forward or backward order. + */ typedef enum { dwt_fwd, dwt_bwd } dwt_transform_dir_; + /*! + ** \brief Functions used to iterate over all dimensions except one. + ** + ** \param dim Number of dimension to treat. + ** \param skip Dimension to skip. + ** \param current Current dimension. + */ template <unsigned dim, unsigned skip, unsigned current = dim> struct dim_skip_iterate_rec_ { + /*! + ** \brief Iterate over all dimensions except one. + */ template <class I, class K> static void doit(abstract::image<I>& im, oln_point_type(I)& p, @@ -249,9 +308,24 @@ } }; + /*! + ** \brief Specialization of dim_skip_iterate_rec_ with current + ** dimension set to 0. + ** + ** \param dim Number of dimension to process. + ** \param skip Dimension to skip. + */ template <unsigned dim, unsigned skip> struct dim_skip_iterate_rec_<dim, skip, 0> { + /*! + ** \brief Iterate over all dimensions except one. + ** + ** \param I Exact type of the image to process. + ** \param K Type of coefficients. + ** + ** It is leaf call, thus you can call a dwt transform step. + */ template <class I, class K> static void doit(abstract::image<I>& im, oln_point_type(I)& p, @@ -275,9 +349,21 @@ } }; + /*! + ** \brief Iterate over all dimensions except one. + ** + ** \param dim Number of dimension to process. + ** \param skip Dimension to skip. + */ template <unsigned dim, unsigned skip> struct dim_iterate_rec_ { + /*! + ** \brief Iterate over all dimensions except one. + ** + ** \param I Exact type of the image to process. + ** \param K Type of coefficients. + */ template <class I, class K> static void doit(abstract::image<I>& im, oln_point_type(I)& p, @@ -291,9 +377,24 @@ } }; + /*! + ** \brief Specialization of dim_iterate_rec_ with skip dimension + ** set to 0. + ** + ** \param dim Number of dimension to process. + */ template <unsigned dim> struct dim_iterate_rec_<dim, 0> { + + /*! + ** \brief Iterate over all dimensions except one. + ** + ** \param I Exact type of the image to process. + ** \param K Type of coefficients. + ** + ** End of recursion. + */ template <class I, class K> static void doit(abstract::image<I>& , oln_point_type(I)& , @@ -306,6 +407,12 @@ } }; + /*! + ** \brief Internal dwt transform function. + ** + ** \param I Exact type of the image to process. + ** \param K Type of coefficients. + */ template <class I, class K> void dwt_transform_(abstract::image<I>& im, const unsigned l1, @@ -326,6 +433,12 @@ } } + /*! + ** \brief Internal dwt invert transform function. + ** + ** \param I Exact type of the image to process. + ** \param K Type of coefficients. + */ template <class I, class K> void dwt_transform_inv_(abstract::image<I>& im, const unsigned l1, @@ -350,21 +463,29 @@ namespace transforms { - // - // dwt<T, K> - // - ////////////////////////////////////// - + /*! + ** \brief Object to compute dwt transforms. + ** + ** \param I Exact type of the image to process. + ** \param K Type of coefficients. + */ template <class I, class K> class dwt { public: - typedef I original_im_t; - typedef oln_value_type(I) original_im_value_t; - typedef typename mute<I, ntg::float_d>::ret trans_im_t; - typedef typename K::self_t coeffs_t; - + typedef I original_im_t; ///< \brief Exact of the image. + typedef oln_value_type(I) original_im_value_t; ///< \brief Original data type of the image. + typedef typename mute<I, ntg::float_d>::ret trans_im_t; ///< \brief Type of the transformed image. + typedef typename K::self_t coeffs_t; ///< \brief Data type of coefficients. + + /*! + ** \brief Constructor from an image. + ** + ** Initialization of dwt transform. + ** + ** \arg im Image to process. + */ dwt(const original_im_t& im) : original_im(im) { ntg_is_a(original_im_value_t, ntg::real)::ensure(); @@ -384,16 +505,33 @@ trans_im = trans_im_t(im.size()); } + /*! + ** \brief Accessor to the transformed image. + ** + ** Const version. + */ const trans_im_t transformed_image() const { return trans_im; } + /*! + ** \brief Accessor to the transformed image. + ** + ** Non const version. + */ trans_im_t& transformed_image() { return trans_im; } + /*! + ** \brief Compute the dwt transform. + ** + ** \arg t Type of the transform (standard or non standard) + ** \arg normalized Do you want a normalized result ? + ** \arg l Level. + */ trans_im_t transform(dwt_transform_type t = dwt_non_std, bool normalized = true, unsigned l = 0) { @@ -407,6 +545,7 @@ } oln_iter_type(trans_im_t) it(trans_im); + if (normalized) { norm = pow(sqrt(2), original_im_t::dim * l); for_all(it) @@ -426,6 +565,11 @@ return trans_im; } + /*! + ** \brief Compute the invert dwt transform. + ** + ** \arg l Level. + */ trans_im_t transform_inv(unsigned l = 0) { if (l == 0) @@ -435,6 +579,7 @@ trans_im_t new_im(trans_im.size()); oln_iter_type(trans_im_t) it(trans_im); + if (norm != 1) { for_all(it) new_im[it] = trans_im[it] * norm; @@ -451,6 +596,13 @@ return new_im; } + /*! + ** \brief Compute the invert dwt transform. + ** + ** \param T1 Data type you want the output image contains. + ** + ** \arg l Level. + */ template <class T1> typename mute<I, T1>::ret transform_inv(unsigned l = 0) { @@ -460,6 +612,7 @@ typename mute<I, T1>::ret new_im(tmp_im.size()); oln_iter_type(trans_im_t) it(tmp_im); + for_all(it) new_im[it] = (tmp_im[it] >= ntg_inf_val(T1) ? (tmp_im[it] <= ntg_sup_val(T1) ? @@ -471,14 +624,14 @@ private: - const original_im_t& original_im; - trans_im_t trans_im; - const coeffs_t coeffs; - unsigned im_size; - unsigned max_level; - unsigned current_level; - ntg::float_d norm; - dwt_transform_type transform_type; + const original_im_t& original_im; ///< The original image. + trans_im_t trans_im; ///< The transformed image. + const coeffs_t coeffs; ///< The coefficients. + unsigned im_size; ///< Size of the image. + unsigned max_level; ///< Higher level. + unsigned current_level; ///< Current level. + ntg::float_d norm; ///< Norm. + dwt_transform_type transform_type; ///< Type of transform wanted. }; } // end of namespace transforms Index: olena/oln/transforms/fft.hh --- olena/oln/transforms/fft.hh Thu, 07 Aug 2003 02:37:23 +0200 burrus_n (oln/i/36_fft.hh 1.4.1.8 600) +++ olena/oln/transforms/fft.hh Tue, 16 Mar 2004 11:56:19 +0100 palma_g (oln/i/36_fft.hh 1.4.1.8 640) @@ -1,4 +1,4 @@ -// Copyright (C) 2001, 2002, 2003 EPITA Research and Development Laboratory +// Copyright (C) 2001, 2002, 2003, 2004 EPITA Research and Development Laboratory // // This file is part of the Olena Library. This library is free // software; you can redistribute it and/or modify it under the terms @@ -46,46 +46,73 @@ namespace internal { - // dispatch traits for fftw - + /// \brief dispatch traits for fftw enum fft_dispatch { fft_cplx, fft_real }; + /*! + ** \brief fft trait. + */ template <class T> struct fft_trait { void ensure() { ntg_is_a(T, ntg::real)::ensure(); } - static const fft_dispatch which = fft_real; - typedef fftw_real fftw_input; + static const fft_dispatch which = fft_real; ///< Real dispatch. + typedef fftw_real fftw_input; ///< Type of input. }; + /*! + ** \brief fft trait. + ** + ** \specialization for ntg::cplx<R, T> + */ template <ntg::cplx_representation R, class T> struct fft_trait<ntg::cplx<R, T> > { - static const fft_dispatch which = fft_cplx; - typedef fftw_complex fftw_input; + static const fft_dispatch which = fft_cplx; ///< Complex dispatch. + typedef fftw_complex fftw_input; ///< Type of input. }; - // - // _fft<ntg::cplx_representation, T> - // - ////////////////////////////////////// - + /*! + ** _fft<ntg::cplx_representation, T> + ** + ** \param T Data type. + ** \param R type of representation. + */ template <class T, ntg::cplx_representation R> class _fft { public: - + /*! + ** \brief Accessor to transformed image. + ** + ** Const version. + */ const image2d<ntg::cplx<R, ntg::float_d> > transformed_image() const { return trans_im; } + /*! + ** \brief Accessor to transformed image. + ** + ** Non const version. + */ image2d<ntg::cplx<R, ntg::float_d> >& transformed_image() { return trans_im; } + /*! + ** \brief Accessor to transformed image. + ** + ** For each point p of the transformed image T, you get + ** |T[p]|. + ** + ** \param T1 Data type of the resulting image. + ** + ** \arg ordered Kind of traversal. + */ template <class T1> image2d<T1> transformed_image_magn(bool ordered = true) const { @@ -110,11 +137,30 @@ return new_im; } + /*! + ** \brief Accessor to transformed image. + ** + ** For each point p of the transformed image T, you get + ** |T[p]|. + ** + ** \arg ordered Kind of traversal. + */ image2d<T> transformed_image_magn(bool ordered = true) const { return transformed_image_magn<T>(ordered); } + /*! + ** \brief Accessor to transformed image. + ** + ** For each point p of the transformed image T, you get + ** a clipped value of |T[p]|.\n + ** + ** \param T1 Data type of the resulting image. + ** + ** \arg clip Value used for clipping. + ** \arg ordered Kind of traversal. + */ template <class T1> image2d<T1> transformed_image_clipped_magn(const ntg::float_d clip, bool ordered = true) const @@ -158,24 +204,63 @@ return new_im; } + /*! + ** \brief Accessor to transformed image. + ** + ** For each point p of the transformed image T, you get + ** a clipped value of |T[p]|.\n + ** + ** \arg clip Value used for clipping. + ** \arg ordered Kind of traversal. + */ image2d<T> transformed_image_clipped_magn(const ntg::float_d clip, bool ordered = true) const { return transformed_image_clipped_magn<T>(clip, ordered); } + /*! + ** \brief Accessor to transformed image. + ** + ** For each point p of the transformed image T, you get + ** a clipped value of |T[p]|.\n + ** + ** \param T1 Data type of the resulting image. + ** + ** \arg ordered Kind of traversal. + */ template <class T1> image2d<T1> transformed_image_clipped_magn(bool ordered = true) const { return transformed_image_clipped_magn<T1>(1, ordered); } + /*! + ** \brief Accessor to transformed image. + ** + ** For each point p of the transformed image T, you get + ** a clipped value of |T[p]|.\n + ** + ** \param T1 Data type of the resulting image. + ** + ** \arg ordered Kind of traversal. + */ image2d<T> transformed_image_clipped_magn(bool ordered = true) const { return transformed_image_clipped_magn<T>(1, ordered); } // FIXME: Find a more elegant way to fix range interval on a and b. + /*! + ** \brief Accessor to transformed image. + ** + ** For each point p of the transformed image T, you get + ** a log translated value of |T[p]| on interval [a; b].\n + ** + ** \arg a Lower bound. + ** \arg b Upper bound. + ** \arg ordered Kind of traversal. + */ template <class T1> image2d<T1> transformed_image_log_magn(const ntg::range<ntg::float_d, ntg::bounded_u<0, 1000>, @@ -213,6 +298,16 @@ } // FIXME: Find a more elegant way to fix boundaries of a and b. + /*! + ** \brief Accessor to transformed image. + ** + ** For each point p of the transformed image T, you get + ** a log translated value of |T[p]| on interval [a; b].\n + ** + ** \arg a Lower bound. + ** \arg b Upper bound. + ** \arg ordered Kind of traversal. + */ image2d<T> transformed_image_log_magn(const ntg::range<ntg::float_d, ntg::bounded_u<0, 1000>, ntg::saturate> a, @@ -224,17 +319,40 @@ return transformed_image_log_magn<T>(a, b, ordered); } + /*! + ** \brief Accessor to transformed image. + ** + ** For each point p of the transformed image T, you get + ** a log translated value of |T[p]| on interval [1; 100].\n + ** + ** \param T1 Data type of the resulting image. + ** + ** \arg ordered Kind of traversal. + */ template <class T1> image2d<T1> transformed_image_log_magn(bool ordered = true) const { return transformed_image_log_magn<T1>(1, 100, ordered); } + /*! + ** \brief Accessor to transformed image. + ** + ** For each point p of the transformed image T, you get + ** a log translated value of |T[p]| on interval [1; 100].\n + ** + ** \arg ordered Kind of traversal. + */ image2d<T> transformed_image_log_magn(bool ordered = true) const { return transformed_image_log_magn<T>(1, 100, ordered); } + /*! + ** \brief Destructor. + ** + ** Let memory free for other big images !!! + */ ~_fft() { delete [] in; @@ -245,11 +363,11 @@ protected: - typename fft_trait<T>::fftw_input *in; - fftw_complex *out; - fftwnd_plan p; - fftwnd_plan p_inv; - image2d<ntg::cplx<R, ntg::float_d> > trans_im; + typename fft_trait<T>::fftw_input *in; ///< Input image. + fftw_complex *out; ///< Complex image. + fftwnd_plan p; ///< Plan. + fftwnd_plan p_inv; ///< inverted plan. + image2d<ntg::cplx<R, ntg::float_d> > trans_im; ///< Transformed image. }; @@ -257,22 +375,37 @@ namespace transforms { + /*! + ** \brief fft class declaration. + ** + ** \param T Data type. + ** \param R Complex representation kind. + ** \param which Dispatch. + */ template <class T, ntg::cplx_representation R = ntg::polar, internal::fft_dispatch which = internal::fft_trait<T>::which > class fft; - // - // fft<T, ntg::cplx_representation, fft_real> - // - ////////////////////////////////////// - + /*! + ** \brief fft specialization for fft real dispatch. + ** + ** \param T Data type. + ** \param R Complex representation kind. + */ template <class T, ntg::cplx_representation R> class fft<T, R, internal::fft_real> : public internal::_fft<T, R> { public: + /*! + ** \brief Constructor. + ** + ** Initialization of data in order to compute the fft. + ** + ** \arg original_im Image to process. + */ fft(const image2d<T>& original_im) { this->in = new fftw_real[original_im.nrows() * original_im.ncols()]; @@ -291,6 +424,9 @@ this->trans_im = image2d<ntg::cplx<R, ntg::float_d> >(original_im.size()); } + /*! + ** \brief Compute and return the transform. + */ image2d<ntg::cplx<R, ntg::float_d> > transform() { rfftwnd_one_real_to_complex(this->p, this->in, this->out); @@ -313,6 +449,11 @@ return this->trans_im; } + /*! + ** \brief Compute and return the invert transform. + ** + ** \param T1 Data type of output image. + */ template <class T1> image2d<T1> transform_inv() { @@ -343,6 +484,9 @@ return new_im; } + /*! + ** \brief Compute and return the invert transform. + */ image2d<T> transform_inv() { return transform_inv<T>(); @@ -350,17 +494,25 @@ }; - // - // fft<T, ntg::cplx_representation, fft_cplx> - // - ////////////////////////////////////// - + /*! + ** \brief fft specialization for fft complex dispatch. + ** + ** \param T Data type. + ** \param R Complex representation kind. + */ template <class T, ntg::cplx_representation R> class fft<T, R, internal::fft_cplx> : public internal::_fft<T, R> { public: + /*! + ** \brief Constructor. + ** + ** Initialization of data in order to compute the fft. + ** + ** \arg original_im Image to process. + */ template <ntg::cplx_representation R1> fft(const image2d<ntg::cplx<R1, T> >& original_im) { @@ -384,6 +536,9 @@ this->trans_im = image2d<ntg::cplx<ntg::rect, ntg::float_d> >(original_im.size()); } + /*! + ** \brief Compute and return the transform. + */ image2d<ntg::cplx<R, ntg::float_d> > transform() { fftwnd_one(this->p, this->in, this->out); @@ -402,6 +557,11 @@ return this->trans_im; } + /*! + ** \brief Compute and return the invert transform. + ** + ** \param T1 Data type of output image. + */ template <class T1> image2d<ntg::cplx<R, T1> > transform_inv() { @@ -424,6 +584,9 @@ return new_im; } + /*! + ** \brief Compute and return the invert transform. + */ image2d<ntg::cplx<R, T> > transform_inv() { return transform_inv<T>(); Index: olena/oln/transforms/wavelet_coeffs.hh --- olena/oln/transforms/wavelet_coeffs.hh Thu, 07 Aug 2003 02:37:23 +0200 burrus_n (oln/i/34_wavelet_co 1.7 600) +++ olena/oln/transforms/wavelet_coeffs.hh Tue, 16 Mar 2004 10:25:12 +0100 palma_g (oln/i/34_wavelet_co 1.7 640) @@ -1,4 +1,4 @@ -// Copyright (C) 2001, 2002, 2003 EPITA Research and Development Laboratory +// Copyright (C) 2001, 2002, 2003, 2004 EPITA Research and Development Laboratory // // This file is part of the Olena Library. This library is free // software; you can redistribute it and/or modify it under the terms @@ -39,11 +39,9 @@ namespace transforms { - // - // Haar wavelet coefficients - // - ////////////////////////////////////// - + /*! + ** \brief Haar wavelet coefficients + */ Wavelet_coeffs_definition(haar, ntg::float_d, 2) { const ntg::float_d sqrt_2 = sqrt(2); @@ -55,11 +53,11 @@ }; - // - // Daubechies wavelet coefficients - // - ////////////////////////////////////// - + /*! + ** \brief Daubechies wavelet coefficients + ** + ** Four coefficients version. + */ Wavelet_coeffs_definition(daub4, ntg::float_d, 4) { const ntg::float_d sqrt_3 = sqrt(3); @@ -73,6 +71,11 @@ Wavelet_coeffs_end }; + /*! + ** \brief Daubechies wavelet coefficients + ** + ** Six coefficients version. + */ Wavelet_coeffs_definition(daub6, ntg::float_d, 6) { Wavelet_coeffs_begin @@ -85,6 +88,11 @@ Wavelet_coeffs_end }; + /*! + ** \brief Daubechies wavelet coefficients + ** + ** Eight coefficients version. + */ Wavelet_coeffs_definition(daub8, ntg::float_d, 8) { Wavelet_coeffs_begin @@ -99,6 +107,11 @@ Wavelet_coeffs_end }; + /*! + ** \brief Daubechies wavelet coefficients + ** + ** Ten coefficients version. + */ Wavelet_coeffs_definition(daub10, ntg::float_d, 10) { Wavelet_coeffs_begin @@ -115,6 +128,11 @@ Wavelet_coeffs_end }; + /*! + ** \brief Daubechies wavelet coefficients + ** + ** Twelve coefficients version. + */ Wavelet_coeffs_definition(daub12, ntg::float_d, 12) { Wavelet_coeffs_begin @@ -133,6 +151,11 @@ Wavelet_coeffs_end }; + /*! + ** \brief Daubechies wavelet coefficients + ** + ** Twenty coefficients version. + */ Wavelet_coeffs_definition(daub20, ntg::float_d, 20) { Wavelet_coeffs_begin @@ -160,11 +183,11 @@ }; - // - // Coifman wavelet coefficients - // - ////////////////////////////////////// - + /*! + ** \brief Coifman wavelet coefficients + ** + ** Six coefficients version. + */ Wavelet_coeffs_definition(coiflet2, ntg::float_d, 6) { const ntg::float_d sqrt_2 = sqrt(2); @@ -180,6 +203,11 @@ Wavelet_coeffs_end }; + /*! + ** \brief Coifman wavelet coefficients + ** + ** Twelve coefficients version. + */ Wavelet_coeffs_definition(coiflet4, ntg::float_d, 12) { Wavelet_coeffs_begin @@ -198,6 +226,11 @@ Wavelet_coeffs_end }; + /*! + ** \brief Coifman wavelet coefficients + ** + ** Eighteen coefficients version. + */ Wavelet_coeffs_definition(coiflet6, ntg::float_d, 18) { Wavelet_coeffs_begin -- Giovanni Palma EPITA - promo 2005 - membre d'EpX - LRDE Mob. : +33 (0)6 60 97 31 74

2 2

oln 10.91: clean doc
by Niels Van Vliet 16 Mar '04

16 Mar '04

Index: olena/ChangeLog from Niels Van Vliet <niels(a)lrde.epita.fr> * olena/oln/arith/internal/opdecls.hh: Clean doc. * olena/oln/arith/ops.hh: Likewise. * olena/oln/convert/conversion.hh: Likewise. * olena/oln/convol/convolution.hh: Likewise. * olena/oln/convol/fast_gaussian.hh: Likewise. * olena/oln/convol/fast_gaussian.hxx: Likewise. * olena/oln/core/abstract/dpoint.hh: Likewise. * olena/oln/core/abstract/iter.hh: Likewise. * olena/oln/level/cc.hh: Likewise. * olena/oln/math/macros.hh: Likewise. * olena/oln/morpho/extrema.hh: Likewise. * olena/oln/morpho/extrema.hxx: Likewise. * olena/oln/morpho/fast_morpho.hxx: Likewise. * olena/oln/topo/dmap.hh: Likewise. * olena/oln/utils/histogram.hh: Likewise. * olena/oln/topo/tarjan/union.hh: Likewise. * olena/oln/topo/inter-pixel/internal/dir.hh: Likewise. * olena/oln/core/abstract/image.hh: Likewise. * olena/oln/core/impl/image_array.hh: Likewise. * olena/oln/convert/abstract/conversion.hh: Likewise. * olena/oln/snakes/snakes_base.hh: Likewise. * olena/oln/morpho/attributes.hh: Likewise. * olena/oln/morpho/attribute_closing_opening_map.hh: Likewise. Index: olena/oln/arith/internal/opdecls.hh --- olena/oln/arith/internal/opdecls.hh Mon, 15 Mar 2004 15:32:27 +0100 van-vl_n (oln/b/22_opdecls.hh 1.17 640) +++ olena/oln/arith/internal/opdecls.hh Mon, 15 Mar 2004 15:41:45 +0100 van-vl_n (oln/b/22_opdecls.hh 1.18 640) @@ -33,12 +33,10 @@ ** Operations are defined between two images and between one image and ** one constant value (with the cst suffix). ** The two main components are: -** \n -** 1) Define functors for each operations, taking two values and +** -# Define functors for each operations, taking two values and ** returning the result. -**\n -** 2) Define front-end functions applying a functor on the whole image. -** 3 versions are defined, leaving the possibility to specify the +** -# Define front-end functions applying a functor on the whole image. +** -# Versions are defined, leaving the possibility to specify the ** return type automatically, manually or using a conversion (from ** convert). ** Index: olena/oln/arith/ops.hh --- olena/oln/arith/ops.hh Sat, 13 Mar 2004 17:58:18 +0100 van-vl_n (oln/b/23_ops.hh 1.5.1.2.1.9 640) +++ olena/oln/arith/ops.hh Mon, 15 Mar 2004 16:12:16 +0100 van-vl_n (oln/b/23_ops.hh 1.5.1.2.1.10 640) @@ -39,7 +39,7 @@ namespace oln { /*! - ** \brief Namespace for arithmetic. + ** \brief Arithmetic implementation. */ namespace arith { Index: olena/oln/convert/conversion.hh --- olena/oln/convert/conversion.hh Sat, 13 Mar 2004 17:45:05 +0100 van-vl_n (oln/21_conversion 1.17 640) +++ olena/oln/convert/conversion.hh Mon, 15 Mar 2004 17:15:47 +0100 van-vl_n (oln/21_conversion 1.18 640) @@ -37,7 +37,8 @@ namespace oln { /*! - ** \brief Namespace for conversion (for example cast, color, or neighborhood to window). + ** \brief Conversion implementation (for example cast, color, or + ** neighborhood to window). */ namespace convert { @@ -56,7 +57,7 @@ typedef typename abstract::conversion<ConvType, Base>::template output<InputType>::ret ret; }; - /// namespace internal, should not be used by end user. + /// \brief Internal purpose only. namespace internal { /*! Compose a conversion C and an adaptable unary function UF, ** producing an adaptable unary function. Index: olena/oln/convol/convolution.hh --- olena/oln/convol/convolution.hh Sun, 14 Mar 2004 18:21:09 +0100 palma_g (oln/f/39_convolutio 1.4.1.4.1.6.1.2 640) +++ olena/oln/convol/convolution.hh Mon, 15 Mar 2004 16:51:22 +0100 van-vl_n (oln/f/39_convolutio 1.4.1.4.1.6.1.3 640) @@ -37,18 +37,11 @@ namespace oln { - /*! - ** \brief convolution namespace. - ** - ** Set of algorithms related to convolution. + /*! \brief Algorithms related to convolution. */ namespace convol { - /*! - ** \brief oln::convol::slow namespace. - ** - ** The algorithms you can find here are slow. This mean there are - ** only basic applications of the definitions. + /*! \brief Convolution algorithms. */ namespace slow { Index: olena/oln/convol/fast_gaussian.hh --- olena/oln/convol/fast_gaussian.hh Sun, 14 Mar 2004 18:21:09 +0100 palma_g (oln/26_fast_gauss 1.6.1.6.1.5 640) +++ olena/oln/convol/fast_gaussian.hh Mon, 15 Mar 2004 16:08:49 +0100 van-vl_n (oln/26_fast_gauss 1.6.1.6.1.6 640) @@ -41,10 +41,10 @@ namespace oln { namespace convol { /*! - ** \brief oln::convol::fast namespace. + ** \brief Implementation of algorithms for large structuring elements. ** ** The algorithms you can find here are fast. This mean these ones - ** are evolved versions. + ** are evolved versions for large structuring elements. */ namespace fast { Index: olena/oln/convol/fast_gaussian.hxx --- olena/oln/convol/fast_gaussian.hxx Mon, 15 Mar 2004 15:32:27 +0100 van-vl_n (oln/25_fast_gauss 1.7.1.8.1.8 640) +++ olena/oln/convol/fast_gaussian.hxx Mon, 15 Mar 2004 17:30:37 +0100 van-vl_n (oln/25_fast_gauss 1.7.1.8.1.9 640) @@ -38,10 +38,7 @@ namespace oln { namespace convol { namespace fast { - /*! - ** \brief oln::convol::fast::internal namespace. - ** - ** You can find here function used for fast algorithms. + /*! \brief Internal purpose only. */ namespace internal { Index: olena/oln/core/abstract/dpoint.hh --- olena/oln/core/abstract/dpoint.hh Thu, 11 Mar 2004 17:12:19 +0100 thivol_d (oln/d/28_dpoint.hh 1.19 640) +++ olena/oln/core/abstract/dpoint.hh Mon, 15 Mar 2004 17:32:25 +0100 van-vl_n (oln/d/28_dpoint.hh 1.20 640) @@ -247,11 +247,8 @@ } // end of abstract - /*! \namespace oln::internal - ** \brief internal namespace. + /*! \brief Internal purpose only. */ - - namespace internal { Index: olena/oln/core/abstract/iter.hh --- olena/oln/core/abstract/iter.hh Sun, 14 Mar 2004 18:21:09 +0100 palma_g (oln/c/40_iter.hh 1.19 640) +++ olena/oln/core/abstract/iter.hh Mon, 15 Mar 2004 16:50:54 +0100 van-vl_n (oln/c/40_iter.hh 1.20 640) @@ -36,9 +36,7 @@ namespace oln { - /*! - ** \namespace oln::abstract - ** \brief oln::abstract namespace. + /*! \brief Abstract class implementation. */ namespace abstract { template<class Exact> @@ -136,7 +134,7 @@ ** \endcode ** ** You can iterate not only image but windows. This example make a binary - ** dilatation to show you how use them: + ** dilatation to show you how to use them: ** \code ** #include <oln/basics2d.hh> ** #include <ntg/all.hh> Index: olena/oln/level/cc.hh --- olena/oln/level/cc.hh Mon, 15 Mar 2004 15:32:27 +0100 van-vl_n (oln/e/20_cc.hh 1.11.1.13 640) +++ olena/oln/level/cc.hh Mon, 15 Mar 2004 16:54:36 +0100 van-vl_n (oln/e/20_cc.hh 1.11.1.14 640) @@ -49,8 +49,7 @@ # include <mlc/is_a.hh> namespace oln { - /*! \namespace oln::level - ** \brief level namespace. + /*! \brief Level algorithm implementation. */ namespace level { Index: olena/oln/math/macros.hh --- olena/oln/math/macros.hh Mon, 15 Mar 2004 15:32:27 +0100 van-vl_n (oln/b/21_macros.hh 1.6.1.13 640) +++ olena/oln/math/macros.hh Mon, 15 Mar 2004 16:55:15 +0100 van-vl_n (oln/b/21_macros.hh 1.6.1.14 640) @@ -33,7 +33,7 @@ namespace oln { - /*! Useful functions. + /*! \brief Useful functions. ** ** \todo FIXME: I'm not proud of the code below ** think it could be better... Index: olena/oln/morpho/extrema.hh --- olena/oln/morpho/extrema.hh Fri, 12 Mar 2004 13:29:59 +0100 palma_g (oln/38_extrema.hh 1.13 640) +++ olena/oln/morpho/extrema.hh Mon, 15 Mar 2004 16:56:53 +0100 van-vl_n (oln/38_extrema.hh 1.14 640) @@ -35,29 +35,19 @@ namespace oln { namespace morpho { - /*! - ** \brief oln::morpho::sure namespace. - ** - ** Namespace where you can find reference algorithms, i.e. those - ** that are sure. + /*! \brief Reference algorithm implementation: sure but slow. */ namespace sure { # include <oln/morpho/extrema.hxx> } - /*! - ** \brief oln::morpho::sequential namespace. - ** - ** Namespace where you can find sequential algorithms. + /*! \brief Sequential algorithm implementation. */ namespace sequential { # include <oln/morpho/extrema.hxx> } - /*! - ** \brief oln::morpho::hybrid namespace. - ** - ** Namespace where you can find hybrid algorithms. + /*! \brief Hybrid (sure and sequential) algorithm implementation. */ namespace hybrid { # include <oln/morpho/extrema.hxx> Index: olena/oln/morpho/extrema.hxx --- olena/oln/morpho/extrema.hxx Mon, 15 Mar 2004 15:32:27 +0100 van-vl_n (oln/j/4_extrema.hx 1.15 640) +++ olena/oln/morpho/extrema.hxx Mon, 15 Mar 2004 16:28:44 +0100 van-vl_n (oln/j/4_extrema.hx 1.16 640) @@ -26,7 +26,7 @@ // Public License. /*! -** \brief internal namespace +** \brief Internal purpose only. */ namespace internal { Index: olena/oln/morpho/fast_morpho.hxx --- olena/oln/morpho/fast_morpho.hxx Sun, 14 Mar 2004 18:21:09 +0100 palma_g (oln/45_fast_morph 1.20 640) +++ olena/oln/morpho/fast_morpho.hxx Mon, 15 Mar 2004 17:14:49 +0100 van-vl_n (oln/45_fast_morph 1.21 640) @@ -40,9 +40,7 @@ namespace oln { namespace morpho { - /*! - ** \brief oln::morpho::internal namespace - ** Internal stuff. + /*! \brief Internal purpose only. */ namespace internal { Index: olena/oln/topo/dmap.hh --- olena/oln/topo/dmap.hh Mon, 15 Mar 2004 15:32:27 +0100 van-vl_n (oln/p/2_dmap.hh 1.10 640) +++ olena/oln/topo/dmap.hh Mon, 15 Mar 2004 17:12:39 +0100 van-vl_n (oln/p/2_dmap.hh 1.11 640) @@ -44,7 +44,7 @@ namespace oln { - /// Namespce topo. + /// \brief Topological algorithms. namespace topo { /*! Chamfer mask. ** Index: olena/oln/utils/histogram.hh --- olena/oln/utils/histogram.hh Mon, 15 Mar 2004 15:32:27 +0100 van-vl_n (oln/10_histogram. 1.6.1.14.1.8 640) +++ olena/oln/utils/histogram.hh Mon, 15 Mar 2004 17:18:31 +0100 van-vl_n (oln/10_histogram. 1.6.1.14.1.9 640) @@ -39,10 +39,10 @@ # include <vector> namespace oln { - /// Namespace for utilities, such as statistic. + /// \brief Utilities, such as statistics. namespace utils { - /// Function within this namespace should not be used outside this file. + /// \brief Internal purpose only. namespace internal { //! Return the size of the space needed to explore the type T. template <typename T> @@ -83,7 +83,7 @@ }; } // end of namespace internal - /// Namespace for abstract utilities. + /// \brief Abstract utilities. namespace abstract { /*! Abstract base class for historgram. Index: olena/oln/morpho/attribute_closing_opening.hh --- olena/oln/morpho/attribute_closing_opening.hh Sun, 14 Mar 2004 19:03:34 +0100 van-vl_n (oln/q/49_attribute_ 1.21 640) +++ olena/oln/morpho/attribute_closing_opening.hh Mon, 15 Mar 2004 17:33:39 +0100 van-vl_n (oln/q/49_attribute_ 1.22 640) @@ -32,24 +32,16 @@ namespace oln { - /*! \namespace oln::morpho - ** \brief oln::morpho namespace + /*! \brief Algorithm based on morphological mathematic. */ namespace morpho { - /*! - ** \brief oln::morpho::fast namespace - ** - ** In this namespace, you will find fast algorithms, but with intensive memory usage + /*! \brief Algorithm enhanced for large structuring elements. */ namespace fast { - /*! - ** \brief oln::morpho::fast::tarjan namespace + /*! \brief oln::morpho::tarjan implementation. */ namespace tarjan { - /*! - ** \brief oln::morpho::fast::tarjan::internal namespace - ** - ** Internal usage only. + /*! \brief Internal purpose only. */ namespace internal { Index: olena/oln/topo/tarjan/union.hh --- olena/oln/topo/tarjan/union.hh Mon, 15 Mar 2004 15:32:27 +0100 van-vl_n (oln/r/33_union.hh 1.10 640) +++ olena/oln/topo/tarjan/union.hh Mon, 15 Mar 2004 16:59:55 +0100 van-vl_n (oln/r/33_union.hh 1.11 640) @@ -35,7 +35,7 @@ namespace oln { namespace topo { - /// Namespace Tarjan + /// \brief FIXME: depreciated, use oln::morpho::tarjan namespace tarjan { struct empty_class Index: olena/oln/topo/inter-pixel/node.hh --- olena/oln/topo/inter-pixel/node.hh Sun, 14 Mar 2004 19:03:34 +0100 van-vl_n (oln/r/46_node.hh 1.6 640) +++ olena/oln/topo/inter-pixel/node.hh Mon, 15 Mar 2004 16:37:40 +0100 van-vl_n (oln/r/46_node.hh 1.7 640) @@ -33,7 +33,7 @@ namespace oln { namespace topo { - /// Namespace for inter pixel, + /// oln::topo::inter_pixel::interpixel implementation. namespace inter_pixel { /*! Inter pixel node. ** Index: olena/oln/topo/inter-pixel/internal/dir.hh --- olena/oln/topo/inter-pixel/internal/dir.hh Mon, 15 Mar 2004 15:32:27 +0100 van-vl_n (oln/r/48_dir.hh 1.4 640) +++ olena/oln/topo/inter-pixel/internal/dir.hh Mon, 15 Mar 2004 17:15:24 +0100 van-vl_n (oln/r/48_dir.hh 1.5 640) @@ -37,7 +37,7 @@ namespace topo { namespace inter_pixel { - /// oln::topo::inter_pixel Internal namespace. + /// \brief Internal purpose only. namespace internal { /// Provides the enum dir. template<unsigned Dim> Index: olena/oln/core/abstract/image.hh --- olena/oln/core/abstract/image.hh Fri, 12 Mar 2004 20:17:58 +0100 thivol_d (oln/t/25_image.hh 1.25 640) +++ olena/oln/core/abstract/image.hh Mon, 15 Mar 2004 15:54:27 +0100 van-vl_n (oln/t/25_image.hh 1.26 600) @@ -37,10 +37,6 @@ namespace oln { - /*! \namespace abstract - ** \brief abstract namespace. - */ - namespace abstract { // fwd_decl Index: olena/oln/core/impl/image_array.hh --- olena/oln/core/impl/image_array.hh Fri, 12 Mar 2004 20:17:58 +0100 thivol_d (oln/t/30_image_arra 1.15 640) +++ olena/oln/core/impl/image_array.hh Mon, 15 Mar 2004 16:52:49 +0100 van-vl_n (oln/t/30_image_arra 1.16 600) @@ -82,11 +82,8 @@ }; - /*! \namespace impl - ** - ** \brief impl namespace. + /*! \brief Representation of the image in memory. */ - namespace impl { /*! \class image_array Index: olena/oln/convert/abstract/conversion.hh --- olena/oln/convert/abstract/conversion.hh Sat, 13 Mar 2004 17:45:05 +0100 van-vl_n (oln/u/31_conversion 1.5 640) +++ olena/oln/convert/abstract/conversion.hh Mon, 15 Mar 2004 16:52:04 +0100 van-vl_n (oln/u/31_conversion 1.6 640) @@ -35,7 +35,7 @@ namespace oln { namespace convert { /*! - ** \brief Namespace oln::convert::abstract. + ** \brief Base classes for conversion. */ namespace abstract { @@ -54,8 +54,7 @@ template<class Conv> struct conversion_traits; - /*! - ** Namespace oln::convert::abstract::internal, for internal usage only. + /*! \brief Internal purpose only. */ namespace internal { /// Retrieve the result type of a conversion. @@ -82,7 +81,7 @@ namespace abstract { /*! Base class for conversion. ** - ** \note If you write an class inherited from this one, you + ** \note If you write an class derived from this one, you ** must write the specialization of the output trait. */ template<class Exact, class Base> Index: olena/oln/snakes/snakes_base.hh --- olena/oln/snakes/snakes_base.hh Mon, 15 Mar 2004 15:32:27 +0100 van-vl_n (oln/f/50_snakes_bas 1.3 644) +++ olena/oln/snakes/snakes_base.hh Mon, 15 Mar 2004 17:20:34 +0100 van-vl_n (oln/f/50_snakes_bas 1.4 644) @@ -32,8 +32,7 @@ namespace oln { - /*! \namespace oln::snakes - ** Namespace snakes. + /*! \brief oln::snakes::snake implementation. */ namespace snakes { /*! Snake algorithm. Index: olena/oln/morpho/attributes.hh --- olena/oln/morpho/attributes.hh Sun, 14 Mar 2004 19:03:34 +0100 van-vl_n (oln/j/45_attributes 1.8 644) +++ olena/oln/morpho/attributes.hh Mon, 15 Mar 2004 16:58:28 +0100 van-vl_n (oln/j/45_attributes 1.9 644) @@ -48,8 +48,7 @@ namespace oln { namespace morpho { - /*! - ** \brief oln::morpho::tools namespace + /*! \brief Useful tools for morphological math. */ namespace tools { Index: olena/oln/morpho/attribute_closing_opening_map.hh --- olena/oln/morpho/attribute_closing_opening_map.hh Sun, 14 Mar 2004 18:21:09 +0100 palma_g (oln/j/49_attribute_ 1.7 600) +++ olena/oln/morpho/attribute_closing_opening_map.hh Mon, 15 Mar 2004 16:57:32 +0100 van-vl_n (oln/j/49_attribute_ 1.8 600) @@ -46,11 +46,8 @@ { namespace morpho { - /*! - ** \brief oln::morpho::slow namespace - ** - ** In this namespace you will find algorithm slower than those you - ** can find in oln::morpho::fast, but with less memory needs. + /*! \brief Algorithm that are slow (but need less memory), or that are slow + ** if it is used with a large structuring element. */ namespace slow {

2 1

oln: 10.88 (fix doxygen coding style)
by Niels Van Vliet 16 Mar '04

16 Mar '04

from Niels Van Vliet <niels(a)lrde.epita.fr> * olena/oln/arith/internal/opdecls.hh: Changed doxygen commands "\{''|attention|warning|bug|note} FIXME" to "\todo FIXME", "\ref" to "REF: ", "\file *.hh" to "\file oln/full/path/*.hh". * olena/oln/convert/bound.hh: Likewise. * olena/oln/convert/nrgbxyz.hh: Likewise. * olena/oln/convert/rgbnrgb.hh: Likewise. * olena/oln/convert/rgbxyz.hh: Likewise. * olena/oln/convol/fast_gaussian.hxx: Likewise. * olena/oln/level/cc.hh: Likewise. * olena/oln/level/connected.hh: Likewise. * olena/oln/level/invert.hh: Likewise. * olena/oln/math/macros.hh: Likewise. * olena/oln/morpho/extrema.hxx: Likewise. * olena/oln/topo/dmap.hh: Likewise. * olena/oln/topo/dmap.hh: Likewise. * olena/oln/utils/copy.hh: Likewise. * olena/oln/utils/histogram.hh: Likewise. * olena/oln/morpho/attribute_union_find.hh: Likewise. * olena/oln/topo/tarjan/union.hh: Likewise. * olena/oln/topo/inter-pixel/inter-pixel.hh: Likewise. * olena/oln/topo/tarjan/flat-zone.hh: Likewise. * olena/oln/topo/combinatorial-map/cmap.hh: Likewise. * olena/oln/topo/inter-pixel/fwd-dir-iter.hh: Likewise. * olena/oln/topo/inter-pixel/bkd-dir-iter.hh: Likewise. * olena/oln/topo/inter-pixel/internal/dir.hh: Likewise. * olena/oln/topo/combinatorial-map/internal/anyfunc.hh: Likewise. * olena/oln/convert/rgbhsv.hh: Likewise. * olena/oln/convert/rgbhsl.hh: Likewise. * olena/oln/convert/rgbhsi.hh: Likewise. * olena/oln/convert/rgbyuv.hh: Likewise. * olena/oln/convert/rgbyiq.hh: Likewise. * olena/oln/snakes/snakes_base.hh: Likewise. * olena/oln/snakes/node.hh: Likewise. * olena/oln/snakes/segment.hh: Likewise. +2004-03-14 Niels Van Vliet <niels(a)lrde.epita.fr> * olena/oln/topo/dmap.hh: Correct comments. * olena/oln/topo/tarjan/flat-zone.hh: Likewise. Index: olena/oln/arith/internal/opdecls.hh --- olena/oln/arith/internal/opdecls.hh Sat, 13 Mar 2004 17:58:18 +0100 van-vl_n (oln/b/22_opdecls.hh 1.16 640) +++ olena/oln/arith/internal/opdecls.hh Mon, 15 Mar 2004 13:39:28 +0100 van-vl_n (oln/b/22_opdecls.hh 1.16 640) @@ -28,7 +28,7 @@ #ifndef OLENA_ARITH_INTERNAL_OPDECLS_HH # define OLENA_ARITH_INTERNAL_OPDECLS_HH -/*! \file opdecls.hh +/*! \file olena/oln/arith/internal/opdecls.hh ** ** Operations are defined between two images and between one image and ** one constant value (with the cst suffix). Index: olena/oln/convert/bound.hh --- olena/oln/convert/bound.hh Sat, 13 Mar 2004 17:45:05 +0100 van-vl_n (oln/22_bound.hh 1.11 640) +++ olena/oln/convert/bound.hh Mon, 15 Mar 2004 13:48:54 +0100 van-vl_n (oln/22_bound.hh 1.11 640) @@ -37,7 +37,7 @@ /*! Like convert::force, but with saturation. ** - ** \note FIXME: is this really useful with new types ? + ** \todo FIXME: is this really useful with new types ? */ template<class Output, class Exact = mlc::final> struct bound : public abstract::conversion_to_type< Output, typename mlc::exact_vt<bound<Output, Exact>, Exact>::ret > Index: olena/oln/convert/nrgbxyz.hh --- olena/oln/convert/nrgbxyz.hh Sun, 14 Mar 2004 19:03:34 +0100 van-vl_n (oln/16_nrgbxyz.hh 1.14 640) +++ olena/oln/convert/nrgbxyz.hh Mon, 15 Mar 2004 13:36:36 +0100 van-vl_n (oln/16_nrgbxyz.hh 1.14 640) @@ -37,9 +37,9 @@ # include <sstream> -/*! \file nrgbxyz.hh +/*! \file olena/oln/convert/nrgbxyz.hh ** -** \ref The formulas used here come from ``Digital Image Processing +** REF: The formulas used here come from ``Digital Image Processing ** Algorithms and Applications'', I. Pitas; Wiley-Interscience. */ Index: olena/oln/convert/rgbnrgb.hh --- olena/oln/convert/rgbnrgb.hh Sat, 13 Mar 2004 17:45:05 +0100 van-vl_n (oln/17_rgbnrgb.hh 1.12 640) +++ olena/oln/convert/rgbnrgb.hh Mon, 15 Mar 2004 13:37:10 +0100 van-vl_n (oln/17_rgbnrgb.hh 1.12 640) @@ -37,8 +37,9 @@ # include <sstream> -/*! \file rgbnrgb.hh -** \ref The formulas used here come from ``Digital Image Processing +/*! \file olena/oln/convert/rgbnrgb.hh +** +** REF: The formulas used here come from ``Digital Image Processing ** Algorithms and Applications'', I. Pitas; Wiley-Interscience. */ Index: olena/oln/convert/rgbxyz.hh --- olena/oln/convert/rgbxyz.hh Sat, 13 Mar 2004 17:45:05 +0100 van-vl_n (oln/19_rgbxyz.hh 1.13 640) +++ olena/oln/convert/rgbxyz.hh Mon, 15 Mar 2004 13:37:25 +0100 van-vl_n (oln/19_rgbxyz.hh 1.13 640) @@ -37,9 +37,9 @@ # include <sstream> -/*! \file rgbxyz.hh +/*! \file olena/oln/convert/rgbxyz.hh ** -** \ref The formulas used here come from ``Digital Image Processing +** REF: The formulas used here come from ``Digital Image Processing ** Algorithms and Applications'', I. Pitas; Wiley-Interscience. */ Index: olena/oln/convol/fast_gaussian.hxx --- olena/oln/convol/fast_gaussian.hxx Sun, 14 Mar 2004 18:21:09 +0100 palma_g (oln/25_fast_gauss 1.7.1.8.1.7 640) +++ olena/oln/convol/fast_gaussian.hxx Mon, 15 Mar 2004 13:43:59 +0100 van-vl_n (oln/25_fast_gauss 1.7.1.8.1.7 640) @@ -1,4 +1,4 @@ -// Copyright (C) 2001, 2002, 2003 EPITA Research and Development Laboratory +// Copyright (C) 2001, 2002, 2003, 2004 EPITA Research and Development Laboratory // // This file is part of the Olena Library. This library is free // software; you can redistribute it and/or modify it under the terms @@ -49,7 +49,8 @@ ** \brief Recursive filter. ** ** Recursive filter, works on a line. - ** FIXME: Until something clever is designed, the line is + ** + ** \todo FIXME: Until something clever is designed, the line is ** defined by two points (START and FINISH) and a displacement ** dpoint (D). ** Index: olena/oln/level/cc.hh --- olena/oln/level/cc.hh Sun, 14 Mar 2004 19:03:34 +0100 van-vl_n (oln/e/20_cc.hh 1.11.1.12 640) +++ olena/oln/level/cc.hh Mon, 15 Mar 2004 13:33:21 +0100 van-vl_n (oln/e/20_cc.hh 1.11.1.12 640) @@ -63,7 +63,7 @@ ** It removes the small (in area) connected components of the upper ** level sets of \a input using \a se as structural element. ** - ** \ref The implementation uses front propagation. + ** REF: The implementation uses front propagation. ** ** \pre the input must be a binary image. ** Index: olena/oln/level/connected.hh --- olena/oln/level/connected.hh Thu, 11 Mar 2004 16:11:20 +0100 van-vl_n (oln/30_connected. 1.9.1.12 640) +++ olena/oln/level/connected.hh Mon, 15 Mar 2004 13:33:30 +0100 van-vl_n (oln/30_connected. 1.9.1.12 640) @@ -48,7 +48,7 @@ ** It removes the small (in area) connected components of the upper ** level sets of \var{input} using \var{se} as structural element. ** - ** \ref The implementation comes from Cocquerez et Philipp, Analyse + ** REF: The implementation comes from Cocquerez et Philipp, Analyse ** d'images, filtrages et segmentations p.62. ** ** \see level::frontp_connected_component Index: olena/oln/level/invert.hh --- olena/oln/level/invert.hh Thu, 11 Mar 2004 16:11:20 +0100 van-vl_n (oln/33_invert.hh 1.5.2.2.1.11 640) +++ olena/oln/level/invert.hh Mon, 15 Mar 2004 13:44:27 +0100 van-vl_n (oln/33_invert.hh 1.5.2.2.1.11 640) @@ -42,7 +42,7 @@ /*! \brief Fctor to invert a value ** ** \see invert. - ** \note FIXME: the specialisation is done within the class. + ** \todo FIXME: the specialisation is done within the class. */ template<class T> struct f_invert : public std::unary_function<const ntg::value<T>&, T> Index: olena/oln/math/macros.hh --- olena/oln/math/macros.hh Sat, 13 Mar 2004 17:58:18 +0100 van-vl_n (oln/b/21_macros.hh 1.6.1.12 640) +++ olena/oln/math/macros.hh Mon, 15 Mar 2004 13:49:12 +0100 van-vl_n (oln/b/21_macros.hh 1.6.1.12 640) @@ -33,10 +33,9 @@ namespace oln { - /*! \namespace oln:math - ** useful functions. + /*! Useful functions. ** - ** \note FIXME: I'm not proud of the code below + ** \todo FIXME: I'm not proud of the code below ** think it could be better... ** ** \todo FIXME: this code sounds really odd. Why does the operator() Index: olena/oln/morpho/extrema.hxx --- olena/oln/morpho/extrema.hxx Sun, 14 Mar 2004 18:21:09 +0100 palma_g (oln/j/4_extrema.hx 1.14 640) +++ olena/oln/morpho/extrema.hxx Mon, 15 Mar 2004 13:34:25 +0100 van-vl_n (oln/j/4_extrema.hx 1.14 640) @@ -93,7 +93,6 @@ ** \arg minima_map Minima map image. ** \arg Ng Neighborhood to use. ** -** \ref foototo ** \code ** #include <oln/basics2d.hh> ** #include <oln/morpho/extrema.hh> Index: olena/oln/topo/dmap.hh --- olena/oln/topo/dmap.hh Sun, 14 Mar 2004 22:48:21 +0100 van-vl_n (oln/p/2_dmap.hh 1.9 640) +++ olena/oln/topo/dmap.hh Mon, 15 Mar 2004 13:47:34 +0100 van-vl_n (oln/p/2_dmap.hh 1.9 640) @@ -32,13 +32,13 @@ # include <oln/basics2d.hh> # include <oln/core/w_window2d.hh> -// FIXME: math.h should be included by ntg/config/system.hh +// \todo FIXME: math.h should be included by ntg/config/system.hh // # include <math.h> # include <utility> -/*! \file dmap.hh +/*! \file olena/oln/topo/dmap.hh ** -** \ref B.J.H. Verwer, Local distances for distance transformations +** REF: B.J.H. Verwer, Local distances for distance transformations ** in two and three dimensions, Pattern Recognition Letters 12 (1991) 671-682 */ @@ -68,7 +68,7 @@ /*! Produce a chamfer mask 3x3 ** - ** \bug FIXME: This highly not thread safe ! + ** \todo FIXME: This highly not thread safe ! ** ** \verbatim ** Example of oln::topo::mk_chamfer_3x3<1,2>(3) w; @@ -90,7 +90,7 @@ /*! Produce a chamfer mask 3x3 ** - ** \bug FIXME: This highly not thread safe ! + ** \todo FIXME: This highly not thread safe ! ** ** \verbatim ** Example of oln::topo::mk_chamfer_3x3(1.5, 2.5) w; Index: olena/oln/utils/copy.hh --- olena/oln/utils/copy.hh Sat, 13 Mar 2004 21:28:08 +0100 van-vl_n (oln/i/29_copy.hh 1.8 640) +++ olena/oln/utils/copy.hh Mon, 15 Mar 2004 13:39:05 +0100 van-vl_n (oln/i/29_copy.hh 1.8 640) @@ -28,7 +28,7 @@ #ifndef OLENA_UTILS_COPY_HH # define OLENA_UTILS_COPY_HH -/* \file copy.hh +/* \file olena/oln/utils/copy.hh ** ** \warning This file contains implementations of image's copy constructors. **\verbatim Index: olena/oln/utils/histogram.hh --- olena/oln/utils/histogram.hh Sat, 13 Mar 2004 21:28:08 +0100 van-vl_n (oln/10_histogram. 1.6.1.14.1.7 640) +++ olena/oln/utils/histogram.hh Mon, 15 Mar 2004 13:47:46 +0100 van-vl_n (oln/10_histogram. 1.6.1.14.1.7 640) @@ -137,7 +137,7 @@ ** number of occurrences in an image1d; an image<rgb_8> will store the ** number of occurrences an image3d (because rgb_8 has 3 components). ** - ** \note FIXME: An image is inside the histogram. This is incorrect + ** \todo FIXME: An image is inside the histogram. This is incorrect ** because it is not exactly an image (we do not need any border). ** ** \param T Type of the image. Index: olena/oln/morpho/attribute_union_find.hh --- olena/oln/morpho/attribute_union_find.hh Sun, 14 Mar 2004 19:03:34 +0100 van-vl_n (oln/q/50_attribute_ 1.17 640) +++ olena/oln/morpho/attribute_union_find.hh Mon, 15 Mar 2004 13:45:19 +0100 van-vl_n (oln/q/50_attribute_ 1.17 640) @@ -49,7 +49,7 @@ ** \param ATTRIBUTE Exact type of attribute to use. ** \param Env Type of environment to use. ** - ** \note FIXME: a similar class is defined in oln/topo/tarjan/union.hh + ** \todo FIXME: a similar class is defined in oln/topo/tarjan/union.hh ** (oln::topo::tarjan::tarjan_set). */ template<class T, class ATTRIBUTE, class Env = attr_env_type(ATTRIBUTE)> Index: olena/oln/topo/tarjan/union.hh --- olena/oln/topo/tarjan/union.hh Sun, 14 Mar 2004 18:15:46 +0100 van-vl_n (oln/r/33_union.hh 1.9 640) +++ olena/oln/topo/tarjan/union.hh Mon, 15 Mar 2004 13:41:41 +0100 van-vl_n (oln/r/33_union.hh 1.9 640) @@ -43,7 +43,7 @@ /*! Tarjan set. ** - ** \attention FIXME: a similar class is defined in + ** \todo FIXME: a similar class is defined in ** oln/morpho/attribute_union_find.hh (oln::morpho::tarjan::tarjan_set). ** The one in morpho is more general. I think that this class should ** be removed. Index: olena/oln/topo/inter-pixel/inter-pixel.hh --- olena/oln/topo/inter-pixel/inter-pixel.hh Sun, 14 Mar 2004 19:03:34 +0100 van-vl_n (oln/r/34_inter-pixe 1.14 640) +++ olena/oln/topo/inter-pixel/inter-pixel.hh Mon, 15 Mar 2004 13:49:42 +0100 van-vl_n (oln/r/34_inter-pixe 1.14 640) @@ -105,14 +105,14 @@ } } - /// FIXME: add doc. + /// \todo FIXME: add doc. const node_type& operator[](const point_type & p) const { return data_[p]; } - /*! FIXME: add doc. + /*! \todo FIXME: add doc. ** ** \pre precondition(data_[in.first].get(in.second) == true) */ Index: olena/oln/topo/tarjan/flat-zone.hh --- olena/oln/topo/tarjan/flat-zone.hh Sun, 14 Mar 2004 22:48:21 +0100 van-vl_n (oln/r/35_flat-zone. 1.11 640) +++ olena/oln/topo/tarjan/flat-zone.hh Mon, 15 Mar 2004 13:54:17 +0100 van-vl_n (oln/r/35_flat-zone. 1.11 640) @@ -57,11 +57,11 @@ ** IMG_OUT "oln_topo_flat_zone.pgm"); ** } ** \endcode - ** \image html test-cmap_pgm.png width=6cm - ** \image latex test-cmap_pgm.png width=6cm + ** \image html test-cmap_pgm.png "input image" width=6cm + ** \image latex test-cmap_pgm.png "input image" width=6cm ** => - ** \image html oln_topo_flat_zone.png width=6cm - ** \image latex oln_topo_flat_zone.png width=6cm + ** \image html oln_topo_flat_zone.png "output image" width=6cm + ** \image latex oln_topo_flat_zone.png "output image" width=6cm */ template <class I> struct flat_zone Index: olena/oln/topo/combinatorial-map/cmap.hh --- olena/oln/topo/combinatorial-map/cmap.hh Sun, 14 Mar 2004 18:15:46 +0100 van-vl_n (oln/r/36_cmap.hh 1.12 640) +++ olena/oln/topo/combinatorial-map/cmap.hh Mon, 15 Mar 2004 13:41:57 +0100 van-vl_n (oln/r/36_cmap.hh 1.12 640) @@ -37,9 +37,9 @@ # include <algorithm> # include <iterator> -/*! \file cmap.hh +/*! \file olena/oln/topo/combinatorial-map/cmap.hh ** -** \attention FIXME: There is some problems in the directory topo/combinatorial-map/, +** \todo FIXME: There is some problems in the directory topo/combinatorial-map/, ** such as non static functions, or the redefinition of the class any.\n ** FIXME: The documentation is not good enough.\n ** FIXME: Real test are missing. @@ -54,7 +54,7 @@ /*! Combinatorial map. ** - ** \ref Braquelaire, J. P. and Brun, L. Image Segmentation with + ** REF: Braquelaire, J. P. and Brun, L. Image Segmentation with ** Topological Maps and Inter-pixel Representation}, Journal of ** Visual Communication and Image representation, 1998, vol. 9 */ Index: olena/oln/topo/inter-pixel/fwd-dir-iter.hh --- olena/oln/topo/inter-pixel/fwd-dir-iter.hh Sun, 14 Mar 2004 18:15:46 +0100 van-vl_n (oln/r/44_fwd-dir-it 1.5 640) +++ olena/oln/topo/inter-pixel/fwd-dir-iter.hh Mon, 15 Mar 2004 13:46:14 +0100 van-vl_n (oln/r/44_fwd-dir-it 1.5 640) @@ -69,7 +69,7 @@ /*! Assignment. ** - ** \bug FIXME: I am not sure that this respect the new paradigm. + ** \todo FIXME: I am not sure that this respect the new paradigm. */ template<class U> U Index: olena/oln/topo/inter-pixel/bkd-dir-iter.hh --- olena/oln/topo/inter-pixel/bkd-dir-iter.hh Sun, 14 Mar 2004 18:15:46 +0100 van-vl_n (oln/r/45_bkd-dir-it 1.5 640) +++ olena/oln/topo/inter-pixel/bkd-dir-iter.hh Mon, 15 Mar 2004 13:50:14 +0100 van-vl_n (oln/r/45_bkd-dir-it 1.5 640) @@ -67,7 +67,7 @@ /*! Assignment. ** - ** \bug FIXME: I am not sure that this respect the new paradigm. + ** \todo FIXME: I am not sure that this respect the new paradigm. */ template<class U> U Index: olena/oln/topo/inter-pixel/internal/dir.hh --- olena/oln/topo/inter-pixel/internal/dir.hh Sun, 14 Mar 2004 18:15:46 +0100 van-vl_n (oln/r/48_dir.hh 1.3 640) +++ olena/oln/topo/inter-pixel/internal/dir.hh Mon, 15 Mar 2004 13:45:43 +0100 van-vl_n (oln/r/48_dir.hh 1.3 640) @@ -79,7 +79,7 @@ /*! Opposit direction. ** - ** \note FIXME: no modulus. + ** \todo FIXME: no modulus. */ static ret opposite(ret i) Index: olena/oln/topo/combinatorial-map/internal/anyfunc.hh --- olena/oln/topo/combinatorial-map/internal/anyfunc.hh Sun, 14 Mar 2004 18:15:46 +0100 van-vl_n (oln/v/3_anyfunc.hh 1.3 600) +++ olena/oln/topo/combinatorial-map/internal/anyfunc.hh Mon, 15 Mar 2004 13:46:59 +0100 van-vl_n (oln/v/3_anyfunc.hh 1.3 600) @@ -42,7 +42,7 @@ /*! any ** - ** \deprecated FIXME: totally obsolete. + ** \todo FIXME: totally obsolete. */ template <class Inf> class any @@ -55,7 +55,7 @@ /*! Function stored in a vector. ** ** - ** \warning FIXME: It has nothing to do there. + ** \todo FIXME: It has nothing to do there. */ template <class U, class V, class Inf> class anyfunc : public any<Inf> Index: olena/oln/convert/rgbhsv.hh --- olena/oln/convert/rgbhsv.hh Sat, 13 Mar 2004 17:45:05 +0100 van-vl_n (oln/j/35_rgbhsv.hh 1.2 644) +++ olena/oln/convert/rgbhsv.hh Mon, 15 Mar 2004 13:37:02 +0100 van-vl_n (oln/j/35_rgbhsv.hh 1.2 644) @@ -40,8 +40,8 @@ # include <sstream> -/*! \file rgbhsv.hh -** \ref The formulas used here come from ``Color Conversion Algorithms'' +/*! \file olena/oln/convert/rgbhsv.hh +** REF: The formulas used here come from ``Color Conversion Algorithms'' */ namespace oln { Index: olena/oln/convert/rgbhsl.hh --- olena/oln/convert/rgbhsl.hh Sun, 14 Mar 2004 18:21:09 +0100 palma_g (oln/j/36_rgbhsl.hh 1.3 644) +++ olena/oln/convert/rgbhsl.hh Mon, 15 Mar 2004 13:39:55 +0100 van-vl_n (oln/j/36_rgbhsl.hh 1.3 644) @@ -41,9 +41,9 @@ # include <cstdlib> # include <sstream> -/*! \file rgbhsl.hh +/*! \file olena/oln/convert/rgbhsl.hh ** -** \ref The formulas used here come from ``Color space conversion''; Paul +** REF: The formulas used here come from ``Color space conversion''; Paul ** Bourke. */ namespace oln { Index: olena/oln/convert/rgbhsi.hh --- olena/oln/convert/rgbhsi.hh Sat, 13 Mar 2004 17:45:05 +0100 van-vl_n (oln/j/37_rgbhsi.hh 1.2 644) +++ olena/oln/convert/rgbhsi.hh Mon, 15 Mar 2004 13:36:53 +0100 van-vl_n (oln/j/37_rgbhsi.hh 1.2 644) @@ -37,9 +37,9 @@ # include <sstream> -/*! \file rgbhsi.hh +/*! \file olena/oln/convert/rgbhsi.hh ** -** \ref The formulas used here come from ``Digital Image Processing +** REF: The formulas used here come from ``Digital Image Processing ** Algorithms and Applications'', I. Pitas; Wiley-Interscience. */ Index: olena/oln/convert/rgbyuv.hh --- olena/oln/convert/rgbyuv.hh Sat, 13 Mar 2004 17:45:05 +0100 van-vl_n (oln/j/38_rgbyuv.hh 1.2 644) +++ olena/oln/convert/rgbyuv.hh Mon, 15 Mar 2004 13:37:43 +0100 van-vl_n (oln/j/38_rgbyuv.hh 1.2 644) @@ -37,9 +37,9 @@ # include <sstream> -/*!\file rgbyuv.hh +/*!\file olena/oln/convert/rgbyuv.hh ** -** \ref The formulas used here come from ``Colour Space Conversions'', +** REF: The formulas used here come from ``Colour Space Conversions'', ** IAdrian Ford and Alan Roberts; August 11,1998. */ namespace oln { Index: olena/oln/convert/rgbyiq.hh --- olena/oln/convert/rgbyiq.hh Sat, 13 Mar 2004 17:45:05 +0100 van-vl_n (oln/j/39_rgbyiq.hh 1.2 644) +++ olena/oln/convert/rgbyiq.hh Mon, 15 Mar 2004 13:37:34 +0100 van-vl_n (oln/j/39_rgbyiq.hh 1.2 644) @@ -37,9 +37,9 @@ # include <sstream> -/*! \file rgbyiq.hh +/*! \file olena/oln/convert/rgbyiq.hh ** -** \ref The formulas used here come from ``Digital Image Processing +** REF: The formulas used here come from ``Digital Image Processing ** Algorithms and Applications'', I. Pitas; Wiley-Interscience. */ namespace oln { Index: olena/oln/snakes/snakes_base.hh --- olena/oln/snakes/snakes_base.hh Thu, 11 Mar 2004 15:41:55 +0100 van-vl_n (oln/f/50_snakes_bas 1.2 644) +++ olena/oln/snakes/snakes_base.hh Mon, 15 Mar 2004 13:48:14 +0100 van-vl_n (oln/f/50_snakes_bas 1.2 644) @@ -38,7 +38,7 @@ namespace snakes { /*! Snake algorithm. ** - ** \attention FIXME: Do not work due to the function node::energy. + ** \todo FIXME: Do not work due to the function node::energy. ** \todo FIXME: Add doc & test. */ template <class algorithm> @@ -64,7 +64,7 @@ ntg::float_s energy(void) const; ///< Return the snake energy. This is not algorithm-dependant. - ///< \attention FIXME: Do not work due to the function node::energy + ///< \todo FIXME: Do not work due to the function node::energy public: int Index: olena/oln/snakes/node.hh --- olena/oln/snakes/node.hh Thu, 11 Mar 2004 15:41:55 +0100 van-vl_n (oln/j/32_node.hh 1.2 644) +++ olena/oln/snakes/node.hh Mon, 15 Mar 2004 13:48:24 +0100 van-vl_n (oln/j/32_node.hh 1.2 644) @@ -36,7 +36,7 @@ /*! A node is a point used in ring. ** - ** \attention FIXME: Do not work due to the function energy. + ** \todo FIXME: Do not work due to the function energy. */ template<class I> class node : public I::point_type @@ -54,7 +54,7 @@ public: /*! Return the energy ** - ** FIXME: not implemented, do not work + ** \todo FIXME: not implemented, do not work */ inline ntg::float_s Index: olena/oln/snakes/segment.hh --- olena/oln/snakes/segment.hh Thu, 11 Mar 2004 15:41:55 +0100 van-vl_n (oln/j/34_segment.hh 1.2 644) +++ olena/oln/snakes/segment.hh Mon, 15 Mar 2004 13:42:29 +0100 van-vl_n (oln/j/34_segment.hh 1.2 644) @@ -39,7 +39,7 @@ /*! A segment is a list of node. ** - ** \attention FIXME: Do not work due to the function node::energy. + ** \todo FIXME: Do not work due to the function node::energy. */ template <class I> class segment

2 1

oln 10.93: add comments, correct older ones
by Damien Thivolle 15 Mar '04

15 Mar '04

Index: olena/ChangeLog from Damien Thivolle <damien(a)lrde.epita.fr> * olena/oln/core/apply.hh: Correct comments. * olena/oln/core/compose.hh: Correct comments. * olena/oln/io/file.hh: Add comments. * olena/oln/io/gz.hh: Likewise. * olena/oln/io/gz_stream.hh: Likewise. * olena/oln/io/pnm_read_3d.hh: Likewise. * olena/oln/io/pnm_read.hh: Likewise. * olena/oln/io/pnm_write_3d.hh: Likewise. * olena/oln/io/pnm_write.hh: Likewise. * olena/oln/io/pnm_common.hh: Likewise. * olena/oln/io/stream_wrapper.hh: Likewise. * olena/oln/io/pnm_read_data.hh: Likewise. * olena/oln/io/pnm_write_data.hh: Likewise. * olena/oln/io/pnm_read_2d.hh: Likewise. * olena/oln/io/pnm_write_2d.hh: Likewise. Index: olena/oln/core/apply.hh --- olena/oln/core/apply.hh Fri, 12 Mar 2004 20:17:58 +0100 thivol_d (oln/d/39_apply.hh 1.15 600) +++ olena/oln/core/apply.hh Mon, 15 Mar 2004 18:57:19 +0100 thivol_d (oln/d/39_apply.hh 1.15 600) @@ -40,9 +40,36 @@ | Unary | `------*/ - /*! \brief Standard unary \a apply procedure. Apply function f to each - ** element of input. + /*! \brief Standard unary \a apply procedure. Apply a function \a f to each + ** element of \a input. + ** + ** Sample of code : Threshold the value of the image. + ** + ** \code + ** #include <oln/basics2d.hh> + ** #include <oln/level/threshold.hh> + ** #include <ntg/all.hh> + ** using namespace ntg; + ** int main() + ** { + ** oln::image2d<int_u8> in = oln::load(IMG_IN "lena256.pgm"); + ** int_u8 th = 127; + ** rgb_8 low = rgb_8(100, 0, 0); + ** rgb_8 height = rgb_8(0, 200, 255); + ** + ** oln::image2d<rgb_8> out + ** = apply(oln::level::threshold<int_u8, rgb_8 >(th, low, height), + ** in); + ** save(out, IMG_OUT "oln_level_threshold.ppm"); + ** } + ** \endcode + ** \image html lena256_pgm.png + ** \image latex lena256_pgm.png + ** => + ** \image html oln_level_threshold.png + ** \image latex oln_level_threshold.png */ + template<class AdaptableUnaryFun, class I> inline typename mute<I, typename AdaptableUnaryFun::result_type>::ret apply(AdaptableUnaryFun f, const abstract::image<I>& input) @@ -55,9 +82,9 @@ } - /*! \brief Standard unary \a apply procedure. Apply function f to each - ** element of input, the function is passed as a type - ** and we build it ourself. + /*! \brief Standard unary \a apply procedure. Apply a function \a f to each + ** element of \a input, the function is passed as a type + ** and is instantiated. */ template<class AdaptableUnaryFun, class I> inline typename mute<I, typename AdaptableUnaryFun::result_type>::ret @@ -67,10 +94,10 @@ } - /*! \brief Standard unary \a apply procedure. Apply function f to each - ** element of input, the function is passed as a type - ** and we build it ourself. For template functions passed as template-id, - ** we need to instantiate the function for the type of the abstract::image. + /*! \brief Standard unary \a apply procedure. Apply function \a f to each + ** element of \a input, the function is passed as a type + ** and is instantiated. For template functions passed as template-id, + ** one need to instantiate the function for the type of the abstract::image. */ template<template<class> class AdaptableUnaryFun, class I> inline @@ -91,8 +118,8 @@ ** \todo FIXME: Don't we want to name these functions 'apply()' too? */ - /*! \brief Standard binary \a apply procedure. Apply function f to each - ** element of input1 and input2. + /*! \brief Standard binary \a apply procedure. Apply function \a f to each + ** element of \a input1 and \a input2. ** ** \todo FIXME: Don't we want to name these functions 'apply()' too? */ @@ -110,9 +137,9 @@ } - /*! \brief Standard binary \a apply procedure. Apply function f to each - ** element of input1 and input2. The function is passed as a type - ** and we build it ourself. + /*! \brief Standard binary \a apply procedure. Apply function \a f to each + ** element of \a input1 and \a input2. The function is passed as a type + ** and is instantiated. ** ** \todo FIXME: Don't we want to name these functions 'apply()' too? */ @@ -123,10 +150,10 @@ return apply2(AdaptableBinaryFun(), input1, input2); } - /*! \brief Standard binary \a apply procedure. Apply function f to each - ** element of input1 and input2. The function is passed as a type - ** and we build it ourself. For template functions passed as template-id, - ** we need to instantiate the function for the type of the + /*! \brief Standard binary \a apply procedure. Apply function \a f to each + ** element of \a input1 and \a input2. The function is passed as a type + ** and is instantiated. For template functions passed as template-id, + ** one need to instantiate the function for the type of the ** abstract::images. ** ** \todo FIXME: Don't we want to name these functions 'apply()' too? @@ -143,14 +170,13 @@ } - /*! \brief Standard binary \a apply procedure. Apply function f to each - ** element of input1 and input2. The function is passed as a type - ** and we build it ourself. For template functions passed as template-id, - ** we need to instantiate the function for the type of the + /*! \brief Standard binary \a apply procedure. Apply function \a f to each + ** element of \a input1 and \a input2. The function is passed as a type + ** and is instantiated. For template functions passed as template-id, + ** one need to instantiate the function for the type of the ** abstract::images. ** ** \todo FIXME: Don't we want to name these functions 'apply()' too?\n - ** FIXME: Workaround for g++-2.95 bug. */ template<template <class> class AdaptableBinaryFun, class I> inline @@ -168,9 +194,9 @@ | self unary | `-----------*/ - /*! \brief Main apply_self() function. Note we require a UnaryFun only, - ** not a AdaptableUnaryFunc, because as we overwrite an abstract::image - ** we already know the output type. + /*! \brief Main \a apply_self() function. Note only a UnaryFun is required, + ** not a AdaptableUnaryFunc, because as an abstract::image is overwritten, + ** the output type is already known. */ template<class UnaryFun, class I> inline abstract::image<I>& apply_self(UnaryFun f, abstract::image<I>& input) @@ -181,9 +207,9 @@ } - /*! \brief Main apply_self() function. Note we require a UnaryFun only, - ** not a AdaptableUnaryFunc, because as we overwrite an abstract::image - ** we already know the output type. We instantiate the function ourself. + /*! \brief Only a UnaryFun is required, + ** not a AdaptableUnaryFunc, because as an abstract::image is overwritten, + ** the output type is already known. The function is instantiated. */ template<class UnaryFun, class I> inline abstract::image<I>& apply_self(abstract::image<I>& input) @@ -192,11 +218,9 @@ } - /*! \brief Main apply_self() function. Note we require a UnaryFun only, - ** not a AdaptableUnaryFunc, because as we overwrite an abstract::image - ** we already know the output type. We instantiate the function ourself. - ** - ** \todo FIXME: Workaround for g++-2.95 bug. + /*! \brief Only a UnaryFun is required, + ** not a AdaptableUnaryFunc, because as an abstract::image is overwritten, + ** the output type is already know. The function is instantiated. */ template<template<class> class UnaryFun, class I> inline abstract::image<I>& apply_self(abstract::image<I>& input) @@ -211,7 +235,7 @@ | self binary | `------------*/ - /*! \brief Main apply2_exact() function. + /*! \brief Main \a apply2_exact() function. ** ** \see apply_self() */ @@ -226,7 +250,7 @@ } - /*! \brief We instantiate the function ourself. + /*! \brief The function is instantiated. ** ** \see apply_self() */ @@ -237,10 +261,8 @@ } - /*! \brief If the function is passed as a template-id, we - ** Instantiate it for the type of the input elements. - ** - ** \todo FIXME: Workaround for g++-2.95 bug. + /*! \brief If the function is passed as a template-id, it is + ** instantiated for the type of the input elements. ** ** \see apply_self() */ @@ -253,9 +275,7 @@ } - /*! apply2_self() if I1==I2 and the UnaryFun has only one parameter. - ** - ** \todo FIXME: Workaround for g++-2.95 bug. + /*! \brief If \a I1 == \a I2 and the UnaryFun has only one parameter. ** ** \see apply_self() */ Index: olena/oln/core/compose.hh --- olena/oln/core/compose.hh Fri, 12 Mar 2004 20:17:58 +0100 thivol_d (oln/c/22_compose.hh 1.6 600) +++ olena/oln/core/compose.hh Mon, 15 Mar 2004 14:03:43 +0100 thivol_d (oln/c/22_compose.hh 1.6 600) @@ -37,7 +37,7 @@ /*! \class compose_uu_ ** ** The operator () of this class performs a composition between - ** two unary functors F1 & F2. + ** two unary functors \a F1 & \a F2. */ template< class F1, class F2 > @@ -65,7 +65,7 @@ /*! \class compose_ub_ ** ** The operator () of this class performs a composition between - ** an unary functor F1 and a binary functor F2. + ** a unary functor \a F1 and a binary functor \a F2. */ @@ -96,7 +96,7 @@ /*! \class compose_bu_ ** ** The operator () of this class performs a composition between - ** a binary functor F1 and an unary functor F2. + ** a binary functor \a F1 and an unary functor \a F2. */ template< class F1, class F2 > @@ -126,7 +126,7 @@ } - /// Compose two unary functors F1 & F2. + /// Compose two unary functors \a F1 & \a F2. template<class UF1, class UF2> internal::compose_uu_<UF1, UF2> compose_uu(const UF1& f1, const UF2& f2) @@ -134,7 +134,7 @@ return internal::compose_uu_<UF1, UF2>(f1, f2); } - /// Compose an unary functors F1 with a binary functor F2. + /// Compose a unary functor \a F1 with a binary functor \a F2. template<class UF1, class BF2> internal::compose_ub_<UF1, BF2> compose_ub(const UF1& f1, const BF2& f2) @@ -142,7 +142,7 @@ return internal::compose_ub_<UF1, BF2>(f1, f2); } - /// Compose a binary functor F1 and an unary functor F2. + /// Compose a binary functor \a F1 and an unary functor \a F2. template<class BF1, class UF2> internal::compose_bu_<BF1, UF2> compose_bu(const BF1& f1, const UF2& f2) Index: olena/oln/io/file.hh --- olena/oln/io/file.hh Thu, 07 Aug 2003 02:37:23 +0200 burrus_n (oln/b/17_file.hh 1.5 600) +++ olena/oln/io/file.hh Mon, 15 Mar 2004 19:55:12 +0100 thivol_d (oln/b/17_file.hh 1.5 600) @@ -1,4 +1,4 @@ -// Copyright (C) 2001, 2002, 2003 EPITA Research and Development Laboratory +// Copyright (C) 2001, 2002, 2003, 2004 EPITA Research and Development Laboratory // // This file is part of the Olena Library. This library is free // software; you can redistribute it and/or modify it under the terms @@ -40,6 +40,11 @@ namespace internal { + /*! \class stream_wrapper<StreamFile> + ** + ** Specialized version for StreamFile. + */ + template<> struct stream_wrapper<StreamFile> { @@ -49,12 +54,14 @@ static const std::string name_("file:"); return name_; } + static bool knows_ext(const std::string&) // knows all extensions { return true; } + /// Open a input stream on the file named \a name. Return 0 on failure. static std::istream* wrap_in(std::string& name) { @@ -65,6 +72,7 @@ return 0; } + /// Open a output stream on the file named \a name. Return 0 on failure. static std::ostream* wrap_out(std::string& name) { @@ -75,6 +83,10 @@ return 0; } + /*! \brief Insert in \a names all the files that have the same + ** suffix as \a name in the \a name or the current directory. + */ + static void find(std::list<std::string>& names, const std::string& name) { Index: olena/oln/io/gz.hh --- olena/oln/io/gz.hh Thu, 07 Aug 2003 02:37:23 +0200 burrus_n (oln/f/16_gz.hh 1.6 600) +++ olena/oln/io/gz.hh Mon, 15 Mar 2004 18:58:29 +0100 thivol_d (oln/f/16_gz.hh 1.6 600) @@ -1,4 +1,4 @@ -// Copyright (C) 2001, 2002, 2003 EPITA Research and Development Laboratory +// Copyright (C) 2001, 2002, 2003, 2004 EPITA Research and Development Laboratory // // This file is part of the Olena Library. This library is free // software; you can redistribute it and/or modify it under the terms @@ -37,9 +37,18 @@ namespace internal { + + /*! \class stream_wrapper<StreamGz> + ** + ** Specialized version for StreamGz. + */ + template<> struct stream_wrapper<StreamGz> { + + /// Return "gz:" + static const std::string& name() { @@ -47,12 +56,16 @@ return name_; } + /// Return true if \a ext == "gz" or \a ext == "z' + static bool knows_ext(const std::string& ext) { return ext == "gz" || ext == "z"; } + + /// Delete the file extension of \a name. static void adjust_name(std::string& name) { @@ -61,6 +74,10 @@ name.erase(name.rfind('.')); } + /*! \brief Open a input stream on \a name then return it. + ** On failure \a wrap_in returns 0. + */ + static std::istream* wrap_in(std::string& name) { @@ -74,6 +91,9 @@ return 0; } + /*! \brief Open a output stream on \a name then return it. + ** On failure \a wrap_out returns 0. + */ static std::ostream* wrap_out(std::string& name) { Index: olena/oln/io/gz_stream.hh --- olena/oln/io/gz_stream.hh Thu, 07 Aug 2003 02:37:23 +0200 burrus_n (oln/f/17_gz_stream. 1.9 600) +++ olena/oln/io/gz_stream.hh Mon, 15 Mar 2004 19:00:02 +0100 thivol_d (oln/f/17_gz_stream. 1.9 600) @@ -1,4 +1,4 @@ -// Copyright (C) 2001, 2002, 2003 EPITA Research and Development Laboratory +// Copyright (C) 2001, 2002, 2003, 2004 EPITA Research and Development Laboratory // // This file is part of the Olena Library. This library is free // software; you can redistribute it and/or modify it under the terms @@ -39,12 +39,21 @@ namespace io { + /*! \namespace gz + ** \brief gz namespace + */ namespace gz { + + /*! \class zfilebuf + ** + ** Performs operation on compressed files. + */ class zfilebuf : public std::streambuf { public: + zfilebuf() : file(0), mode(0), own_file_descriptor(0) { inbuf = new char[lenbuf]; @@ -62,6 +71,10 @@ close(); } + + /*! \brief Return a stream on the file \a name regarding + ** the opening mode: \a io_mode. + */ zfilebuf* open(const char *name, int io_mode) { @@ -107,6 +120,9 @@ return this; } + /*! \brief Attach a stream on \a file_descriptor regarding + ** the opening mode: \a io_mode. + */ zfilebuf* attach(int file_descriptor, int io_mode) { @@ -152,6 +168,7 @@ return this; } + /// Close the stream. zfilebuf* close() { @@ -164,6 +181,7 @@ return this; } + int setcompressionlevel(short comp_level) { @@ -176,6 +194,7 @@ return gzsetparams(file, -2, comp_strategy); } + /// Return true if the stream is open, false otherwise. inline int is_open() const { return (file != 0); } @@ -186,6 +205,7 @@ return std::streampos(gzseek(file, off, dir)); } + /// Flush the buffer associated to the stream. virtual int sync() { @@ -196,6 +216,9 @@ protected: + /*! \brief Return the next character in the stream. + ** On failure, \a EOF is returned. + */ virtual int underflow() { @@ -218,6 +241,10 @@ return (unsigned char) *gptr(); } + /*! \brief Flush the output buffer associated to the stream + ** then write \a c. On failure, \a EOF is returned. + */ + virtual int overflow(int c = EOF) { @@ -247,6 +274,7 @@ char *outbuf; static const int lenbuf = 16 * 1024; + /// Flush the output buffer int flushbuf() { @@ -261,7 +289,7 @@ setp(outbuf, outbuf + lenbuf); return 0; } - + /// Fill the input buffer. int fillbuf() { @@ -273,6 +301,11 @@ }; + /*! \class zfilestream_common + ** + ** Define an interface for compressed file stream manipulation. + */ + class zfilestream_common : virtual public std::ios { friend class zifstream; @@ -283,6 +316,9 @@ public: virtual ~zfilestream_common() {} + /*! \brief Open the stream on the file descriptor: + ** \a fd regarding the opening mode. + */ void attach(int fd, int io_mode) { @@ -292,6 +328,9 @@ clear(); } + /*! \brief Open the stream on the file named \a name + ** regarding the opening mode. + */ void open(const char *name, int io_mode) { @@ -301,6 +340,7 @@ clear(); } + /// Close the current stream. void close() { @@ -309,6 +349,7 @@ } protected: + /// Prevent instantiation. zfilestream_common() : std::ios(zfilestream_common::rdbuf()) { } @@ -323,6 +364,11 @@ zfilebuf buffer; }; + + /*! \class zifstream + ** + ** Read only zstream. + */ class zifstream : public zfilestream_common, public std::istream { public: @@ -332,12 +378,14 @@ clear(std::ios::badbit); } + /// Open a read only stream on the file named \a name. zifstream(const char *name, int io_mode = std::ios::in) : std::istream(zfilestream_common::rdbuf()) { zfilestream_common::open(name, io_mode); } + /// Open a read only stream on the file descriptor \a fd. zifstream(int fd, int io_mode = std::ios::in) : std::istream(zfilestream_common::rdbuf()) { @@ -356,12 +404,14 @@ clear(std::ios::badbit); } + /// Open a write only stream on the file named \a name. zofstream(const char *name, int io_mode = std::ios::out) : std::ostream(zfilestream_common::rdbuf()) { zfilestream_common::open(name, io_mode); } + /// Open a write only stream on the file descriptor \a fd. zofstream(int fd, int io_mode = std::ios::out) : std::ostream(zfilestream_common::rdbuf()) { @@ -376,12 +426,18 @@ template <class T> class zomanip; + /// Apply a function on \a s via the operator <<. template <class T> zofstream& operator<<(zofstream &s, const zomanip<T> &m) { return (*m.func)(s, m.val); } + + /*! \class zomanip + ** + ** Define a pair func / val to perform manipulation on zofstream. + */ template<class T> class zomanip { friend zofstream &operator<< <T>(zofstream &, const zomanip<T> &); @@ -392,12 +448,15 @@ T val; }; + + /// Set the compression level of \a s to \a l. inline zofstream& setcompressionlevel(zofstream &s, int l) { (s.rdbuf())->setcompressionlevel(l); return s; } + /// Set the compression strategy of \a s to \a l. inline zofstream& setcompressionstrategy(zofstream &s, int l) { @@ -405,12 +464,14 @@ return s; } + /// Specialized version for zomanip<int> inline zomanip<int> setcompressionlevel(int l) { return zomanip<int>(&setcompressionlevel,l); } + /// Specialized version for zomanip<int> inline zomanip<int> setcompressionstrategy(int l) { Index: olena/oln/io/pnm_read_3d.hh --- olena/oln/io/pnm_read_3d.hh Thu, 07 Aug 2003 02:37:23 +0200 burrus_n (oln/b/11_pnm_read3d 1.13 600) +++ olena/oln/io/pnm_read_3d.hh Mon, 15 Mar 2004 19:02:17 +0100 thivol_d (oln/b/11_pnm_read3d 1.13 600) @@ -1,4 +1,4 @@ -// Copyright (C) 2001, 2002, 2003 EPITA Research and Development Laboratory +// Copyright (C) 2001, 2002, 2003, 2004 EPITA Research and Development Laboratory // // This file is part of the Olena Library. This library is free // software; you can redistribute it and/or modify it under the terms @@ -47,9 +47,13 @@ | pnm_reader3d (Any) | `-------------------*/ - // Only PnmRaw images can store more than one 2d image. The - // format is simple: each slice is stored as a bi-dimensional - // image. + /*! \class pnm_reader<ReadPnmRaw, 3, P, I> + ** + ** Specialized version for 3d image. + ** Only PnmRaw images can store more than one 2d image. The + ** format is simple: each slice is stored as a bi-dimensional + ** image. + */ template <pnm_type P, class I> struct pnm_reader<ReadPnmRaw, 3, P, I> @@ -70,6 +74,11 @@ return reader_2d::knows_ext(ext); } + + /*! \brief Initialize \a im and return true if \a in + ** is a valid pnm file format, return false otherwise. + */ + static bool read(std::istream& in, I& im) { @@ -114,6 +123,8 @@ } private: + + /// Function used in \a read method. static void to_image3d_(std::list<image2d_type*>& image2d_list, I& output) { Index: olena/oln/io/pnm_read.hh --- olena/oln/io/pnm_read.hh Thu, 07 Aug 2003 02:37:23 +0200 burrus_n (oln/b/16_pnm_read.h 1.9.1.10 600) +++ olena/oln/io/pnm_read.hh Mon, 15 Mar 2004 11:58:34 +0100 thivol_d (oln/b/16_pnm_read.h 1.9.1.10 600) @@ -1,4 +1,4 @@ -// Copyright (C) 2001, 2002, 2003 EPITA Research and Development Laboratory +// Copyright (C) 2001, 2002, 2003, 2004 EPITA Research and Development Laboratory // // This file is part of the Olena Library. This library is free // software; you can redistribute it and/or modify it under the terms @@ -46,6 +46,11 @@ | default pnm_reader | `-------------------*/ + /*! \class pnm_reader + ** + ** Default version. + */ + template <reader_id R, unsigned Dim, pnm_type V, class I> struct pnm_reader { @@ -72,11 +77,21 @@ | reader for pnm | `---------------*/ + /*! \class image_reader<ReadPnmPlain, I> + ** + ** Specialized version for ReadPnmPlain + */ + template <class I> struct image_reader<ReadPnmPlain, I> : public pnm_reader<ReadPnmPlain, I::dim, get_pnm_type<I>::ret, I> {}; + /*! \class image_reader<ReadPnmRaw, I> + ** + ** Specialized version for ReadPnmRaw + */ + template <class I> struct image_reader<ReadPnmRaw, I> : public pnm_reader<ReadPnmRaw, I::dim, get_pnm_type<I>::ret, I> Index: olena/oln/io/pnm_write_3d.hh --- olena/oln/io/pnm_write_3d.hh Thu, 07 Aug 2003 02:37:23 +0200 burrus_n (oln/b/9_pnm_write3 1.1.1.13 600) +++ olena/oln/io/pnm_write_3d.hh Mon, 15 Mar 2004 13:45:26 +0100 thivol_d (oln/b/9_pnm_write3 1.1.1.13 600) @@ -1,4 +1,4 @@ -// Copyright (C) 2001, 2002, 2003 EPITA Research and Development Laboratory +// Copyright (C) 2001, 2002, 2003, 2004 EPITA Research and Development Laboratory // // This file is part of the Olena Library. This library is free // software; you can redistribute it and/or modify it under the terms @@ -46,9 +46,13 @@ | pnm_writer3d (Any) | `-------------------*/ - // Only PnmRaw images can store more than one 2d image. The - // format is simple: each slice is stored as a bi-dimensional - // image. + /*! \class pnm_writer<WritePnmRaw, 3, P, I> + ** + ** Specialized version for image 3d. + ** Only PnmRaw images can store more than one 2d image. The + ** format is simple: each slice is stored as a bi-dimensional + ** image. + */ template <pnm_type P, class I> struct pnm_writer<WritePnmRaw, 3, P, I> @@ -69,6 +73,8 @@ return writer_2d::knows_ext(ext); } + /// Write \a im on \a out, then return true. + static bool write(std::ostream& out, const I& im) { Index: olena/oln/io/pnm_write.hh --- olena/oln/io/pnm_write.hh Thu, 07 Aug 2003 02:37:23 +0200 burrus_n (oln/b/15_pnm_write. 1.8.1.13 600) +++ olena/oln/io/pnm_write.hh Mon, 15 Mar 2004 13:34:40 +0100 thivol_d (oln/b/15_pnm_write. 1.8.1.13 600) @@ -1,4 +1,4 @@ -// Copyright (C) 2001, 2002, 2003 EPITA Research and Development Laboratory +// Copyright (C) 2001, 2002, 2003, 2004 EPITA Research and Development Laboratory // // This file is part of the Olena Library. This library is free // software; you can redistribute it and/or modify it under the terms @@ -41,6 +41,11 @@ | default pnm_writer | `-------------------*/ + /*! \class pnm_write + ** + ** Default version. + */ + template <writer_id W, unsigned Dim, pnm_type V, class I> struct pnm_writer { Index: olena/oln/io/pnm_common.hh --- olena/oln/io/pnm_common.hh Thu, 07 Aug 2003 02:37:23 +0200 burrus_n (oln/t/40_pnm_common 1.4 600) +++ olena/oln/io/pnm_common.hh Mon, 15 Mar 2004 19:00:49 +0100 thivol_d (oln/t/40_pnm_common 1.4 600) @@ -1,4 +1,4 @@ -// Copyright (C) 2001, 2002, 2003 EPITA Research and Development Laboratory +// Copyright (C) 2001, 2002, 2003, 2004 EPITA Research and Development Laboratory // // This file is part of the Olena Library. This library is free // software; you can redistribute it and/or modify it under the terms @@ -66,6 +66,14 @@ // Return the pnm type associated to an image type // FIXME: this could be done by using labels images // eg: read(binary_image_with_dim<2>& ima) { // ... } + + /*! \class get_pnm_type + ** + ** A metaswitch that return the pnm type associated to an image type. + ** + ** \todo FIXME: this could be done by using labels images + ** eg: read(binary_image_with_dim<2>& ima) { // ... } + */ template <class I> struct get_pnm_type { Index: olena/oln/io/stream_wrapper.hh --- olena/oln/io/stream_wrapper.hh Mon, 15 Mar 2004 19:40:09 +0100 odou_s (oln/t/43_stream_wra 1.3.1.2 600) +++ olena/oln/io/stream_wrapper.hh Mon, 15 Mar 2004 19:48:41 +0100 thivol_d (oln/t/43_stream_wra 1.3.1.2 600) @@ -52,6 +52,16 @@ StreamGz = 2, StreamAny = 2 }; + /*! \class stream_wrapper + ** + ** Default version, if you instantiate one, all the + ** operations on the stream will fail + ** + ** \see stream_wrapper<StreamFile> + ** + ** \see stream_wrapper<StreamGz> + ** + */ template< stream_id W > struct stream_wrapper { Index: olena/oln/io/pnm_read_data.hh --- olena/oln/io/pnm_read_data.hh Thu, 07 Aug 2003 02:37:23 +0200 burrus_n (oln/u/9_pnm_read_d 1.5 600) +++ olena/oln/io/pnm_read_data.hh Mon, 15 Mar 2004 13:34:05 +0100 thivol_d (oln/u/9_pnm_read_d 1.5 600) @@ -1,4 +1,4 @@ -// Copyright (C) 2001, 2002, 2003 EPITA Research and Development Laboratory +// Copyright (C) 2001, 2002, 2003, 2004 EPITA Research and Development Laboratory // // This file is part of the Olena Library. This library is free // software; you can redistribute it and/or modify it under the terms @@ -40,6 +40,12 @@ namespace internal { + + /*! \class pnm_read_data + ** + ** Default version. + */ + template<pnm_type V, reader_id R> struct pnm_read_data { @@ -55,6 +61,14 @@ | pnm read data binary | `---------------------*/ + /*! \class pnm_read_data<PnmBinary, ReadPnmPlain> + ** + ** Specialized version for extracting pnm binary 2d image + ** in plain file. + ** + ** \todo FIXME: implement an iterator over data + */ + template <> struct pnm_read_data<PnmBinary, ReadPnmPlain> { @@ -79,6 +93,12 @@ } }; + /*! \class pnm_read_data<PnmBinary, ReadPnmRaw> + ** + ** Specialized version for extracting pnm binary 2d image + ** in raw file. + */ + template <> struct pnm_read_data<PnmBinary, ReadPnmRaw> { @@ -112,6 +132,15 @@ | pnm read data integer | `----------------------*/ + /*! \class pnm_read_data<PnmInteger, ReadPnmPlain> + ** + ** Specialized version for extracting pnm integer 2d image + ** in plain file. + ** + ** \todo FIXME: implement an iterator over data + */ + + template <> struct pnm_read_data<PnmInteger, ReadPnmPlain> { @@ -132,6 +161,15 @@ } }; + + /*! \class pnm_read_data<PnmInteger, ReadPnmRaw> + ** + ** Specialized version for extracting pnm integer 2d image + ** in raw file. + ** + ** \todo FIXME: implement an iterator over data + */ + template <> struct pnm_read_data<PnmInteger, ReadPnmRaw> { @@ -165,6 +203,15 @@ | pnm read data vectorial | `------------------------*/ + + /*! \class pnm_read_data<PnmVectorial, ReadPnmPlain> + ** + ** Specialized version for extracting pnm vectorial 2d image + ** in plain file. + ** + ** \todo FIXME: implement an iterator over data + */ + template <> struct pnm_read_data<PnmVectorial, ReadPnmPlain> { @@ -186,6 +233,15 @@ } }; + + /*! \class pnm_read_data<PnmInteger, ReadPnmRaw> + ** + ** Specialized version for extracting pnm integer 2d image + ** in raw file. + ** + ** \todo FIXME: implement an iterator over data + */ + template <> struct pnm_read_data<PnmVectorial, ReadPnmRaw> { Index: olena/oln/io/pnm_write_data.hh --- olena/oln/io/pnm_write_data.hh Thu, 07 Aug 2003 02:37:23 +0200 burrus_n (oln/u/10_pnm_write_ 1.6 600) +++ olena/oln/io/pnm_write_data.hh Mon, 15 Mar 2004 13:49:03 +0100 thivol_d (oln/u/10_pnm_write_ 1.6 600) @@ -1,4 +1,4 @@ -// Copyright (C) 2001, 2002, 2003 EPITA Research and Development Laboratory +// Copyright (C) 2001, 2002, 2003, 2004 EPITA Research and Development Laboratory // // This file is part of the Olena Library. This library is free // software; you can redistribute it and/or modify it under the terms @@ -40,6 +40,12 @@ namespace internal { + + /*! \class pnm_write_data + ** + ** Default version + */ + template<pnm_type V, writer_id R> struct pnm_write_data { @@ -55,6 +61,15 @@ | pnm write data binary | `----------------------*/ + + /*! \class pnm_write_data<PnmBinary, WritePnmPlain> + ** + ** Specialized version for writing pnm binary 3d image + ** in plain file. + ** + ** \todo FIXME: implement an iterator over data + */ + template <> struct pnm_write_data<PnmBinary, WritePnmPlain> { @@ -82,6 +97,14 @@ } }; + /*! \class pnm_write_data<PnmBinary, WritePnmRaw> + ** + ** Specialized version for writing pnm binary 3d image + ** in raw file. + ** + ** \todo FIXME: implement an iterator over data + */ + template <> struct pnm_write_data<PnmBinary, WritePnmRaw> { @@ -121,6 +144,14 @@ | pnm write data integer | `-----------------------*/ + /*! \class pnm_write_data<PnmInteger, WritePnmPlain> + ** + ** Specialized version for writing pnm integer 3d image + ** in plain file. + ** + ** \todo FIXME: implement an iterator over data + */ + template <> struct pnm_write_data<PnmInteger, WritePnmPlain> { @@ -148,6 +179,14 @@ } }; + /*! \class pnm_write_data<PnmInteger, WritePnmRaw> + ** + ** Specialized version for writing pnm integer 3d image + ** in raw file. + ** + ** \todo FIXME: implement an iterator over data + */ + template <> struct pnm_write_data<PnmInteger, WritePnmRaw> { @@ -179,6 +218,14 @@ | pnm write data vectorial | `-------------------------*/ + /*! \class pnm_write_data<PnmVectorial, WritePnmPlain> + ** + ** Specialized version for writing pnm vectorial 3d image + ** in plain file. + ** + ** \todo FIXME: implement an iterator over data + */ + template <> struct pnm_write_data<PnmVectorial, WritePnmPlain> { @@ -209,6 +256,14 @@ } }; + /*! \class pnm_write_data<PnmVectorial, WritePnmRaw> + ** + ** Specialized version for writing pnm vectorial 3d image + ** in raw file. + ** + ** \todo FIXME: implement an iterator over data + */ + template <> struct pnm_write_data<PnmVectorial, WritePnmRaw> { Index: olena/oln/io/pnm_read_2d.hh --- olena/oln/io/pnm_read_2d.hh Thu, 07 Aug 2003 02:37:23 +0200 burrus_n (oln/u/43_pnm_read_2 1.4 600) +++ olena/oln/io/pnm_read_2d.hh Mon, 15 Mar 2004 13:35:15 +0100 thivol_d (oln/u/43_pnm_read_2 1.4 600) @@ -1,4 +1,4 @@ -// Copyright (C) 2001, 2002, 2003 EPITA Research and Development Laboratory +// Copyright (C) 2001, 2002, 2003, 2004 EPITA Research and Development Laboratory // // This file is part of the Olena Library. This library is free // software; you can redistribute it and/or modify it under the terms @@ -43,6 +43,12 @@ | pnm_read_header2d | `------------------*/ + /*! \brief Return true if the headers from \a s are valid, + ** false otherwise. + ** + ** \todo FIXME: should be in a .cc file ? + */ + // FIXME: should be in a .cc file ? static bool pnm_read_header2d(std::istream& s, char type, pnm2d_info& info) @@ -80,6 +86,12 @@ | pnm_reader (Binary) | `--------------------*/ + + /*! \class pnm_reader<R, 2, PnmBinary, I> + ** + ** Specialized version for PnmBinary (pbm image format). + */ + template <reader_id R, class I> struct pnm_reader<R, 2, PnmBinary, I> { @@ -100,6 +112,10 @@ return ext == "pbm"; } + /*! \brief Initialize im and return true if the headers from \a in are valid, + ** return false otherwise. + */ + static bool read(std::istream& in, I& im) { @@ -118,6 +134,11 @@ | pnm_reader (Integer) | `---------------------*/ + /*! \class pnm_reader<R, 2, PnmInteger, I> + ** + ** Specialized version for PnmInteger (pgm image format). + */ + template <reader_id R, class I> struct pnm_reader<R, 2, PnmInteger, I> { @@ -138,6 +159,11 @@ return ext == "pgm"; } + /*! \brief Initialize \a im and return true if \a in is a valid pgm file stream, + ** return false otherwise. + */ + + static bool read(std::istream& in, I& im) { @@ -161,6 +187,11 @@ | pnm_reader (Vectorial) | `-----------------------*/ + /*! \brief class pnm_reader<R, 2, PnmVectorial, I> + ** + ** Specialized version for pnm_reader<R, 2, PnmVectorial, I> (ppm image format). + */ + template <reader_id R, class I> struct pnm_reader<R, 2, PnmVectorial, I> { @@ -181,6 +212,10 @@ return ext == "ppm"; } + /*! \brief Initialize \a im and return true if \a in is a valid ppm file stream, + ** return false otherwise. + */ + static bool read(std::istream& in, I& im) { Index: olena/oln/io/pnm_write_2d.hh --- olena/oln/io/pnm_write_2d.hh Mon, 03 Nov 2003 21:57:43 +0100 burrus_n (oln/u/44_pnm_write_ 1.5 600) +++ olena/oln/io/pnm_write_2d.hh Mon, 15 Mar 2004 13:43:51 +0100 thivol_d (oln/u/44_pnm_write_ 1.5 600) @@ -1,4 +1,4 @@ -// Copyright (C) 2001, 2002, 2003 EPITA Research and Development Laboratory +// Copyright (C) 2001, 2002, 2003, 2004 EPITA Research and Development Laboratory // // This file is part of the Olena Library. This library is free // software; you can redistribute it and/or modify it under the terms @@ -45,6 +45,11 @@ | pnm_write_header2d | `------------------*/ + /*! \brief Write headers in \a s output file, then return true. + ** + ** \todo FIXME: should be in a .cc file ? + */ + // FIXME: should be in a .cc file ? static bool pnm_write_header2d(std::ostream& s, char type, const pnm2d_info& info) @@ -62,6 +67,11 @@ | pnm_writer (Binary) | `--------------------*/ + /*! \class pnm_writer<W, 2, PnmBinary, I> + ** + ** Specialized version for pbm images. + */ + template <writer_id W, class I> struct pnm_writer<W, 2, PnmBinary, I> { @@ -82,6 +92,10 @@ return ext == "pbm"; } + /*! \brief write \a im on \a out according to the pbm format, + ** then return true. + */ + static bool write(std::ostream& out, const I& im) { @@ -103,6 +117,11 @@ | pnm_writer (Integer) | `---------------------*/ + /*! \class pnm_writer<W, 2, PnmInteger, I> + ** + ** Specialized version for pgm images. + */ + template <writer_id W, class I> struct pnm_writer<W, 2, PnmInteger, I> { @@ -123,6 +142,10 @@ return ext == "pgm"; } + /*! \brief Write \a im on \a out according to the pgm format, + ** then return true. + */ + static bool write(std::ostream& out, const I& im) { @@ -147,6 +170,11 @@ | pnm_writer (Vectorial) | `-----------------------*/ + /*! \class pnm_writer<W, 2, PnmVectorial, I> + ** + ** Specialized version for ppm images. + */ + template <writer_id W, class I> struct pnm_writer<W, 2, PnmVectorial, I> { @@ -167,6 +195,10 @@ return ext == "ppm"; } + /*! \brief Write \a im on \a out according to the ppm format, + ** then return true. + */ + static bool write(std::ostream& out, const I& im) { -- Damien Thivolle damien.thivolle(a)lrde.epita.fr

1 0

oln 10.90: Tests.
by Giovanni Palma 15 Mar '04

15 Mar '04

Index: olena/ChangeLog from Giovanni Palma <giovanni(a)lrde.epita.fr> * tests/morpho/tests/attribute: Correct function name problems. * tests/morpho/tests/area: Likewise. Index: olena/tests/morpho/tests/area --- olena/tests/morpho/tests/area Fri, 06 Feb 2004 15:26:24 +0100 van-vl_n (oln/j/44_area 1.1 644) +++ olena/tests/morpho/tests/area Mon, 15 Mar 2004 16:59:27 +0100 palma_g (oln/j/44_area 1.1 644) @@ -41,7 +41,7 @@ im(10) = 0; image1d<int_u8> im2 = - morpho::tarjan::area_opening(im, neighb_c2(), 2); + morpho::fast::card_opening(im, neighb_c2(), 2); fail = fail || im2(0) != 0 || @@ -57,7 +57,7 @@ im2(10)!= 0; image1d<int_u8> im3 = - morpho::tarjan::area_opening(im, neighb_c2(), 3); + morpho::fast::card_opening(im, neighb_c2(), 3); fail = fail || im3(0) != 0 || im3(1) != 0 || @@ -72,7 +72,7 @@ im3(10)!= 0; image1d<int_u8> im4 = - morpho::tarjan::area_opening(im, neighb_c2(), 4); + morpho::fast::card_opening(im, neighb_c2(), 4); fail = fail || im4(0) != 0 || im4(1) != 0 || @@ -111,7 +111,7 @@ im(10) = -4; image1d<int_s<3> > im2 = - morpho::tarjan::area_opening(im, neighb_c2(), 2); + morpho::fast::card_opening(im, neighb_c2(), 2); fail = fail || im2(0) != -4 || @@ -127,7 +127,7 @@ im2(10)!= -4; image1d<int_s<3> > im3 = - morpho::tarjan::area_opening(im, neighb_c2(), 3); + morpho::fast::card_opening(im, neighb_c2(), 3); fail = fail || im3(0) != -4 || im3(1) != -4 || @@ -142,7 +142,7 @@ im3(10)!= -4; image1d<int_s<3> > im4 = - morpho::tarjan::area_opening(im, neighb_c2(), 4); + morpho::fast::card_opening(im, neighb_c2(), 4); fail = fail || im4(0) != -4 || im4(1) != -4 || @@ -165,7 +165,7 @@ bool fail(false); image2d<int_u8> lena = load(rdata("lena.pgm")); - image2d<int_u8> lena5 = morpho::tarjan::area_closing(lena, neighb_c8(), 100); + image2d<int_u8> lena5 = morpho::fast::card_closing(lena, neighb_c8(), 100); unsigned l = 0; image2d<int_u8>::iter_type it_l(lena5); Index: olena/tests/morpho/tests/attribute --- olena/tests/morpho/tests/attribute Wed, 10 Mar 2004 16:20:23 +0100 palma_g (oln/j/51_attribute 1.3 644) +++ olena/tests/morpho/tests/attribute Mon, 15 Mar 2004 17:04:59 +0100 palma_g (oln/j/51_attribute 1.3 644) @@ -28,7 +28,7 @@ bool fail(false); typedef image2d<int_u8> img_type; - typedef oln::morpho::cart_type<unsigned> area_type; + typedef oln::morpho::card_type<unsigned> area_type; const area_type::lambda_type area = 100; const neighborhood2d nb = neighb_c8(); // const oln::morpho::NullEnv env; -- Giovanni Palma EPITA - promo 2005 - membre d'EpX - LRDE Mob. : +33 (0)6 60 97 31 74

1 0