Commit 6c2594f1 authored by Guillaume Lazzara's avatar Guillaume Lazzara
Browse files

Update doc.

	* doc/Doxyfile.in: add a new macro.

	* doc/Makefile.am: add new distributed files.

	* doc/examples/tuto3/first_routine.cc: add doxygen file tag.

	* doc/groups.hh,
	* doc/groups/accu.hh,
	* doc/groups/functions.hh,
	* doc/groups/graph.hh,
	* doc/groups/images.hh,
	* doc/groups/main.hh,
	* doc/groups/neighb.hh,
	* doc/groups/site_set.hh,
	* doc/groups/util.hh,
	* doc/groups/win.hh,
	* mln/accu/bbox.hh,
	* mln/accu/center.hh,
	* mln/accu/convolve.hh,
	* mln/accu/count.hh,
	* mln/accu/count_adjacent_vertices.hh,
	* mln/accu/count_labels.hh,
	* mln/accu/height.hh,
	* mln/accu/histo.hh,
	* mln/accu/inf.hh,
	* mln/accu/internal/couple.hh,
	* mln/accu/label_used.hh,
	* mln/accu/land.hh,
	* mln/accu/land_basic.hh,
	* mln/accu/line.hh,
	* mln/accu/lor.hh,
	* mln/accu/lor_basic.hh,
	* mln/accu/maj_h.hh,
	* mln/accu/max.hh,
	* mln/accu/max_h.hh,
	* mln/accu/mean.hh,
	* mln/accu/median_alt.hh,
	* mln/accu/median_h.hh,
	* mln/accu/min.hh,
	* mln/accu/min_h.hh,
	* mln/accu/min_max.hh,
	* mln/accu/pair.hh,
	* mln/accu/rank.hh,
	* mln/accu/rank_bool.hh,
	* mln/accu/rank_high_quant.hh,
	* mln/accu/rms.hh,
	* mln/accu/site_set/rectangularity.hh,
	* mln/accu/stat/deviation.hh,
	* mln/accu/stat/variance.hh,
	* mln/accu/sum.hh,
	* mln/accu/sup.hh,
	* mln/accu/tuple.hh,
	* mln/accu/volume.hh,
	* mln/canvas/morpho/internal/find_root.hh,
	* mln/convert/impl/from_image_to_site_set.hh,
	* mln/core/alias/neighb1d.hh,
	* mln/core/alias/neighb2d.hh,
	* mln/core/alias/neighb3d.hh,
	* mln/core/alias/window1d.hh,
	* mln/core/alias/window2d.hh,
	* mln/core/alias/window3d.hh,
	* mln/core/concept/function.hh,
	* mln/core/concept/object.hh,
	* mln/core/concept/object_id.hh,
	* mln/core/image/complex_image.hh,
	* mln/core/image/decorated_image.hh,
	* mln/core/image/edge_image.hh,
	* mln/core/image/extended.hh,
	* mln/core/image/extension_fun.hh,
	* mln/core/image/extension_ima.hh,
	* mln/core/image/extension_val.hh,
	* mln/core/image/flat_image.hh,
	* mln/core/image/fun_image.hh,
	* mln/core/image/hexa.hh,
	* mln/core/image/interpolated.hh,
	* mln/core/image/lazy_image.hh,
	* mln/core/image/plain.hh,
	* mln/core/image/safe.hh,
	* mln/core/image/slice_image.hh,
	* mln/core/image/sub_image.hh,
	* mln/core/image/sub_image_if.hh,
	* mln/core/image/t_image.hh,
	* mln/core/image/thru_morpher.hh,
	* mln/core/image/thrubin_morpher.hh,
	* mln/core/image/tr_image.hh,
	* mln/core/image/unproject_image.hh,
	* mln/core/image/vertex_image.hh,
	* mln/core/image/violent_cast_image.hh,
	* mln/core/site_set/box.hh,
	* mln/core/site_set/p_array.hh,
	* mln/core/site_set/p_centered.hh,
	* mln/core/site_set/p_complex.hh,
	* mln/core/site_set/p_edges.hh,
	* mln/core/site_set/p_faces.hh,
	* mln/core/site_set/p_if.hh,
	* mln/core/site_set/p_image.hh,
	* mln/core/site_set/p_key.hh,
	* mln/core/site_set/p_line2d.hh,
	* mln/core/site_set/p_mutable_array_of.hh,
	* mln/core/site_set/p_priority.hh,
	* mln/core/site_set/p_queue.hh,
	* mln/core/site_set/p_queue_fast.hh,
	* mln/core/site_set/p_run.hh,
	* mln/core/site_set/p_set.hh,
	* mln/core/site_set/p_vaccess.hh,
	* mln/core/site_set/p_vertices.hh,
	* mln/fun/i2v/all.hh,
	* mln/fun/meta/inty.hh,
	* mln/fun/meta/lum.hh,
	* mln/pw/image.hh,
	* mln/topo/is_n_face.hh,
	* mln/util/array.hh,
	* mln/util/couple.hh,
	* mln/util/fibonacci_heap.hh,
	* mln/util/graph.hh,
	* mln/util/line_graph.hh,
	* mln/util/ord_pair.hh,
	* mln/util/set.hh,
	* mln/util/site_pair.hh,
	* mln/util/soft_heap.hh,
	* mln/win/backdiag2d.hh,
	* mln/win/ball.hh,
	* mln/win/cube3d.hh,
	* mln/win/cuboid3d.hh,
	* mln/win/diag2d.hh,
	* mln/win/disk2d.hh,
	* mln/win/hline2d.hh,
	* mln/win/line.hh,
	* mln/win/multiple.hh,
	* mln/win/multiple_size.hh,
	* mln/win/octagon2d.hh,
	* mln/win/rectangle2d.hh,
	* mln/win/segment1d.hh,
	* mln/win/shift.hh,
	* mln/win/sphere3d.hh,
	* mln/win/vline2d.hh: revamp doc and map types to doxygen modules.

	* tests/transform/distance_and_closest_point_geodesic.cc,
	* tests/util/soft_heap.cc: fix doxygen file tag.

git-svn-id: https://svn.lrde.epita.fr/svn/oln/trunk@3732 4aad255d-cdde-0310-9447-f3009e2ae8c0
parent 1099fa9d
2009-04-29 Guillaume Lazzara <lazzara@lrde.epita.fr>
Update doc.
* doc/Doxyfile.in: add a new macro.
* doc/Makefile.am: add new distributed files.
* doc/examples/tuto3/first_routine.cc: add doxygen file tag.
* doc/groups.hh,
* doc/groups/accu.hh,
* doc/groups/functions.hh,
* doc/groups/graph.hh,
* doc/groups/images.hh,
* doc/groups/main.hh,
* doc/groups/neighb.hh,
* doc/groups/site_set.hh,
* doc/groups/util.hh,
* doc/groups/win.hh,
* mln/accu/bbox.hh,
* mln/accu/center.hh,
* mln/accu/convolve.hh,
* mln/accu/count.hh,
* mln/accu/count_adjacent_vertices.hh,
* mln/accu/count_labels.hh,
* mln/accu/height.hh,
* mln/accu/histo.hh,
* mln/accu/inf.hh,
* mln/accu/internal/couple.hh,
* mln/accu/label_used.hh,
* mln/accu/land.hh,
* mln/accu/land_basic.hh,
* mln/accu/line.hh,
* mln/accu/lor.hh,
* mln/accu/lor_basic.hh,
* mln/accu/maj_h.hh,
* mln/accu/max.hh,
* mln/accu/max_h.hh,
* mln/accu/mean.hh,
* mln/accu/median_alt.hh,
* mln/accu/median_h.hh,
* mln/accu/min.hh,
* mln/accu/min_h.hh,
* mln/accu/min_max.hh,
* mln/accu/pair.hh,
* mln/accu/rank.hh,
* mln/accu/rank_bool.hh,
* mln/accu/rank_high_quant.hh,
* mln/accu/rms.hh,
* mln/accu/site_set/rectangularity.hh,
* mln/accu/stat/deviation.hh,
* mln/accu/stat/variance.hh,
* mln/accu/sum.hh,
* mln/accu/sup.hh,
* mln/accu/tuple.hh,
* mln/accu/volume.hh,
* mln/canvas/morpho/internal/find_root.hh,
* mln/convert/impl/from_image_to_site_set.hh,
* mln/core/alias/neighb1d.hh,
* mln/core/alias/neighb2d.hh,
* mln/core/alias/neighb3d.hh,
* mln/core/alias/window1d.hh,
* mln/core/alias/window2d.hh,
* mln/core/alias/window3d.hh,
* mln/core/concept/function.hh,
* mln/core/concept/object.hh,
* mln/core/concept/object_id.hh,
* mln/core/image/complex_image.hh,
* mln/core/image/decorated_image.hh,
* mln/core/image/edge_image.hh,
* mln/core/image/extended.hh,
* mln/core/image/extension_fun.hh,
* mln/core/image/extension_ima.hh,
* mln/core/image/extension_val.hh,
* mln/core/image/flat_image.hh,
* mln/core/image/fun_image.hh,
* mln/core/image/hexa.hh,
* mln/core/image/interpolated.hh,
* mln/core/image/lazy_image.hh,
* mln/core/image/plain.hh,
* mln/core/image/safe.hh,
* mln/core/image/slice_image.hh,
* mln/core/image/sub_image.hh,
* mln/core/image/sub_image_if.hh,
* mln/core/image/t_image.hh,
* mln/core/image/thru_morpher.hh,
* mln/core/image/thrubin_morpher.hh,
* mln/core/image/tr_image.hh,
* mln/core/image/unproject_image.hh,
* mln/core/image/vertex_image.hh,
* mln/core/image/violent_cast_image.hh,
* mln/core/site_set/box.hh,
* mln/core/site_set/p_array.hh,
* mln/core/site_set/p_centered.hh,
* mln/core/site_set/p_complex.hh,
* mln/core/site_set/p_edges.hh,
* mln/core/site_set/p_faces.hh,
* mln/core/site_set/p_if.hh,
* mln/core/site_set/p_image.hh,
* mln/core/site_set/p_key.hh,
* mln/core/site_set/p_line2d.hh,
* mln/core/site_set/p_mutable_array_of.hh,
* mln/core/site_set/p_priority.hh,
* mln/core/site_set/p_queue.hh,
* mln/core/site_set/p_queue_fast.hh,
* mln/core/site_set/p_run.hh,
* mln/core/site_set/p_set.hh,
* mln/core/site_set/p_vaccess.hh,
* mln/core/site_set/p_vertices.hh,
* mln/fun/i2v/all.hh,
* mln/fun/meta/inty.hh,
* mln/fun/meta/lum.hh,
* mln/pw/image.hh,
* mln/topo/is_n_face.hh,
* mln/util/array.hh,
* mln/util/couple.hh,
* mln/util/fibonacci_heap.hh,
* mln/util/graph.hh,
* mln/util/line_graph.hh,
* mln/util/ord_pair.hh,
* mln/util/set.hh,
* mln/util/site_pair.hh,
* mln/util/soft_heap.hh,
* mln/win/backdiag2d.hh,
* mln/win/ball.hh,
* mln/win/cube3d.hh,
* mln/win/cuboid3d.hh,
* mln/win/diag2d.hh,
* mln/win/disk2d.hh,
* mln/win/hline2d.hh,
* mln/win/line.hh,
* mln/win/multiple.hh,
* mln/win/multiple_size.hh,
* mln/win/octagon2d.hh,
* mln/win/rectangle2d.hh,
* mln/win/segment1d.hh,
* mln/win/shift.hh,
* mln/win/sphere3d.hh,
* mln/win/vline2d.hh: revamp doc and map types to doxygen modules.
* tests/transform/distance_and_closest_point_geodesic.cc,
* tests/util/soft_heap.cc: fix doxygen file tag.
2009-04-29 Guillaume Lazzara <lazzara@lrde.epita.fr>
 
Small fixes.
......@@ -285,7 +285,8 @@ PREDEFINED = "mlc_unqualif(T)=typename mln::metal::unqualif<T>::ret"
"mln_gradient_component(I)=typename mln::trait::ch_value< I, mln::value::props< typename I::value >::sum >::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_sum_product(T, U)=typename mln::trait::value_< mln_trait_op_times(T,U) >::sum" \
"mln_deduce(T, A1, A2)=typename T::A1::A2"
......
......@@ -99,6 +99,7 @@ include $(srcdir)/outputs/outputs.mk
EXTRA_DIST += \
Doxyfile.in \
groups \
user \
tools/sample_utils.hh \
tools/split_sample.sh \
......
/// \file doc/examples/first_routine.cc
#include <mln/essential/2d.hh>
#include <tests/data.hh>
#include <doc/tools/sample_utils.hh>
......
/*! \defgroup modimage Image types.
*
* All the generic image types provided in Olena.
*
*/
/*! \defgroup modimageconcrete Basic types.
*
* Concrete images.
*
* \ingroup modimage
*/
/*! \defgroup modimagevaluemorpher Morpher on values.
*
* Morpher on image values.
*
* \ingroup modimage
*/
/*! \defgroup modimagedomainmorpher Morpher on domain.
*
* Morpher on image domain.
*
* \ingroup modimage
*/
/*! \defgroup modaccusiteset On site sets
*
* \brief Accumulators working on site sets.
*
* \ingroup modaccu
*/
/*! \defgroup modaccuimages On images
*
* \brief Accumulators working on images.
*
* \ingroup modaccu
*/
/*! \defgroup modaccuvalues On values
*
* \brief Accumulators working on image values.
*
* \ingroup modaccu
*/
/*! \defgroup modaccumulti Multiple accumulators
*
* \brief Set of special accumulators for computing several accumulators
* at the same time.
*
* \ingroup modaccu
*/
/*! \defgroup modfunconcept Concepts
*
* \brief All function concepts.
*
* \ingroup modfun
*/
/*! \defgroup modgraph Graphes
*
* \brief All graphes implementations.
*
* \ingroup modtypes
*/
/*! \defgroup modimage Images
*
* \brief All the generic image types provided in Olena.
*
* \ingroup modtypes
*/
/*! \defgroup modimageconcrete Basic types
*
* \brief Concrete images.
*
* \ingroup modimage
*/
/*! \defgroup modimagevaluemorpher Values morphers
*
* \brief Morpher on image values.
*
* \ingroup modimage
*/
/*! \defgroup modimagedomainmorpher Domain morphers
*
* \brief Morpher on image domain.
*
* \ingroup modimage
*/
/*! \defgroup modimageidmorpher Identity morphers
*
* \brief Morpher adding new functionnalities.
*
* \ingroup modimage
*/
/*! \defgroup modtypes Types
*
* \brief Milena Object types.
*
*/
/*! \defgroup modaccu Accumulators
*
* \brief All accumulator types.
*
*/
/*! \defgroup modroutines Routines
*
* \brief All algorithms/routines provided in Milena.
*
*/
/*! \defgroup modcanvas Canvas
*
* \brief All canvas.
*
*/
/*! \defgroup modfun Functions
*
* \brief All predefined functions.
*
*/
/*! \defgroup modneighb Neighborhoods
*
* \brief All the predefined generic neighborhoods.
*
* \ingroup modtypes
*/
/*! \defgroup modneighb1d 1D neighborhoods
*
* \brief Predefined 1D neighborhoods.
*
* \ingroup modneighb
*/
/*! \defgroup modneighb2d 2D neighborhoods
*
* \brief Predefined 2D neighborhoods.
*
* \ingroup modneighb
*/
/*! \defgroup modneighb3d 3D neighborhoods
*
* \brief Predefined 3D neighborhoods.
*
* \ingroup modneighb
*/
/*! \defgroup modsiteset Site sets
*
* \brief All Site set types.
*
* \ingroup modtypes
*/
/*! \defgroup modsitesetbasic Basic types
*
* \brief Basic site sets.
*
* \ingroup modsiteset
*/
/*! \defgroup modsitesetgraph Graph based
*
* \brief Site sets based on a graph.
*
* \ingroup modsiteset
*/
/*! \defgroup modsitesetcomplex Complex based
*
* \brief Site sets based on a complexes.
*
* \ingroup modsiteset
*/
/*! \defgroup modsitesetsparse Sparse types
*
* \brief Sparse site sets.
*
* \ingroup modsiteset
*/
/*! \defgroup modsitesetqueue Queue based
*
* \brief Site sets based on a queue.
*
* \ingroup modsiteset
*/
/*! \defgroup modutil Utilities
*
* \brief Miscalleneous useful containers/structures.
*
* \ingroup modtypes
*/
/*! \defgroup modwin Windows
*
* \brief All the predefined generic windows.
*
* \ingroup modtypes
*/
/*! \defgroup modwin1d 1D windows
*
* \brief Predefined 1D windows.
*
* \ingroup modwin
*/
/*! \defgroup modwin2d 2D windows
*
* \brief Predefined 2D windows.
*
* \ingroup modwin
*/
/*! \defgroup modwin3d 3D windows
*
* \brief Predefined 3D windows.
*
* \ingroup modwin
*/
/*! \defgroup modwinnd N-D windows
*
* \brief Predefined N-D windows.
*
* \ingroup modwin
*/
/*! \defgroup modwinmulti Multiple windows
*
* \brief Generic multiple windows.
*
* \ingroup modwin
*/
// 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
......@@ -44,10 +45,12 @@ namespace mln
{
/// Generic bbox accumulator class.
/// \brief Generic bounding box accumulator class.
///
/// The parameter \c P is the type of points.
///
/// \ingroup modaccusiteset
//
template <typename P>
struct bbox : public mln::accu::internal::base< const box<P>& , bbox<P> >
{
......
......@@ -45,11 +45,14 @@ namespace mln
{
/// Generic center accumulator class.
/// \brief Mass center accumulator.
///
/// \tparam P the type of site.
/// \tparam V the type of vector to be used as result.
/// The default vector type is the one provided by P.
///
/// \ingroup modaccusiteset
//
template <typename P, typename V = typename P::vec>
struct center
: public mln::accu::internal::base<V, center<P,V> >
......
// Copyright (C) 2008 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
......@@ -44,11 +45,13 @@ namespace mln
{
/// Generic convolution accumulator class.
/// \brief Generic convolution accumulator class.
///
/// Parameters \c T1 and \c T2 are the type of values to be
/// convolved. Parameter \c R is the result type.
///
/// \ingroup modaccuvalues
//
template <typename T1, typename T2,
typename R = mln_sum_product(T1, T2)>
struct convolve : public mln::accu::internal::base< R, convolve<T1,T2,R> >,
......
// 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
......@@ -43,8 +43,11 @@ namespace mln
namespace accu
{
/// Generic counter accumulator class.
/// \brief Generic counter accumulator.
/// The parameter \a T is the type to be count.
///
/// \ingroup modaccusiteset
//
template <typename T>
struct count : public mln::accu::internal::base< unsigned , count<T> >
{
......
// 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
......@@ -45,7 +45,7 @@ namespace mln
namespace accu
{
/// Accumulator class counting the number of vertices
/// \brief Accumulator class counting the number of vertices
/// adjacent to a set of mln::p_edges_psite (i.e., a set of
/// edges).
///
......@@ -54,6 +54,9 @@ namespace mln
///
/// This accumulator is used by mln::closing_area_on_vertices and
/// mln::opening_area_on_vertices.
///
/// \ingroup modaccuimages
//
template <typename F, typename S>
struct count_adjacent_vertices
: public mln::accu::internal::base< unsigned,
......
......@@ -46,8 +46,11 @@ namespace mln
namespace accu
{
/// Generic counter accumulator class.
/// \brief Count the number of different labels in an image.
/// The parameter \a L is the label type to be count.
///
/// \ingroup modaccuvalues
//
template <typename L>
struct count_labels
: public mln::accu::internal::base< unsigned , count_labels<L> >,
......
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