CVD 0.8
Public Types | Public Member Functions | Protected Member Functions
CVD::BasicImage< T > Class Template Reference

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

#include <image.h>

Inheritance diagram for CVD::BasicImage< T >:
CVD::SubImage< T > CVD::Image< T > CVD::VideoFrame< T > CVD::LocalVideoFrame< T > CVD::V4L1Frame< T > CVD::V4L2FrameT< T > CVD::ColourspaceFrame< T > CVD::DeinterlaceFrame< T > CVD::DiskBuffer2Frame< T > CVD::ServerPushJpegFrame< T > CVD::VideoFileFrame< T >

List of all members.

Public Types

typedef T * iterator
typedef const T * const_iterator
typedef T value_type

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 ()

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:
TThe 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 480 of file image.h.


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 512 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 516 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:
dataThe image data in horizontal scanline order
sizeThe size of the image

Definition at line 486 of file image.h.

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

Copy constructor.

Parameters:
copyofThe image to copy

Definition at line 493 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 523 of file image.h.

Referenced by CVD::Image< GRADIENT >::copy_from(), CVD::dense_tensor_vote_gradients(), 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 526 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 530 of file image.h.

Referenced by CVD::Image< GRADIENT >::copy_from(), 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 533 of file image.h.


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