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

Documentation class for mln::Image. More...

#include <image.hh>

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

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.
const pset &	domain () const
	Give the definition domain of the image.
bool	has (const psite &p) const
	Test if the image owns the point site p.
bool	has (const psite &p) const
	Test if p belongs to the image domain.
bool	is_valid () const
	Test if the image have been initialized.
unsigned	nsites () const
	Give the number of points of the image domain.
rvalue	operator() (const psite &p) const
	Read-only access to the image value located at p.
lvalue	operator() (const psite &p)
	Read-write access to the image value located at p.
const vset &	values () const
	Give the set of values of the image.

---

Detailed Description

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

Documentation class for mln::Image.

See also:

mln::Image

---

Member Typedef Documentation

template<typename E >

typedef void mln::doc::Image< E >::bkd_piter

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

Coordinate associated type.

template<typename E >

typedef void mln::doc::Image< E >::dpoint

Dpsite associated type.

Invariant:

This type has to derive from mln::Dpoint.

template<typename E >

typedef void mln::doc::Image< E >::fwd_piter

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

Type returned by the read-write pixel value operator.

template<typename E >

typedef void mln::doc::Image< E >::point

Site associated type.

Invariant:

This type has to derive from mln::Point.

template<typename E >

typedef void mln::doc::Image< E >::pset

Point set associated type.

Invariant:

This type has to derive from mln::Site_Set.

template<typename E >

typedef void mln::doc::Image< E >::psite

Point_Site associated type.

Invariant:

This type has to derive from mln::Point_Site.

template<typename E >

typedef void mln::doc::Image< E >::rvalue

Type returned by the read pixel value operator.

template<typename E >

typedef void mln::doc::Image< E >::skeleton

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

template<typename E >

typedef void mln::doc::Image< E >::value

Value associated type.

Invariant:

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

template<typename E >

typedef void mln::doc::Image< E >::vset

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

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 >

const pset& mln::doc::Image< E >::domain

(

)

const

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

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 >::has

(

const psite &

p

)

const

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 >::is_valid

(

)

const

Test if the image have been initialized.

template<typename E >

unsigned mln::doc::Image< E >::nsites

(

)

const

Give the number of points of the image domain.

template<typename E >

rvalue mln::doc::Image< E >::operator()

(

const psite &

p

)

const

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::Image< E >::operator()

(

const psite &

p

)

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 >

const vset& mln::doc::Image< E >::values

(

)

const

Give the set of values of the image.

Returns:

A reference to the value set.