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

#include <image.h>

Inheritance diagram for CVD::BasicImage< T >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef const T * const_iterator
typedef T * iterator

Public Member Functions

 BasicImage (const BasicImage &copyof)
 BasicImage (T *data, const ImageRef &size)
iterator begin ()
const_iterator begin () const
iterator end ()
const_iterator end () const
void operator= (const BasicImage &copyof)
 ~BasicImage ()
 The image data is not destroyed when a BasicImage is destroyed.

Protected Member Functions

 BasicImage ()
 The default constructor does nothing.

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 475 of file image.h.


Member Typedef Documentation

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 511 of file image.h.

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 507 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 481 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 488 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 501 of file image.h.

template<class T>
CVD::BasicImage< T >::BasicImage (  )  [inline, protected]

The default constructor does nothing.

Definition at line 531 of file image.h.


Member Function Documentation

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 518 of file image.h.

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 515 of file image.h.

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 525 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 522 of file image.h.

template<class T>
void CVD::BasicImage< T >::operator= ( const BasicImage< T > &  copyof  )  [inline]

Definition at line 493 of file image.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


libcvd
Author(s): Edward Rosten, Paul Smith, Tom Drummond, Gerhard Reitmayr, Ethan Eade, Timothy Gan, Chris Kemp, Georg Klein
autogenerated on Fri Jan 11 09:13:50 2013