oln::abstract::image_size< Exact > Class Template Reference

#include <image_size.hh>

Inheritance diagram for oln::abstract::image_size< Exact >:

Inheritance graph
[legend]
Collaboration diagram for oln::abstract::image_size< Exact >:

Collaboration graph
[legend]
List of all members.

Public Types

enum  { dim = image_size_traits<Exact>::dim }

Public Member Functions

coord nth (unsigned n) const
 Return the number of coordinates in the nth section of the image.
coordnth (unsigned n)
 Return a reference to the number of coordinates in the nth section of the image.
coord border () const
 Return the value border width of the current image.
coordborder ()
 Return a reference to the border width of the current image.
template<class S>
bool operator== (const image_size< S > &size) const
 Test if two images have compatible size.
template<class S>
bool operator!= (const image_size< S > &size) const
 Test if two images do not have compatible size.
 image_size ()

Static Public Member Functions

static std::string name ()

Protected Attributes

coord border_

Detailed Description

template<class Exact>
class oln::abstract::image_size< Exact >

The class that defines the image size according to its dimension.

Definition at line 76 of file image_size.hh.


Member Function Documentation

template<class Exact>
template<class S>
bool oln::abstract::image_size< Exact >::operator== ( const image_size< S > &  size  )  const [inline]

Test if two images have compatible size.

Returns:
True if the two images have compatible size, false otherwise.

Definition at line 129 of file image_size.hh.

00130       {
00131         for (unsigned i = 0; i < dim; ++i)
00132           if (coord_[i] != size.coord_[i])
00133             return false;
00134         return true;
00135       }

template<class Exact>
template<class S>
bool oln::abstract::image_size< Exact >::operator!= ( const image_size< S > &  size  )  const [inline]

Test if two images do not have compatible size.

Returns:
False if the two images have compatible size, true otherwise.

Definition at line 144 of file image_size.hh.

00145       {
00146         for (unsigned i = 0; i < dim; ++i)
00147           if (coord_[i] != size.coord_[i])
00148             return true;
00149         return false;
00150       }


Member Data Documentation

template<class Exact>
coord oln::abstract::image_size< Exact >::border_ [protected]

border_ represents the width of the image border such a mecanism allow algorithm to perform operation on the points at the edge of the image as if they were normally surrounded by points

Definition at line 172 of file image_size.hh.

Referenced by oln::abstract::image_size< oln::image2d_size >::border(), oln::image1d_size::image1d_size(), oln::image2d_size::image2d_size(), and oln::image3d_size::image3d_size().


The documentation for this class was generated from the following file:
Generated on Tue Feb 20 20:24:56 2007 for Olena by  doxygen 1.5.1