$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mln::util Namespace Reference

Namespaces

namespace  impl
namespace  internal

Classes

class  adjacency_matrix
 A class of adjacency matrix. More...
class  array
 A dynamic array class. More...
class  array_bkd_iter
class  array_fwd_iter
struct  bi_elt
class  branch
 Class of generic branch. More...
class  branch_iter
class  branch_iter_ind
class  couple
 Definition of a couple. More...
struct  dindex_
 Delta-index structure. More...
struct  eat
 Eat structure. More...
class  edge
 Edge of a graph G. More...
class  fibonacci_heap
 Fibonacci heap. More...
class  graph
 Undirected graph. More...
class  greater_point
 A ``greater than'' functor comparing points w.r.t. More...
class  greater_psite
 A ``greater than'' functor comparing psites w.r.t. More...
class  head
 Top structure of the soft heap. More...
struct  hqueues
struct  ignore
 Ignore structure. More...
struct  ilcell
 Element of an item list. Store the data (key) used in soft_heap. More...
struct  index_
 Index structure. More...
class  lazy_set_
 An "efficient" mathematical set class. More...
struct  lemmings_
 Lemmings tool. More...
class  line_graph
 Undirected line graph of a graph of type G. More...
struct  multi_site
struct  nil
 Nil structure. More...
class  node
 Meta-data of an element in the heap. More...
class  object_id
 Base class of an object id. More...
struct  ord
 Function-object that defines an ordering between objects with type T: lhs R rhs. More...
struct  ord_pair
 Ordered pair structure s.a. More...
struct  pix
 Structure pix. More...
class  set
 An "efficient" mathematical set class. More...
class  set_bkd_iter
class  set_fwd_iter
class  site_pair
 A pair of sites. More...
class  soft_heap
 Soft heap. More...
class  static_array
class  timer
 Timer structure. More...
struct  tracked_ptr
 Smart pointer for shared data with tracking. More...
class  tree
 Class of generic tree. More...
struct  tree_fast
class  tree_node
 Class of generic tree_node for tree. More...
class  vertex
 Vertex of a graph G. More...
struct  yes
 Object that always says "yes". More...

Typedefs

typedef dindex_< void > dindex
typedef object_id< edge_tag,
unsigned
edge_id_t
typedef index_< void > index
typedef object_id< vertex_tag,
unsigned
vertex_id_t

Functions

template<typename I , typename J >
void display_branch (const Image< J > &ima_, tree_node< I > *tree_node)
template<typename I , typename J >
void display_tree (const Image< J > &ima_, tree< I > &tree)
template<typename Tag , typename V >
void from_to_ (const util::object_id< Tag, V > &from, V &to_)
template<typename T1 , typename T2 >
void from_to_ (const array< T1 > &from, array< T2 > &to)
template<typename T >
void from_to_ (const array< T > &from, fun::i2v::array< T > &to)
template<typename T , typename U >
void from_to_ (const array< T > &from, fun::i2v::array< U > &to)
template<typename V , typename T >
void from_to_ (const util::array< V > &from, image1d< T > &to)
template<typename I >
I::psite lemmings (const Image< I > &ima, const typename I::psite &pt, const typename I::psite::delta &dpt, const typename I::value &val)
template<typename I >
greater_point< I > make_greater_point (const Image< I > &ima)
template<typename I >
greater_psite< I > make_greater_psite (const Image< I > &ima)
template<typename T >
bool max (const T &lhs, const T &rhs)
template<typename T , typename U >
bool operator< (const couple< T, U > &lhs, const couple< T, U > &rhs)
template<typename P >
bool operator< (const site_pair< P > &lhs, const site_pair< P > &rhs)
template<typename P >
bool operator< (const multi_site< P > &lhs, const multi_site< P > &rhs)
template<typename Tag , typename V , typename V2 >
bool operator< (const object_id< Tag, V > &lhs, const object_id< Tag, V > &rhs)
template<typename T >
bool operator< (const ord_pair< T > &lhs, const ord_pair< T > &rhs)
template<typename G >
bool operator< (const edge< G > &lhs, const edge< G > &rhs)
template<typename G >
bool operator< (const vertex< G > &lhs, const vertex< G > &rhs)
template<typename T >
bool operator< (const set< T > &lhs, const set< T > &rhs)
template<typename P >
std::ostream & operator<< (std::ostream &ostr, const site_pair< P > &p)
template<typename T , typename U >
std::ostream & operator<< (std::ostream &ostr, const couple< T, U > &op)
template<typename T >
std::ostream & operator<< (std::ostream &ostr, const ord_pair< T > &op)
template<typename G >
std::ostream & operator<< (std::ostream &ostr, const vertex< G > &v)
template<typename G >
std::ostream & operator<< (std::ostream &ostr, const edge< G > &p)
template<typename V >
std::ostream & operator<< (std::ostream &ostr, const adjacency_matrix< V > &adj)
template<typename G >
std::ostream & operator<< (std::ostream &ostr, const line_graph< G > &g)
std::ostream & operator<< (std::ostream &ostr, const graph &g)
template<typename P , typename T >
std::ostream & operator<< (std::ostream &ostr, const fibonacci_heap< P, T > &heap)
template<typename T , typename U >
bool operator<= (const couple< T, U > &lhs, const couple< T, U > &rhs)
template<typename T >
bool operator<= (const ord_pair< T > &lhs, const ord_pair< T > &rhs)
template<typename T >
bool operator<= (const set< T > &lhs, const set< T > &rhs)
template<typename D , std::size_t n>
bool operator== (const static_array< D, n > &lhs, const static_array< D, n > &rhs)
template<typename P >
bool operator== (const site_pair< P > &lhs, const site_pair< P > &rhs)
template<typename T , typename U >
bool operator== (const couple< T, U > &lhs, const couple< T, U > &rhs)
template<typename P >
bool operator== (const multi_site< P > &lhs, const multi_site< P > &rhs)
template<typename Tag , typename V >
bool operator== (const object_id< Tag, V > &lhs, const object_id< Tag, V > &rhs)
template<typename T >
bool operator== (const ord_pair< T > &lhs, const ord_pair< T > &rhs)
template<typename G >
bool operator== (const vertex< G > &v1, const vertex< G > &v2)
template<typename G >
bool operator== (const edge< G > &lhs, const edge< G > &rhs)
template<typename T >
bool operator== (const set< T > &lhs, const set< T > &rhs)
template<typename T1 , typename T2 >
bool ord_lexi_strict (const T1 &lhs_1, const T2 &lhs_2, const T1 &rhs_1, const T2 &rhs_2)
template<typename T >
bool ord_strict (const T &lhs, const T &rhs)
template<typename T >
bool ord_weak (const T &lhs, const T &rhs)
template<typename T , typename I >
void tree_fast_to_image (tree_fast< T > &tree, Image< I > &output_)
template<typename T >
tree_fast< Ttree_to_fast (tree< T > &input)
template<typename T , typename I >
void tree_to_image (tree< T > &tree, Image< I > &output_)

Detailed Description

Namespace of tools using for more complex algorithm.

Forward declaration.

Typedef Documentation

typedef dindex_<void> mln::util::dindex

Definition at line 111 of file dindex.hh.

Definition at line 49 of file graph_ids.hh.

typedef index_<void> mln::util::index

Definition at line 108 of file index.hh.

Vertex id type.

Definition at line 43 of file graph_ids.hh.

Function Documentation

template<typename I , typename J >
void mln::util::display_branch ( const Image< J > &  ima_,
tree_node< I > *  tree_node 
)

Display an arborescence from tree_node.

Parameters
[in]ima_The domain of output image.
[in]tree_nodeThe root tree_node to display.
template<typename I , typename J >
void mln::util::display_tree ( const Image< J > &  ima_,
tree< I > &  tree 
)

Display a tree.

Parameters
[in]ima_The domain of output image.
[in]treeThe tree to display.
template<typename Tag , typename V >
void mln::util::from_to_ ( const util::object_id< Tag, V > &  from,
V &  to_ 
)
template<typename T1 , typename T2 >
void mln::util::from_to_ ( const array< T1 > &  from,
array< T2 > &  to 
)

INTERNAL_API Conversion: array -> array

template<typename T >
void mln::util::from_to_ ( const array< T > &  from,
fun::i2v::array< T > &  to 
)
inline

Conversion: array<T> -> fun::i2v::array<T>

template<typename T , typename U >
void mln::util::from_to_ ( const array< T > &  from,
fun::i2v::array< U > &  to 
)
inline

Conversion: array<T> -> fun::i2v::array<U>

template<typename V , typename T >
void mln::util::from_to_ ( const util::array< V > &  from,
image1d< T > &  to 
)

Conversion: util::array -> image1d.

template<typename I >
I ::psite mln::util::lemmings ( const Image< I > &  ima,
const typename I::psite &  pt,
const typename I::psite::delta &  dpt,
const typename I::value &  val 
)

Launch a lemmings on an image.

A lemmings is the point pt that you put on an image ima . This point will move through the image using the delta-point dpt while consider his value on the given image.

Returns
The first point that is not in the domain domain or which value on the given image is different to the value val.
Precondition
The domain domain must be contained in the domain of ima.
template<typename I >
greater_point<I> mln::util::make_greater_point ( const Image< I > &  ima)

Helper to build a mln::util::greater_point.

template<typename I >
greater_psite<I> mln::util::make_greater_psite ( const Image< I > &  ima)

Helper to build a mln::util::greater_psite.

template<typename T >
bool mln::util::max ( const T lhs,
const T rhs 
)
template<typename T , typename U >
bool mln::util::operator< ( const couple< T, U > &  lhs,
const couple< T, U > &  rhs 
)
template<typename P >
bool mln::util::operator< ( const site_pair< P > &  lhs,
const site_pair< P > &  rhs 
)
template<typename P >
bool mln::util::operator< ( const multi_site< P > &  lhs,
const multi_site< P > &  rhs 
)
template<typename Tag , typename V , typename V2 >
bool mln::util::operator< ( const object_id< Tag, V > &  lhs,
const object_id< Tag, V > &  rhs 
)
template<typename T >
bool mln::util::operator< ( const ord_pair< T > &  lhs,
const ord_pair< T > &  rhs 
)
template<typename G >
bool mln::util::operator< ( const edge< G > &  lhs,
const edge< G > &  rhs 
)
template<typename G >
bool mln::util::operator< ( const vertex< G > &  lhs,
const vertex< G > &  rhs 
)

Less operator. Test whether lhs.id() < rhs.id().

template<typename T >
bool mln::util::operator< ( const set< T > &  lhs,
const set< T > &  rhs 
)
template<typename P >
std::ostream& mln::util::operator<< ( std::ostream &  ostr,
const site_pair< P > &  p 
)
template<typename T , typename U >
std::ostream& mln::util::operator<< ( std::ostream &  ostr,
const couple< T, U > &  op 
)
template<typename T >
std::ostream& mln::util::operator<< ( std::ostream &  ostr,
const ord_pair< T > &  op 
)
template<typename G >
std::ostream& mln::util::operator<< ( std::ostream &  ostr,
const vertex< G > &  v 
)

Push the vertex v in the output stream ostr.

template<typename G >
std::ostream& mln::util::operator<< ( std::ostream &  ostr,
const edge< G > &  p 
)
template<typename V >
std::ostream& mln::util::operator<< ( std::ostream &  ostr,
const adjacency_matrix< V > &  adj 
)
template<typename G >
std::ostream& mln::util::operator<< ( std::ostream &  ostr,
const line_graph< G > &  g 
)
std::ostream& mln::util::operator<< ( std::ostream &  ostr,
const graph &  g 
)
template<typename P , typename T >
std::ostream& mln::util::operator<< ( std::ostream &  ostr,
const fibonacci_heap< P, T > &  heap 
)
template<typename T , typename U >
bool mln::util::operator<= ( const couple< T, U > &  lhs,
const couple< T, U > &  rhs 
)
template<typename T >
bool mln::util::operator<= ( const ord_pair< T > &  lhs,
const ord_pair< T > &  rhs 
)
template<typename T >
bool mln::util::operator<= ( const set< T > &  lhs,
const set< T > &  rhs 
)
template<typename D , std::size_t n>
bool mln::util::operator== ( const static_array< D, n > &  lhs,
const static_array< D, n > &  rhs 
)
template<typename P >
bool mln::util::operator== ( const site_pair< P > &  lhs,
const site_pair< P > &  rhs 
)
template<typename T , typename U >
bool mln::util::operator== ( const couple< T, U > &  lhs,
const couple< T, U > &  rhs 
)
template<typename P >
bool mln::util::operator== ( const multi_site< P > &  lhs,
const multi_site< P > &  rhs 
)
template<typename Tag , typename V >
bool mln::util::operator== ( const object_id< Tag, V > &  lhs,
const object_id< Tag, V > &  rhs 
)
template<typename T >
bool mln::util::operator== ( const ord_pair< T > &  lhs,
const ord_pair< T > &  rhs 
)
template<typename G >
bool mln::util::operator== ( const vertex< G > &  v1,
const vertex< G > &  v2 
)

Equality operator.

Test whether two vertices have the same id.

template<typename G >
bool mln::util::operator== ( const edge< G > &  lhs,
const edge< G > &  rhs 
)
template<typename T >
bool mln::util::operator== ( const set< T > &  lhs,
const set< T > &  rhs 
)
template<typename T1 , typename T2 >
bool mln::util::ord_lexi_strict ( const T1 &  lhs_1,
const T2 &  lhs_2,
const T1 &  rhs_1,
const T2 &  rhs_2 
)
template<typename T >
bool mln::util::ord_strict ( const T lhs,
const T rhs 
)

Routine to test if lhs is strictly "less-than" rhs.

template<typename T >
bool mln::util::ord_weak ( const T lhs,
const T rhs 
)

Routine to test if lhs is "less-than or equal-to" rhs.

template<typename T , typename I >
void mln::util::tree_fast_to_image ( tree_fast< T > &  tree,
Image< I > &  output_ 
)

Convert a tree_fast into an image.

  \param[in] tree The tree to convert.
  \param[out] output_ The image containing tree informations.
template<typename T >
tree_fast<T> mln::util::tree_to_fast ( tree< T > &  input)

Convert a tree into an tree_fast.

  \param[in] input The tree to convert.

  \return The tree_fast containing tree informations.
template<typename T , typename I >
void mln::util::tree_to_image ( tree< T > &  tree,
Image< I > &  output_ 
)

Convert a tree into an image.

Parameters
[in]treeThe tree to convert.
[out]output_The image containing tree information.