mln::doc::Fastest_Image< E > Struct Template Reference

Documentation class for the concept of images that have the speed property set to "fastest". More...

#include <image_fastest.hh>

Inheritance diagram for mln::doc::Fastest_Image< E >:

Inheritance graph

List of all members.

Public Types

typedef void bkd_piter
 Backward point iterator associated type.
typedef void coord
 Coordinate associated type.
typedef void dpoint
 Dpsite associated type.
typedef void fwd_piter
 Forward point iterator associated type.
typedef void lvalue
 Type returned by the read-write pixel value operator.
typedef void point
 Site associated type.
typedef void pset
 Point set associated type.
typedef void psite
 Point_Site associated type.
typedef void rvalue
 Type returned by the read pixel value operator.
typedef void skeleton
 Associate type that describes how this type of image is constructed.
typedef void value
 Value associated type.
typedef void vset
 Value set associated type.

Public Member Functions

const box< point > & bbox () const
 Give a bounding box of the image domain.
unsigned border ()
 Give the border thickness.
const value * buffer () const
 Give a hook to the value buffer.
int delta_index (const dpoint &dp)
 Give the offset corresponding to the delta-point dp.
const pset & domain () const
 Give the definition domain of the image.
bool has (const psite &p) const
 Test if p belongs to the image domain.
bool has (const psite &p) const
 Test if the image owns the point site p.
bool is_valid () const
 Test if the image have been initialized.
unsigned nelements () const
 Give the number of pixels of the image including those of the virtual border.
unsigned nsites () const
 Give the number of points of the image domain.
lvalue operator() (const psite &p)
 Read-write access to the image value located at p.
rvalue operator() (const psite &p) const
 Read-only access to the image value located at p.
lvalue operator[] (unsigned o)
 Read-write access to the image value at offset o.
rvalue operator[] (unsigned o) const
 Read-only access to the image value at offset o.
point point_at_index (unsigned o) const
 Give the point at offset o.
const vset & values () const
 Give the set of values of the image.

Detailed Description

template<typename E>
struct mln::doc::Fastest_Image< E >

Documentation class for the concept of images that have the speed property set to "fastest".

Member Typedef Documentation

template<typename E>
typedef void mln::doc::Image< E >::bkd_piter [inherited]

Backward point iterator associated type.

Invariant:
This type has to derive from mln::Site_Iterator.

template<typename E>
typedef void mln::doc::Image< E >::coord [inherited]

Coordinate associated type.

template<typename E>
typedef void mln::doc::Image< E >::dpoint [inherited]

Dpsite associated type.

Invariant:
This type has to derive from mln::Dpoint.

template<typename E>
typedef void mln::doc::Image< E >::fwd_piter [inherited]

Forward point iterator associated type.

Invariant:
This type has to derive from mln::Site_Iterator.

template<typename E>
typedef void mln::doc::Image< E >::lvalue [inherited]

Type returned by the read-write pixel value operator.

template<typename E>
typedef void mln::doc::Image< E >::point [inherited]

Site associated type.

Invariant:
This type has to derive from mln::Point.

template<typename E>
typedef void mln::doc::Image< E >::pset [inherited]

Point set associated type.

Invariant:
This type has to derive from mln::Site_Set.

template<typename E>
typedef void mln::doc::Image< E >::psite [inherited]

Point_Site associated type.

Invariant:
This type has to derive from mln::Point_Site.

template<typename E>
typedef void mln::doc::Image< E >::rvalue [inherited]

Type returned by the read pixel value operator.

template<typename E>
typedef void mln::doc::Image< E >::skeleton [inherited]

Associate type that describes how this type of image is constructed.

template<typename E>
typedef void mln::doc::Image< E >::value [inherited]

Value associated type.

Invariant:
This type is neither qualified by const, nor by reference.

template<typename E>
typedef void mln::doc::Image< E >::vset [inherited]

Value set associated type.

Invariant:
This type has to derive from mln::Value_Set.

Member Function Documentation

template<typename E>
const box<point>& mln::doc::Image< E >::bbox (  )  const [inherited]

Give a bounding box of the image domain.

This bounding box may be larger than the smallest bounding box (the optimal one). Practically an image type is not obliged to update its bounding box so that it is always optimal.

Returns:
A bounding box of the image domain.

template<typename E>
unsigned mln::doc::Fastest_Image< E >::border (  ) 

Give the border thickness.

Precondition:
The image has to be initialized.

template<typename E>
const value* mln::doc::Fastest_Image< E >::buffer (  )  const

Give a hook to the value buffer.

Precondition:
The image has to be initialized.

template<typename E>
int mln::doc::Fastest_Image< E >::delta_index ( const dpoint &  dp  ) 

Give the offset corresponding to the delta-point dp.

Parameters:
[in] dp A delta-point.
Precondition:
The image has to be initialized.

template<typename E>
const pset& mln::doc::Image< E >::domain (  )  const [inherited]

Give the definition domain of the image.

Returns:
A reference to the domain point set.

template<typename E>
bool mln::doc::Image< E >::has ( const psite &  p  )  const [inherited]

Test if p belongs to the image domain.

Parameters:
[in] p A point site.
Returns:
True if p belongs to the image domain.
Invariant:
has(p) is true => has(p) is also true.

template<typename E>
bool mln::doc::Image< E >::has ( const psite &  p  )  const [inherited]

Test if the image owns the point site p.

Returns:
True if accessing the image value at p is possible, that is, does not abort the execution.

template<typename E>
bool mln::doc::Image< E >::is_valid (  )  const [inherited]

Test if the image have been initialized.

template<typename E>
unsigned mln::doc::Fastest_Image< E >::nelements (  )  const

Give the number of pixels of the image including those of the virtual border.

Precondition:
The image has to be initialized.

template<typename E>
unsigned mln::doc::Image< E >::nsites (  )  const [inherited]

Give the number of points of the image domain.

template<typename E>
lvalue mln::doc::Image< E >::operator() ( const psite &  p  )  [inherited]

Read-write access to the image value located at p.

Parameters:
[in] p A point site.
Precondition:
The image has to own the site p.
Returns:
The value at p (assignable).

template<typename E>
rvalue mln::doc::Image< E >::operator() ( const psite &  p  )  const [inherited]

Read-only access to the image value located at p.

Parameters:
[in] p A point site.
Precondition:
The image has to own the site p.
Returns:
The value at p (not assignable).

template<typename E>
lvalue mln::doc::Fastest_Image< E >::operator[] ( unsigned  o  ) 

Read-write access to the image value at offset o.

Parameters:
[in] o An offset.
Precondition:
o < nelements()
Returns:
The value at o (assignable).

template<typename E>
rvalue mln::doc::Fastest_Image< E >::operator[] ( unsigned  o  )  const

Read-only access to the image value at offset o.

Parameters:
[in] o An offset.
Precondition:
o < nelements()
Returns:
The value at o (not assignable).

template<typename E>
point mln::doc::Fastest_Image< E >::point_at_index ( unsigned  o  )  const

Give the point at offset o.

Parameters:
[in] o An offset.
Precondition:
The image has to be initialized.

o < nelements()

template<typename E>
const vset& mln::doc::Image< E >::values (  )  const [inherited]

Give the set of values of the image.

Returns:
A reference to the value set.

Generated on Thu Sep 9 19:31:56 2010 for Milena (Olena) by  doxygen 1.5.6