puma2::MultiElementImage< T, N > Class Template Reference

N-channel image template. More...

#include <MultiElementImage.h>

Inheritance diagram for puma2::MultiElementImage< T, N >:

List of all members.

Public Types
typedef MultiElementImageIterChannel < T, N >	ChannelIterator
typedef T	ElementType
typedef MultiElementImageIter < T, N >	PixelIterator
typedef MultiElementPixel< T, N >	PixelType
	element type, type of samples a pixel is composed of
Public Member Functions
MultiElementImageIter< T, N >	begin ()
	initialize iterator to start of image data - will point to pixels
MultiElementImageIterChannel < T, N >	begin (int n)
	initialize iterator to start of image data - will point to channel
MultiElementImageIter< T, N >	end ()
	initialize iterator to end of image data - will point to pixels (multi-channel)
MultiElementImageIterChannel < T, N >	end (int n)
	initialize iterator to end of image data - will point to channel
	MultiElementImage (int width=0, int height=0)
	MultiElementImage (int width, int height, MultiElementImage *master, int xOffset, int yOffset)
	subimage constructor
const ElementType	sample (int x, int y, int n) const
ElementType &	sample (int x, int y, int n)
Static Public Member Functions
static int	numberOfChannels ()
	pixel type
Friends
class	MultiElementImageIter< T, N >
class	MultiElementImageIterChannel< T, N >

---

Detailed Description

template<class T, int N>
class puma2::MultiElementImage< T, N >

N-channel image template.

(detailed descripton forthcomming)

See also:

TBaseImg

Author:

Dietrich Paulus <paulus@uni-koblenz.de>

Date:

January 2007

Definition at line 50 of file MultiElementImage.h.

---

Member Typedef Documentation

template<class T, int N>

typedef MultiElementImageIterChannel<T, N> puma2::MultiElementImage< T, N >::ChannelIterator

Definition at line 111 of file MultiElementImage.h.

template<class T, int N>

typedef T puma2::MultiElementImage< T, N >::ElementType

Definition at line 55 of file MultiElementImage.h.

template<class T, int N>

typedef MultiElementImageIter<T, N> puma2::MultiElementImage< T, N >::PixelIterator

Definition at line 110 of file MultiElementImage.h.

template<class T, int N>

typedef MultiElementPixel< T, N > puma2::MultiElementImage< T, N >::PixelType

element type, type of samples a pixel is composed of

Definition at line 56 of file MultiElementImage.h.

---

Constructor & Destructor Documentation

template<class T, int N>

puma2::MultiElementImage< T, N >::MultiElementImage	(	int	width = 0,
		int	height = 0
	)		[inline]

Definition at line 59 of file MultiElementImage.h.

template<class T, int N>

puma2::MultiElementImage< T, N >::MultiElementImage	(	int	width,
		int	height,
		MultiElementImage< T, N > *	master,
		int	xOffset,
		int	yOffset
	)		[inline]

subimage constructor

Definition at line 61 of file MultiElementImage.h.

---

Member Function Documentation

template<class T, int N>

MultiElementImageIter<T, N> puma2::MultiElementImage< T, N >::begin

(

)

[inline]

initialize iterator to start of image data - will point to pixels

Definition at line 73 of file MultiElementImage.h.

template<class T, int N>

MultiElementImageIterChannel<T, N> puma2::MultiElementImage< T, N >::begin

(

int

n

)

[inline]

initialize iterator to start of image data - will point to channel

Parameters:

n

Definition at line 82 of file MultiElementImage.h.

template<class T, int N>

MultiElementImageIter<T, N> puma2::MultiElementImage< T, N >::end

(

)

[inline]

initialize iterator to end of image data - will point to pixels (multi-channel)

Definition at line 92 of file MultiElementImage.h.

template<class T, int N>

MultiElementImageIterChannel<T, N> puma2::MultiElementImage< T, N >::end

(

int

n

)

[inline]

initialize iterator to end of image data - will point to channel

Parameters:

n

Definition at line 101 of file MultiElementImage.h.

template<class T, int N>

static int puma2::MultiElementImage< T, N >::numberOfChannels

(

)

[inline, static]

pixel type

Definition at line 58 of file MultiElementImage.h.

template<class T, int N>

const ElementType puma2::MultiElementImage< T, N >::sample	(	int	x,
		int	y,
		int	n
	)		const [inline]

Definition at line 63 of file MultiElementImage.h.

template<class T, int N>

ElementType& puma2::MultiElementImage< T, N >::sample	(	int	x,
		int	y,
		int	n
	)		[inline]

Definition at line 67 of file MultiElementImage.h.

---

Friends And Related Function Documentation

template<class T, int N>

friend class MultiElementImageIter< T, N > [friend]

Definition at line 52 of file MultiElementImage.h.

template<class T, int N>

friend class MultiElementImageIterChannel< T, N > [friend]

Definition at line 53 of file MultiElementImage.h.

---

The documentation for this class was generated from the following file:

• MultiElementImage.h