Commit 67e27c14 authored by Guillaume Lazzara's avatar Guillaume Lazzara
Browse files

Fix documentation.

	* doc/Doxyfile.in: add macro definitions.

	* doc/outputs/outputs.mk: update output reference files list.

	* headers.mk: update distributed files list.

	* apps/statues/trimesh/misc.hh,
	* doc/examples/tuto3/first_routine.cc,
	* mln/accu/compute.hh,
	* mln/accu/line.hh,
	* mln/core/image/graph_elt_window_if.hh,
	* mln/data/fill_with_image.hh,
	* mln/data/paste.hh,
	* mln/fun/x2x/composed.hh,
	* mln/geom/pmin_pmax.hh,
	* mln/geom/seeds2tiling.hh,
	* mln/io/dump/save.hh,
	* mln/io/txt/save.hh,
	* mln/labeling/compute.hh,
	* mln/labeling/pack.hh,
	* mln/labeling/relabel.hh,
	* mln/util/internal/id2element.hh,
	* mln/world/inter_pixel/dim2/is_dot.hh,
	* mln/world/inter_pixel/dim2/is_edge.hh,
	* mln/world/inter_pixel/dim2/is_pixel.hh,
	* mln/world/inter_pixel/dim2/is_row_odd.hh,
	* mln/world/inter_pixel/full2image.hh,
	* tests/accu/site_set/rectangularity.cc,
	* tests/make/region_adjacency_graph.cc,
	* mln/level/median.hh,
	* mln/level/stretch.hh,
	* mln/level/transform.hh,
	* mln/level/transform_inplace.hh,
	* mln/level/update.hh,
	* mln/make/dummy_p_edges.hh,
	* mln/make/dummy_p_vertices.hh,
	* mln/make/edge_image.hh,
	* mln/make/rag_and_labeled_wsl.hh,
	* mln/make/region_adjacency_graph.hh,
	* mln/make/relabelfun.hh,
	* mln/morpho/closing/area_on_vertices.hh,
	* mln/registration/icp.hh,
	* tests/morpho/Rd.cc: Fix documentation issues/missing documentation.

git-svn-id: https://svn.lrde.epita.fr/svn/oln/trunk@3780 4aad255d-cdde-0310-9447-f3009e2ae8c0
parent f755bdbf
2009-05-11 Guillaume Lazzara <lazzara@lrde.epita.fr>
Fix documentation.
* doc/Doxyfile.in: add macro definitions.
* doc/outputs/outputs.mk: update output reference files list.
* headers.mk: update distributed files list.
* apps/statues/trimesh/misc.hh,
* doc/examples/tuto3/first_routine.cc,
* mln/accu/compute.hh,
* mln/accu/line.hh,
* mln/core/image/graph_elt_window_if.hh,
* mln/data/fill_with_image.hh,
* mln/data/paste.hh,
* mln/fun/x2x/composed.hh,
* mln/geom/pmin_pmax.hh,
* mln/geom/seeds2tiling.hh,
* mln/io/dump/save.hh,
* mln/io/txt/save.hh,
* mln/labeling/compute.hh,
* mln/labeling/pack.hh,
* mln/labeling/relabel.hh,
* mln/util/internal/id2element.hh,
* mln/world/inter_pixel/dim2/is_dot.hh,
* mln/world/inter_pixel/dim2/is_edge.hh,
* mln/world/inter_pixel/dim2/is_pixel.hh,
* mln/world/inter_pixel/dim2/is_row_odd.hh,
* mln/world/inter_pixel/full2image.hh,
* tests/accu/site_set/rectangularity.cc,
* tests/make/region_adjacency_graph.cc,
* mln/level/median.hh,
* mln/level/stretch.hh,
* mln/level/transform.hh,
* mln/level/transform_inplace.hh,
* mln/level/update.hh,
* mln/make/dummy_p_edges.hh,
* mln/make/dummy_p_vertices.hh,
* mln/make/edge_image.hh,
* mln/make/rag_and_labeled_wsl.hh,
* mln/make/region_adjacency_graph.hh,
* mln/make/relabelfun.hh,
* mln/morpho/closing/area_on_vertices.hh,
* mln/registration/icp.hh,
* tests/morpho/Rd.cc: Fix documentation issues/missing documentation.
2009-05-07 Thierry Geraud <thierry.geraud@lrde.epita.fr>
 
Fix missing updates about debug colorize.
// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE)
// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory
// (LRDE)
//
// This file is part of the Olena Library. This library is free
// software; you can redistribute it and/or modify it under the terms
......@@ -474,7 +475,7 @@ namespace mln
Jean Cousty. Artwork 3D Model Database Indexing and
Classification.
\param[in] ima The surface (triangle mesh) on which the
\param[in] mesh The surface (triangle mesh) on which the
curvature is to be computed. */
/* FIXME: We should restrict attached data to vertices in return
value. */
......
......@@ -215,7 +215,7 @@ PREDEFINED = "mlc_unqualif(T)=typename mln::metal::unqualif<T>::ret"
"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_domain(T)=typename T::domain_t" \
"mln_sum(T)=typename mln::value::props<T>::sum" \
"mln_vset(T)=typename T::vset" \
"mln_rvalue(T)=typename T::rvalue" \
......@@ -250,7 +250,7 @@ PREDEFINED = "mlc_unqualif(T)=typename mln::metal::unqualif<T>::ret"
"mln_enc_(T)=T::enc" \
"mln_value_(T)=T::value" \
"mln_qlf_value_(T)=T::qlf_value" \
"mln_pset_(T)=T::pset" \
"mln_domain_(T)=T::domain_t" \
"mln_sum_(T)=mln::value::props<T>::sum" \
"mln_vset_(T)=T::vset" \
"mln_rvalue_(T)=T::rvalue" \
......@@ -286,7 +286,12 @@ PREDEFINED = "mlc_unqualif(T)=typename mln::metal::unqualif<T>::ret"
"mln_gradient(I)=mln::value::stack_image< I::point::dim, mln::trait::ch_value< I, mln::value::props< typename I::value >::sum >::ret >" \
"mln_trait_value_sum_product(T, U)=typename mln::trait::value_< mln_trait_op_times(T,U) >::sum" \
"mln_sum_product(T, U)=typename mln::trait::value_< mln_trait_op_times(T,U) >::sum" \
"mln_deduce(T, A1, A2)=typename T::A1::A2"
"mln_deduce(T, A1, A2)=typename T::A1::A2" \
"mln_graph_element(T)=typename T::graph_element" \
"mln_graph_element_(T)=T::graph_element"
"mln_fun_vv2v(F, L, R)=mln::fun::vv2v::F< mln_value(L), mln_value(R) >" \
"mln_fun_vv2v_result(F, L, R)=typename mln_fun_vv2v(F, L, R)::result" \
"mln_ch_fun_vv2v(F, L, R)=typename mln::trait::ch_value< L, typename mln_fun_vv2v(F, L, R)::result >::ret"
......
/// \file doc/examples/first_routine.cc
/// \file doc/examples/tuto3/first_routine.cc
#include <mln/essential/2d.hh>
#include <tests/data.hh>
......
......@@ -21,6 +21,7 @@ outputs/box2d-bbox.txt \
outputs/graph-iter.txt \
outputs/graph-output-1.txt \
outputs/fill-call-1.txt \
outputs/site_set_create.txt \
outputs/ima2d-rot.txt \
outputs/paste-call-1.txt \
outputs/fun-p2v-1.txt \
......
......@@ -60,13 +60,15 @@ mln/literal/essential.hh \
mln/world/binary_2d/subsample.hh \
mln/world/binary_2d/projected_histo.hh \
mln/world/inter_pixel/neighb2d.hh \
mln/world/inter_pixel/full.hh \
mln/world/inter_pixel/image2full.hh \
mln/world/inter_pixel/display_edge.hh \
mln/world/inter_pixel/dim2/is_pixel.hh \
mln/world/inter_pixel/dim2/all.hh \
mln/world/inter_pixel/dim2/is_edge.hh \
mln/world/inter_pixel/dim2/make_edge_image.hh \
mln/world/inter_pixel/dim2/is_dot.hh \
mln/world/inter_pixel/dim2/is_row_odd.hh \
mln/world/inter_pixel/full2image.hh \
mln/registration/get_rtransf.hh \
mln/registration/internal/rms.hh \
mln/registration/get_rot.hh \
......@@ -106,6 +108,7 @@ mln/util/timer.hh \
mln/util/yes.hh \
mln/util/line_graph.hh \
mln/util/ord.hh \
mln/util/adjacency_matrix.hh \
mln/util/tree_fast_to_image.hh \
mln/util/tree.hh \
mln/util/couple.hh \
......@@ -302,10 +305,13 @@ mln/fun/x2x/translation.hh \
mln/fun/x2x/rotation.hh \
mln/fun/x2x/essential.hh \
mln/fun/component/red.hh \
mln/fun/component/comp_count.hh \
mln/fun/component/scomp.hh \
mln/fun/component/green.hh \
mln/fun/component/comp.hh \
mln/fun/component/blue.hh \
mln/fun/component/rgb.hh \
mln/fun/component/ithcomp.hh \
mln/fun/compose.hh \
mln/fun/meta/red.hh \
mln/fun/meta/hue.hh \
......@@ -476,6 +482,7 @@ mln/accu/image/init.hh \
mln/accu/image/to_result.hh \
mln/accu/image/all.hh \
mln/accu/image/set_value.hh \
mln/accu/image/untake.hh \
mln/accu/image/take.hh \
mln/accu/image/take_as_init.hh \
mln/accu/image/take_n_times.hh \
......@@ -566,7 +573,6 @@ mln/trait/ch_function_value.hh \
mln/trait/ch_value.hh \
mln/trait/solve.hh \
mln/trait/solve_unary.hh \
mln/trait/fun.hh \
mln/trait/op/postdec.hh \
mln/trait/op/mod.hh \
mln/trait/op/lor.hh \
......@@ -594,6 +600,7 @@ mln/trait/op/uplus.hh \
mln/trait/op/essential.hh \
mln/trait/op/eq.hh \
mln/trait/concrete.hh \
mln/trait/functions.hh \
mln/trait/windows.hh \
mln/trait/site_sets.hh \
mln/trait/image_from_grid.hh \
......
// Copyright (C) 2007, 2008 EPITA Research and Development Laboratory
// (LRDE)
// Copyright (C) 2007, 2008, 2009 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of the Olena Library. This library is free
// software; you can redistribute it and/or modify it under the terms
......@@ -50,6 +50,7 @@ namespace mln
/// Make an accumulator compute the pixels of the image \p input.
///
/// \param[in] input The input image.
/// \param[in] a An accumulator.
///
/// This routine runs: \n
/// a.take(make::pix(input, p));
......@@ -65,6 +66,7 @@ namespace mln
/// Make an accumulator compute the pixels of the image \p input.
///
/// \param[in] input The input image.
/// \param[in] a A meta accumulator.
///
/// This routine runs: \n
/// a.take(make::pix(input, p));
......
......@@ -51,8 +51,10 @@ namespace mln
/*! Line an accumulator onto the pixel values of the image \p input.
*
* \param[in] input The input image.
* \param[in] a The accumulator.
* \return The accumulator result.
* \param[in] p_start The starting site of the line.
* \param[in] len The line length.
* \param[in] half_length The half length of the line.
* \param[in,out] output The resulting image.
*
* This routine runs: \n
* tmp = \p a \n
......
......@@ -125,7 +125,7 @@ namespace mln
/// Default. Construct an invalid window.
graph_elt_window_if();
/// \param[in] graph_image A graph image.
/// \param[in] mask A graph image of bool.
///
/// \sa vertex_image, edge_image.
graph_elt_window_if(const Image<I>& mask);
......
......@@ -95,6 +95,11 @@ namespace mln
namespace generic
{
/// Generic implementation.
///
/// \param[in,out] ima The image to be filled.
/// \param[in] data The image.
//
template <typename I, typename J>
void fill_with_image(Image<I>& ima_, const Image<J>& data_)
{
......
......@@ -72,6 +72,12 @@ namespace mln
namespace internal
{
/// Internal tests for data::paste.
///
/// \param[in] input The input image providing pixels values.
/// \param[in,out] output The image in which values are
/// assigned.
//
template <typename I, typename J>
inline
void paste_tests(const Image<I>& input, Image<J>& output)
......@@ -97,6 +103,12 @@ namespace mln
namespace generic
{
/// Generic implementation of data::paste.
///
/// \param[in] input The input image providing pixels values.
/// \param[in,out] output The image in which values are
/// assigned.
//
template <typename I, typename J>
inline
void paste(const Image<I>& input_, Image<J>& output_)
......
......@@ -153,9 +153,9 @@ namespace mln
mlc_is(T2, Bijection_x2x<T2>)::value &&
mlc_is(T1, Bijection_x2x<T1>)::value>(f, g)
{}
};
};
} // end of namespace mln::fun::x2x
} // end of namespace mln::fun::x2x
} // end of namespace mln::fun
......
// Copyright (C) 2007 EPITA Research and Development Laboratory
// Copyright (C) 2007, 2009 EPITA Research and Development Laboratory
// (LRDE)
//
// This file is part of the Olena Library. This library is free
// software; you can redistribute it and/or modify it under the terms
......@@ -28,11 +29,10 @@
#ifndef MLN_GEOM_PMIN_PMAX_HH
# define MLN_GEOM_PMIN_PMAX_HH
/*! \file mln/geom/pmin_pmax.hh
*
* \brief Several routines to compute the minimum point and/or maximum
* point.
*/
/// \file mln/geom/pmin_pmax.hh
///
/// Several routines to compute the minimum point and/or maximum
/// point.
# include <utility>
......
// Copyright (C) 2007, 2008 EPITA Research and Development Laboratory
// (LRDE)
// Copyright (C) 2007, 2008, 2009 EPITA Research and Development
// Laboratory (LRDE)
//
// This file is part of the Olena Library. This library is free
// software; you can redistribute it and/or modify it under the terms
......@@ -29,10 +29,9 @@
#ifndef MLN_GEOM_SEEDS2TILING_HH
# define MLN_GEOM_SEEDS2TILING_HH
/*! \file mln/geom/seeds2tiling.hh
*
* \brief Convert a binary image with seeds into a labeled image.
*/
/// \file mln/geom/seeds2tiling.hh
///
/// Convert a binary image with seeds into a labeled image.
# include <map>
......@@ -46,27 +45,34 @@
namespace mln
{
namespace geom
{
/// \brief Take a labeled image \p ima_ with seeds and extend them
/// Take a labeled image \p ima_ with seeds and extend them
/// until creating tiles.
///
/// \param[in,out] ima_ The labeled image with seed.
/// \param[in] nbh The neighborhood to use on this algorithm.
///
/// \pre \p ima_ has to be initialized.
/// \return A tiled image.
///
/// \{
/// \pre \p ima_ has to be initialized.
//
template <typename I, typename N>
I seeds2tiling (Image<I>& ima_, const Neighborhood<N>& nbh);
/// \}
# ifndef MLN_INCLUDE_ONLY
namespace impl
{
/// Generic implementation of geom::seed2tiling.
///
/// \param[in,out] ima_ The labeled image with seed.
/// \param[in] nbh The neighborhood to use on this algorithm.
//
template <typename I, typename N>
inline
I
......
......@@ -31,6 +31,7 @@
/// \file mln/io/dump/save.hh
///
/// Save a Milena image by dumping its data to a file.
///
/// \todo handle endianness.
# include <iostream>
......@@ -42,6 +43,7 @@
# include <mln/data/memcpy_.hh>
# include <mln/trait/value_.hh>
namespace mln
{
......@@ -55,12 +57,15 @@ namespace mln
///
/// \param[in] ima_ The image to save.
/// \param[in] filename the destination.
//
template <typename I>
void save(const Image<I>& ima_, const std::string& filename);
# ifndef MLN_INCLUDE_ONLY
namespace internal
{
......@@ -121,6 +126,9 @@ namespace mln
} // end of namespace mln::io::dump::internal
// Facade
template <typename I>
void save(const Image<I>& ima_, const std::string& filename)
{
......
// Copyright (C) 2008 EPITA Research and Development Laboratory
// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory
// (LRDE)
//
// This file is part of the Olena Library. This library is free
......@@ -31,7 +31,7 @@
/// \file mln/io/txt/save.hh
///
/// \brief Save an image as txt file.
/// Save an image as txt file.
# include <iostream>
# include <fstream>
......@@ -52,8 +52,9 @@ namespace mln
/// Save an image as txt file.
///
/// \param[in] ima_ The image to save. Must be an image of char.
/// \param[in] ima The image to save. Must be an image of char.
/// \param[in] filename the destination.
//
void
save(const image2d<char>& ima, const std::string& filename);
......
......@@ -52,8 +52,9 @@ namespace mln
{
/// Relabel a labeled image in order to have a contiguous labeling.
/// \input[in] label The labeled image.
/// \input[out] new_nlabels The number of labels after relabeling.
///
/// \param[in] label The labeled image.
/// \param[out] new_nlabels The number of labels after relabeling.
///
/// \return The relabeled image.
//
......@@ -65,8 +66,9 @@ namespace mln
/// Relabel inplace a labeled image in order to have a contiguous
/// labeling.
/// \input[in] label The labeled image.
/// \input[out] new_nlabels The number of labels after relabeling.
///
/// \param[in] label The labeled image.
/// \param[out] new_nlabels The number of labels after relabeling.
//
template <typename I>
void
......
......@@ -52,10 +52,10 @@ namespace mln
{
/// Remove components and relabel a labeled image.
/// \input[in] label the labeled image.
/// \input[in] nlabels the number of labels in \p label.
/// \input[out] new_nlabels the number of labels after relabeling.
/// \input[in] f function returning whether a label must be replaced
/// \param[in] label the labeled image.
/// \param[in] nlabels the number of labels in \p label.
/// \param[out] new_nlabels the number of labels after relabeling.
/// \param[in] fv2b function returning whether a label must be replaced
/// by the background.
///
/// \return the relabeled image.
......@@ -69,9 +69,9 @@ namespace mln
/// Remove components and relabel a labeled image.
/// \input[in] label the labeled image.
/// \input[in] nlabels the number of labels in \p label.
/// \input[in] f function returning the new component id for each pixel
/// \param[in] label the labeled image.
/// \param[in] nlabels the number of labels in \p label.
/// \param[in] fv2v function returning the new component id for each pixel
/// value.
///
/// \return the relabeled image.
......@@ -84,9 +84,9 @@ namespace mln
/// Remove components and relabel a labeled image inplace.
/// \input[in, out] label the labeled image.
/// \input[in, out] nlabels the number of labels in \p label.
/// \input[in] f function returning whether a label must be replaced
/// \param[in, out] label the labeled image.
/// \param[in, out] nlabels the number of labels in \p label.
/// \param[in] fv2b function returning whether a label must be replaced
/// by the background.
//
template <typename I, typename F>
......@@ -97,9 +97,9 @@ namespace mln
/// Remove components and relabel a labeled image inplace.
/// \input[in, out] label the labeled image.
/// \input[in, out] nlabels the number of labels in \p label.
/// \input[in] f function returning the new component id for each
/// \param[in, out] label the labeled image.
/// \param[in, out] nlabels the number of labels in \p label.
/// \param[in] fv2v function returning the new component id for each
/// pixel value.
//
template <typename I, typename F>
......
......@@ -59,9 +59,8 @@ namespace mln
*
* \param[in] input The image to be filtered.
* \param[in] win The window.
* \param[out] output The output image.
*
* \pre \p input and \p output have to be initialized.
* \pre \p input have to be initialized.
*/
template <typename I, typename W>
mln_concrete(I)
......
......@@ -57,7 +57,8 @@ namespace mln
*
* \param[in] v A value to set the output value type.
* \param[in] input The input image.
* \param[out] output The result image.
*
* \return A stretch image with values of the same type as \p v.
*
* \pre input.is_valid
*/
......@@ -71,6 +72,13 @@ namespace mln
namespace impl
{
/// Generic implementation of level::stretch.
///
/// \param[in] v A value to set the output value type.
/// \param[in] input The input image.
///
/// \return A stretch image with values of the same type as \p v.
//
template <typename V, typename I>
inline
mln_ch_value(I, V)
......@@ -112,6 +120,9 @@ namespace mln
} // end of namespace mln::level::impl
// Facade
template <typename V, typename I>
inline
mln_ch_value(I, V)
......
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