Commit 16f95739 authored by Thierry Geraud's avatar Thierry Geraud
Browse files

Fix doc.

	* tests/t_image.cc,
	* tests/local_convolve.cc,
	* tests/mean.cc,
	* tests/pw_image.cc,
	* tests/linear_lap.cc,
	* doc/Doxyfile.in,
	* mln/fun/v2v/id.hh,
	* mln/core/sparse_encode.hh,
	* mln/core/internal/dpoints_base.hh,
	* mln/core/rle_encode.hh,
	* mln/make/w_window.hh: Fix doc.
	* mln/linear/hconvolve.hh: Remove; obsolete.


git-svn-id: https://svn.lrde.epita.fr/svn/oln/trunk@1066 4aad255d-cdde-0310-9447-f3009e2ae8c0
parent da24c7e3
2007-09-03 Thierry Geraud <thierry.geraud@lrde.epita.fr>
Fix doc.
* tests/t_image.cc,
* tests/local_convolve.cc,
* tests/mean.cc,
* tests/pw_image.cc,
* tests/linear_lap.cc,
* doc/Doxyfile.in,
* mln/fun/v2v/id.hh,
* mln/core/sparse_encode.hh,
* mln/core/internal/dpoints_base.hh,
* mln/core/rle_encode.hh,
* mln/make/w_window.hh: Fix doc.
* mln/linear/hconvolve.hh: Remove; obsolete.
2007-09-03 Thierry Geraud <thierry.geraud@lrde.epita.fr>
Fix missing file.
......
......@@ -1041,29 +1041,31 @@ INCLUDE_FILE_PATTERNS =
# undefined via #undef or recursively expanded use the := operator
# instead of the = operator.
PREDEFINED = \
"mln_piter(T)=typename T::piter" \
"mln_fwd_piter(T)=typename T::fwd_piter" \
"mln_bkd_piter(T)=typename T::bkd_piter" \
"mln_qiter(T)=typename T::qiter" \
"mln_fwd_qiter(T)=typename T::fwd_qiter" \
"mln_bkd_qiter(T)=typename T::bkd_qiter" \
"mln_niter(T)=typename T::niter" \
"mln_fwd_niter(T)=typename T::fwd_niter" \
"mln_bkd_niter(T)=typename T::bkd_niter" \
"mln_viter(T)=typename T::viter" \
"mln_fwd_viter(T)=typename T::fwd_viter" \
"mln_bkd_viter(T)=typename T::bkd_viter" \
"mln_result(T)=typename T::result" \
"mln_enc(T)=typename T::enc" \
"mln_value(T)=typename T::value" \
"mln_qlf_value(T)=typename T::qlf_value" \
"mln_pset(T)=typename T::pset" \
"mln_vset(T)=typename T::vset" \
"mln_rvalue(T)=typename T::rvalue" \
"mln_lvalue(T)=typename T::lvalue" \
"mln_coord(T)=typename T::coord" \
"mln_point(T)=typename T::point" \
PREDEFINED = \
"mlc_unqualif(T)=typename mln::metal::unqualif<T>::ret" \
"mln_piter(T)=typename T::piter" \
"mln_fwd_piter(T)=typename T::fwd_piter" \
"mln_bkd_piter(T)=typename T::bkd_piter" \
"mln_qiter(T)=typename T::qiter" \
"mln_fwd_qiter(T)=typename T::fwd_qiter" \
"mln_bkd_qiter(T)=typename T::bkd_qiter" \
"mln_niter(T)=typename T::niter" \
"mln_fwd_niter(T)=typename T::fwd_niter" \
"mln_bkd_niter(T)=typename T::bkd_niter" \
"mln_viter(T)=typename T::viter" \
"mln_fwd_viter(T)=typename T::fwd_viter" \
"mln_bkd_viter(T)=typename T::bkd_viter" \
"mln_result(T)=typename T::result" \
"mln_enc(T)=typename T::enc" \
"mln_value(T)=typename T::value" \
"mln_qlf_value(T)=typename T::qlf_value" \
"mln_pset(T)=typename T::pset" \
"mln_sum(T)=typename mln::value::props<T>::sum" \
"mln_vset(T)=typename T::vset" \
"mln_rvalue(T)=typename T::rvalue" \
"mln_lvalue(T)=typename T::lvalue" \
"mln_coord(T)=typename T::coord" \
"mln_point(T)=typename T::point" \
"mln_dpoint(T)=typename T::dpoint"
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES
......
......@@ -28,7 +28,7 @@
#ifndef MLN_CORE_INTERNAL_DPOINTS_BASE_HH
# define MLN_CORE_INTERNAL_DPOINTS_BASE_HH
/*! \file mln/core/internal/dpoints_base_.hh
/*! \file mln/core/internal/dpoints_base.hh
*
* \brief Definition of a base class for classes based on a set of dpoints.
*/
......
......@@ -28,7 +28,7 @@
#ifndef MLN_CORE_RLE_ENCODE_HH
# define MLN_CORE_RLE_ENCODE_HH
/*! \file mln/core/sparse_image.hh
/*! \file mln/core/rle_encode.hh
*
* \brief FIXME
*/
......
......@@ -28,7 +28,7 @@
#ifndef MLN_CORE_SPARSE_ENCODE_HH
# define MLN_CORE_SPARSE_ENCODE_HH
/*! \file mln/core/sparse_image.hh
/*! \file mln/core/sparse_encode.hh
*
* \brief FIXME
*/
......
......@@ -28,9 +28,9 @@
#ifndef MLN_FUN_V2V_ID_HH
# define MLN_FUN_V2V_ID_HH
/*! \file mln/fun/id.hh
/*! \file mln/fun/v2v/id.hh
*
* \brief FIXME.
* \brief Identity function.
*/
# include <mln/fun/internal/selector.hh>
......
// Copyright (C) 2007 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
// of the GNU General Public License version 2 as published by the
// Free Software Foundation.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this library; see the file COPYING. If not, write to
// the Free Software Foundation, 51 Franklin Street, Fifth Floor,
// Boston, MA 02111-1307, USA.
//
// As a special exception, you may use this file as part of a free
// software library without restriction. Specifically, if other files
// instantiate templates or use macros or inline functions from this
// file, or you compile this file and link it with other files to
// produce an executable, this file does not by itself cause the
// resulting executable to be covered by the GNU General Public
// License. This exception does not however invalidate any other
// reasons why the executable file might be covered by the GNU General
// Public License.
#ifndef MLN_LINEAR_LINE_CONVOLVE_HH
# define MLN_LINEAR_LINE_CONVOLVE_HH
/*! \file mln/linear/line_convolve.hh
*
* \brief Convolution by an horizontal kernel.
*/
# include <vector>
# include <mln/linear/convolve.hh>
# include <mln/make/w_window_line.hh>
# include <mln/core/t_image.hh>
namespace mln
{
namespace linear
{
/*! Convolution of an image \p input by an horizontal weighted
* window defined by the array of \p weights.
*
* \warning Computation of \p output(p) is performed with the
* value type of \p output.
*
* \warning The weighted window is used as-is, considering that
* its symmetrization is handled by the client.
*
* \pre output.domain = input.domain
*/
template <typename I, typename W, unsigned N, typename O>
void line_convolve(const Image<I>& input, const W (&weights)[N],
Image<O>& output);
// FIXME: Doc!
template <typename I, typename W, unsigned Nr, unsigned Nc, typename O>
void line_convolve(const Image<I>& input,
const W (&row_weights)[Nr], const W (&col_weights)[Nc],
Image<O>& output);
# ifndef MLN_INCLUDE_ONLY
template <typename I, typename W, unsigned N, typename O>
void line_convolve(const Image<I>& input, const W (&weights)[N],
Image<O>& output)
{
mln_precondition(exact(output).domain() == exact(input).domain());
linear::convolve(input,
make::w_window_line<mln_dpoint(I)>(weights),
output);
}
template <typename I, typename W, unsigned Nr, unsigned Nc, typename O>
void line_convolve(const Image<I>& input,
const W (&row_weights)[Nr], const W (&col_weights)[Nc],
Image<O>& output)
{
// FIXME: Check 2D.
mln_precondition(exact(output).domain() == exact(input).domain());
O tmp(exact(output).domain());
linear::convolve(input,
make::w_window_line<mln_dpoint(I)>(row_weights),
tmp);
t_image<O> swap_output = swap_coords(output, 0, 1);
linear::convolve(swap_coords(tmp, 0, 1),
make::w_window_line<mln_dpoint(I)>(col_weights),
swap_output);
}
# endif // ! MLN_INCLUDE_ONLY
} // end of namespace mln::linear
} // end of namespace mln
#endif // ! MLN_LINEAR_LINE_CONVOLVE_HH
......@@ -47,9 +47,8 @@ namespace mln
/*! \brief Create a mln::w_window from a window and a weight
* function.
*
* \param[in] weights Array.
*
* \pre The array size, \c M, has to be a square of an odd integer.
* \param[in] win The window.
* \param[in] wei A weight function.
*
* \return A weighted window.
*/
......
......@@ -25,7 +25,7 @@
// reasons why the executable file might be covered by the GNU General
// Public License.
/*! \file tests/linear_lAP.cc
/*! \file tests/linear_lap.cc
*
* \brief Tests on mln::linear::lap_4.
*/
......
......@@ -25,9 +25,9 @@
// reasons why the executable file might be covered by the GNU General
// Public License.
/*! \file tests/convolve.cc
/*! \file tests/local_convolve.cc
*
* \brief Tests on mln::linear::convolve.
* \brief Tests on mln::linear::local::convolve.
*/
#include <mln/core/image2d_b.hh>
......
......@@ -25,9 +25,9 @@
// reasons why the executable file might be covered by the GNU General
// Public License.
/*! \file tests/assign.cc
/*! \file tests/mean.cc
*
* \brief Tests on mln::level::assign.
* \brief Tests on mln::estim::mean.
*/
#include <mln/core/image2d_b.hh>
......
......@@ -25,9 +25,9 @@
// reasons why the executable file might be covered by the GNU General
// Public License.
/*! \file tests/fimage.cc
/*! \file tests/pw_image.cc
*
* \brief Tests on mln::fimage.
* \brief Tests on mln::pw::image.
*/
#include <mln/fun/p2b/chess.hh>
......
......@@ -25,7 +25,7 @@
// reasons why the executable file might be covered by the GNU General
// Public License.
/*! \file tests/+t_image.cc
/*! \file tests/t_image.cc
*
* \brief Tests on mln::t_image.
*/
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment