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

Documentation class for mln::Generalized_Pixel. More...

#include <generalized_pixel.hh>

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

List of all members.

Public Types
typedef void	image
	Image associated type (with possible const qualification).
typedef void	rvalue
	Read-only value associated type.
typedef void	value
	Value associated type.
Public Member Functions
ima::qlf_value **	address_ () const
	Give a hook to the value address.
image &	ima () const
	Give the image of this generalized pixel.
rvalue	val () const
	Give the value of this generalized pixel.
Protected Member Functions
	Generalized_Pixel ()

---

Detailed Description

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

Documentation class for mln::Generalized_Pixel.

See also:

mln::Generalized_Pixel

Definition at line 45 of file doc/generalized_pixel.hh.

---

Member Typedef Documentation

template<typename E>

typedef void mln::doc::Generalized_Pixel< E >::image

Image associated type (with possible const qualification).

Definition at line 49 of file doc/generalized_pixel.hh.

template<typename E>

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

Read-only value associated type.

Definition at line 55 of file doc/generalized_pixel.hh.

template<typename E>

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

Value associated type.

Definition at line 52 of file doc/generalized_pixel.hh.

---

Constructor & Destructor Documentation

template<typename E>

mln::doc::Generalized_Pixel< E >::Generalized_Pixel

(

)

[protected]

---

Member Function Documentation

template<typename E>

ima ::qlf_value** mln::doc::Generalized_Pixel< E >::address_

(

)

const

Give a hook to the value address.

This method allows for iterators to refer to a generalized pixel.

Returns:

A pointer to the value address.

template<typename E>

image& mln::doc::Generalized_Pixel< E >::ima

(

)

const

Give the image of this generalized pixel.

The constness of a pixel object is not transmitted to the underlying image.

template<typename E>

rvalue mln::doc::Generalized_Pixel< E >::val

(

)

const

Give the value of this generalized pixel.

Returns:

A read-only value.

Reimplemented in mln::doc::Pixel_Iterator< E >.