eLynx::Image::AbstractImage Class Reference

#include <AbstractImage.h>

Inheritance diagram for eLynx::Image::AbstractImage:

List of all members.

Public Member Functions
Pixel informations
virtual EPixelFormat	GetPixelFormat () const =0
EPixelMode	GetPixelMode () const
EPixelType	GetPixelType () const
EColorSpace	GetColorSpace () const
uint32	GetChannelCount () const
EResolution	GetResolution () const
uint32	sizeofPixel () const
uint32	GetBitsPerPixel () const
bool	IsColor () const
bool	IsGrey () const
bool	IsComplex () const
bool	HasAlpha () const
bool	IsL () const
bool	IsLA () const
bool	IsRGB () const
bool	IsRGBA () const
bool	IsHLS () const
bool	IsXYZ () const
bool	IsLuv () const
bool	IsLab () const
bool	IsLch () const
bool	IsHLab () const
bool	IsMasking (uint32 iChannelMask) const
bool	IsUInt8 () const
bool	IsUInt16 () const
bool	IsInt32 () const
bool	IsFloat () const
bool	IsDouble () const
bool	IsLub () const
bool	IsLus () const
bool	IsLi () const
bool	IsLf () const
bool	IsLd () const
bool	IsLAub () const
bool	IsLAus () const
bool	IsLAi () const
bool	IsLAf () const
bool	IsLAd () const
bool	IsComplexi () const
bool	IsComplexf () const
bool	IsComplexd () const
bool	IsRGBub () const
bool	IsRGBus () const
bool	IsRGBi () const
bool	IsRGBf () const
bool	IsRGBd () const
bool	IsRGBAub () const
bool	IsRGBAus () const
bool	IsRGBAi () const
bool	IsRGBAf () const
bool	IsRGBAd () const
bool	IsHLSf () const
bool	IsHLSd () const
bool	IsXYZf () const
bool	IsXYZd () const
bool	IsLuvf () const
bool	IsLuvd () const
bool	IsLabf () const
bool	IsLabd () const
bool	IsLchf () const
bool	IsLchd () const
bool	IsHLabf () const
bool	IsHLabd () const
Image informations
virtual bool	IsValid () const
uint32	GetWidth () const
uint32	GetHeight () const
uint32	GetPixelCount () const
uint32	GetSampleCount () const
uint32	sizeofMap () const
Pixel iterators
virtual boost::shared_ptr < IPixelIterator >	Begin ()=0
virtual boost::shared_ptr < IPixelIterator >	Begin () const =0
virtual boost::shared_ptr < IPixelIterator >	End ()=0
virtual boost::shared_ptr < IPixelIterator >	End () const =0
Protected Attributes
uint32	_Width
uint32	_Height
Constructors, destructor and assignment
	AbstractImage (uint32 iWidth=0, uint32 iHeight=0)
	AbstractImage (const AbstractImage &iImage)
virtual	~AbstractImage ()

---

Detailed Description

AbstractImage is the base class for abstract image definition. AbstractImage is an unspecialized image, and cannot be instanciate. Only specializations (by derivation) can be instanciate. This class allows to use image object where pixel format is known at runtime.
An abstract image implementation is defined by :

• a width in pixels _Width
• a height in pixels _Height
• a pixel format GetPixelFormat()
• a pixel iterators to access an array[width x height] of typed pixels Begin(), End()

Definition at line 43 of file AbstractImage.h.

---

Constructor & Destructor Documentation

eLynx::Image::AbstractImage::AbstractImage	(	uint32	iWidth = 0,
		uint32	iHeight = 0
	)			[protected]

Default constructor can not be called directly as AbstractImage has pure virtual methods. Must be call by implementations.

Parameters:

	iWidth	The image width in pixels.
	iHeight	The image height in pixels.

eLynx::Image::AbstractImage::AbstractImage

(

const AbstractImage &

iImage

)

[protected]

Copy constructor can not be called directly as AbstractImage has pure virtual methods. Must be call by implementations.

Parameters:

iImage

The image to copy.

virtual eLynx::Image::AbstractImage::~AbstractImage

(

)

[virtual]

virtual destructor. A must to cleanly delete object.

---

Member Function Documentation

virtual EPixelFormat eLynx::Image::AbstractImage::GetPixelFormat

(

)

const [pure virtual]

Retrieve pixel format.

Returns:

The pixel format of the image, EPixelFormat.

Implemented in eLynx::Image::ImageImpl< Pixel >.

EPixelMode eLynx::Image::AbstractImage::GetPixelMode

(

)

const

Retrieve the pixel mode.

Returns:

The pixel mode, EPixelMode.

EPixelType eLynx::Image::AbstractImage::GetPixelType

(

)

const

Retrieve the pixel type.

Returns:

The pixel type, EPixelType.

EColorSpace eLynx::Image::AbstractImage::GetColorSpace

(

)

const

Retrieve the pixel color space.

Returns:

The pixel color space, EColorSpace.

uint32 eLynx::Image::AbstractImage::GetChannelCount

(

)

const

Retrieve the number of channel.

Returns:

The pixel number of channel.

EResolution eLynx::Image::AbstractImage::GetResolution

(

)

const

Retrieve the image pixel samples resolution.

Returns:

The image pixel samples resolution.

uint32 eLynx::Image::AbstractImage::sizeofPixel

(

)

const

Retrieve the number of bytes per pixel.

Returns:

The number of bytes per pixel.

uint32 eLynx::Image::AbstractImage::GetBitsPerPixel

(

)

const

Retrieve the number of bits per pixel.

Returns:

The number of bits per pixel.

bool eLynx::Image::AbstractImage::IsColor

(

)

const

Retrieve if image is composed by pixels in color mode.

Returns:

true if pixels mode is color.

bool eLynx::Image::AbstractImage::IsGrey

(

)

const

Retrieve if image is composed by pixels in grey mode.

Returns:

true if pixels mode is Grey.

bool eLynx::Image::AbstractImage::IsComplex

(

)

const

Retrieve if image is composed by pixels in complex mode.

Returns:

true if pixels mode is complex.

bool eLynx::Image::AbstractImage::HasAlpha

(

)

const

Retrieve if image has an alpha plane.

Returns:

true if image type is LA or RGBA, false otherwise.

bool eLynx::Image::AbstractImage::IsL

(

)

const

Retrieve if image is composed by L type pixels.

Returns:

true if pixels type is L, see EPixelType.

bool eLynx::Image::AbstractImage::IsLA

(

)

const

Retrieve if image is composed by LA type pixels.

Returns:

true if pixels type is LA, see EPixelType.

bool eLynx::Image::AbstractImage::IsRGB

(

)

const

Retrieve if image is composed by RGB type pixels.

Returns:

true if pixels type is RGB, see EPixelType.

bool eLynx::Image::AbstractImage::IsRGBA

(

)

const

Retrieve if image is composed by RGBA type pixels.

Returns:

true if pixels type is RGBA, see EPixelType.

bool eLynx::Image::AbstractImage::IsHLS

(

)

const

Retrieve if image is composed by HLS type pixels.

Returns:

true if pixels type is HLS, see EPixelType.

bool eLynx::Image::AbstractImage::IsXYZ

(

)

const

Retrieve if image is composed by CIE XYZ type pixels.

Returns:

true if pixels type is XYZ, see EPixelType.

bool eLynx::Image::AbstractImage::IsLuv

(

)

const

Retrieve if image is composed by CIE Luv type pixels.

Returns:

true if pixels type is Luv, see EPixelType.

bool eLynx::Image::AbstractImage::IsLab

(

)

const

Retrieve if image is composed by CIE Lab type pixels.

Returns:

true if pixels type is CIE Lab, see EPixelType.

bool eLynx::Image::AbstractImage::IsLch

(

)

const

Retrieve if image is composed by CIE Lch type pixels.

Returns:

true if pixels type is Lab, see EPixelType.

bool eLynx::Image::AbstractImage::IsHLab

(

)

const

Retrieve if image is composed by Hunter Lab type pixels.

Returns:

true if pixels type is Hunter Lab, see EPixelType.

bool eLynx::Image::AbstractImage::IsMasking

(

uint32

iChannelMask

)

const

bool eLynx::Image::AbstractImage::IsUInt8

(

)

const

bool eLynx::Image::AbstractImage::IsUInt16

(

)

const

bool eLynx::Image::AbstractImage::IsInt32

(

)

const

bool eLynx::Image::AbstractImage::IsFloat

(

)

const

bool eLynx::Image::AbstractImage::IsDouble

(

)

const

bool eLynx::Image::AbstractImage::IsLub

(

)

const

bool eLynx::Image::AbstractImage::IsLus

(

)

const

bool eLynx::Image::AbstractImage::IsLi

(

)

const

bool eLynx::Image::AbstractImage::IsLf

(

)

const

bool eLynx::Image::AbstractImage::IsLd

(

)

const

bool eLynx::Image::AbstractImage::IsLAub

(

)

const

bool eLynx::Image::AbstractImage::IsLAus

(

)

const

bool eLynx::Image::AbstractImage::IsLAi

(

)

const

bool eLynx::Image::AbstractImage::IsLAf

(

)

const

bool eLynx::Image::AbstractImage::IsLAd

(

)

const

bool eLynx::Image::AbstractImage::IsComplexi

(

)

const

bool eLynx::Image::AbstractImage::IsComplexf

(

)

const

bool eLynx::Image::AbstractImage::IsComplexd

(

)

const

bool eLynx::Image::AbstractImage::IsRGBub

(

)

const

bool eLynx::Image::AbstractImage::IsRGBus

(

)

const

bool eLynx::Image::AbstractImage::IsRGBi

(

)

const

bool eLynx::Image::AbstractImage::IsRGBf

(

)

const

bool eLynx::Image::AbstractImage::IsRGBd

(

)

const

bool eLynx::Image::AbstractImage::IsRGBAub

(

)

const

bool eLynx::Image::AbstractImage::IsRGBAus

(

)

const

bool eLynx::Image::AbstractImage::IsRGBAi

(

)

const

bool eLynx::Image::AbstractImage::IsRGBAf

(

)

const

bool eLynx::Image::AbstractImage::IsRGBAd

(

)

const

bool eLynx::Image::AbstractImage::IsHLSf

(

)

const

bool eLynx::Image::AbstractImage::IsHLSd

(

)

const

bool eLynx::Image::AbstractImage::IsXYZf

(

)

const

bool eLynx::Image::AbstractImage::IsXYZd

(

)

const

bool eLynx::Image::AbstractImage::IsLuvf

(

)

const

bool eLynx::Image::AbstractImage::IsLuvd

(

)

const

bool eLynx::Image::AbstractImage::IsLabf

(

)

const

bool eLynx::Image::AbstractImage::IsLabd

(

)

const

bool eLynx::Image::AbstractImage::IsLchf

(

)

const

bool eLynx::Image::AbstractImage::IsLchd

(

)

const

bool eLynx::Image::AbstractImage::IsHLabf

(

)

const

bool eLynx::Image::AbstractImage::IsHLabd

(

)

const

virtual bool eLynx::Image::AbstractImage::IsValid

(

)

const [virtual]

Check image validity.

Returns:

return true if Image is valid, false otherwise.

Reimplemented in eLynx::Image::ImageImpl< Pixel >.

uint32 eLynx::Image::AbstractImage::GetWidth

(

)

const

Retrieve image width in pixels.

Returns:

The image width in pixels.

uint32 eLynx::Image::AbstractImage::GetHeight

(

)

const

Retrieve image height in pixels.

Returns:

The image height in pixels.

uint32 eLynx::Image::AbstractImage::GetPixelCount

(

)

const

Compute the number of pixel.

Returns:

The number of pixels in image.

uint32 eLynx::Image::AbstractImage::GetSampleCount

(

)

const

Retrieve the number of samples for whole map.

Returns:

The the number of samples for whole map.

uint32 eLynx::Image::AbstractImage::sizeofMap

(

)

const

Retrieve the number of bytes for whole map.

Returns:

The number of bytes for whole map.

Reimplemented in eLynx::Image::ImageImpl< Pixel >.

virtual boost::shared_ptr<IPixelIterator> eLynx::Image::AbstractImage::Begin

(

)

[pure virtual]

Returns an iterator pointing to the beginning of the Pixel map

Returns:

an iterator pointing to the beginning of the Pixel map

Implemented in eLynx::Image::ImageImpl< Pixel >.

virtual boost::shared_ptr<IPixelIterator> eLynx::Image::AbstractImage::Begin

(

)

const [pure virtual]

Returns an const iterator pointing to the beginning of the Pixel map

Returns:

an const iterator pointing to the beginning of the Pixel map

Implemented in eLynx::Image::ImageImpl< Pixel >.

virtual boost::shared_ptr<IPixelIterator> eLynx::Image::AbstractImage::End

(

)

[pure virtual]

Returns an iterator pointing to the end of the Pixel map

Returns:

an iterator pointing to the end of the Pixel map

Implemented in eLynx::Image::ImageImpl< Pixel >.

virtual boost::shared_ptr<IPixelIterator> eLynx::Image::AbstractImage::End

(

)

const [pure virtual]

Returns an const iterator pointing to the end of the Pixel map

Returns:

an const iterator pointing to the end of the Pixel map

Implemented in eLynx::Image::ImageImpl< Pixel >.

---

Member Data Documentation

uint32 eLynx::Image::AbstractImage::_Width [protected]

The image width in pixels.

Definition at line 263 of file AbstractImage.h.

uint32 eLynx::Image::AbstractImage::_Height [protected]

The image height in pixels.

Definition at line 266 of file AbstractImage.h.

---

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

• AbstractImage.h