CVD::BasicImage< T > Class Template Reference
[Image storage and manipulation]

#include <image.h>

Inheritance diagram for CVD::BasicImage< T >:

List of all members.

---

Detailed Description

template<class T>
class CVD::BasicImage< T >

A generic image class to manage a block of data as an image.

Provides basic image access such as accessing a particular pixel co-ordinate.

Parameters:

T

The pixel type for this image. Typically either CVD::byte or CVD::Rgb<CVD::byte> > are used, but images could be constructed of any available type.

A BasicImage does not manage its own data, but provides access to an arbitrary externally-managed block of data as though it were an image. Use the derived Image class if you want an image which also has its own data.

Loading and saving, format conversion and some copying functionality is provided by external functions rather than as part of this class. See the Image loading and saving, and format conversion module for documentation of these functions.

Definition at line 497 of file image.h.

Public Types
typedef T *	iterator
typedef const T *	const_iterator
Public Member Functions
	BasicImage (T *data, const ImageRef &size)
	BasicImage (const BasicImage &copyof)
void	operator= (const BasicImage &copyof)
	~BasicImage ()
const_iterator	begin () const
iterator	begin ()
const_iterator	end () const
iterator	end ()
Protected Member Functions
	BasicImage ()

---

Member Typedef Documentation

template<class T>

typedef T* CVD::BasicImage< T >::iterator

A random-access iterator to read or write pixel values from the image.

This can be incremented, decremented and dereferenced. Incrementing this iterator steps through pixels in the usual scanline order.

Reimplemented from CVD::SubImage< T >.

Definition at line 529 of file image.h.

template<class T>

typedef const T* CVD::BasicImage< T >::const_iterator

A random-access iterator to read pixel values from the image.

This can be incremented, decremented and dereferenced. Incrementing this iterator steps through pixels in the usual scanline order.

Reimplemented from CVD::SubImage< T >.

Definition at line 533 of file image.h.

---

Constructor & Destructor Documentation

template<class T>

CVD::BasicImage< T >::BasicImage	(	T *	data,
		const ImageRef &	size
	)			[inline]

Construct an image from a block of data.

Parameters:

	data	The image data in horizontal scanline order
	size	The size of the image

Definition at line 503 of file image.h.

template<class T>

CVD::BasicImage< T >::BasicImage

(

const BasicImage< T > &

copyof

)

[inline]

Copy constructor.

Parameters:

copyof

The image to copy

Definition at line 510 of file image.h.

template<class T>

CVD::BasicImage< T >::~BasicImage

(

)

[inline]

The image data is not destroyed when a BasicImage is destroyed.

Definition at line 523 of file image.h.

template<class T>

CVD::BasicImage< T >::BasicImage

(

)

[inline, protected]

The default constructor does nothing.

Definition at line 553 of file image.h.

---

Member Function Documentation

template<class T>

const_iterator CVD::BasicImage< T >::begin

(

)

const [inline]

Returns a const iterator referencing the first (top-left) pixel in the image.

Reimplemented from CVD::SubImage< T >.

Definition at line 537 of file image.h.

Referenced by CVD::Image< CVD::Rgb< unsigned char > >::copy_from(), CVD::Gradient< S, T, 1, 2 >::gradient(), and CVD::threshold().

template<class T>

iterator CVD::BasicImage< T >::begin

(

)

[inline]

Returns an iterator referencing the first (top-left) pixel in the image.

Reimplemented from CVD::SubImage< T >.

Definition at line 540 of file image.h.

template<class T>

const_iterator CVD::BasicImage< T >::end

(

)

const [inline]

Returns a const iterator referencing the pixel immediately after the last (bottom-right) pixel in the image.

Reimplemented from CVD::SubImage< T >.

Definition at line 544 of file image.h.

Referenced by CVD::Image< CVD::Rgb< unsigned char > >::copy_from(), CVD::Gradient< S, T, 1, 2 >::gradient(), and CVD::threshold().

template<class T>

iterator CVD::BasicImage< T >::end

(

)

[inline]

Returns an iterator referencing the pixel immediately after the last (bottom-right) pixel in the image.

Reimplemented from CVD::SubImage< T >.

Definition at line 547 of file image.h.

---

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

• cvd/image.h

---