AbstractImage is the base class for abstract image definition. More...
#include <AbstractImage.h>
Public Member Functions | |
Pixel informations | |
| virtual EPixelFormat | GetPixelFormat () const =0 |
| Retrieve pixel format. | |
| EPixelMode | GetPixelMode () const |
| Retrieve the pixel mode. | |
| EPixelType | GetPixelType () const |
| Retrieve the pixel type. | |
| EColorSpace | GetColorSpace () const |
| Retrieve the pixel color space. | |
| uint32 | GetChannelCount () const |
| Retrieve the number of channel. | |
| EResolution | GetResolution () const |
| Retrieve the image pixel samples resolution. | |
| uint32 | sizeofPixel () const |
| Retrieve the number of bytes per pixel. | |
| uint32 | GetBitsPerPixel () const |
| Retrieve the number of bits per pixel. | |
| bool | IsColor () const |
| Retrieve if image is composed by pixels in color mode. | |
| bool | IsGrey () const |
| Retrieve if image is composed by pixels in grey mode. | |
| bool | IsComplex () const |
| Retrieve if image is composed by pixels in complex mode. | |
| bool | HasAlpha () const |
| Retrieve if image has an alpha plane. | |
| bool | IsL () const |
| Retrieve if image is composed by L type pixels. | |
| bool | IsLA () const |
| Retrieve if image is composed by LA type pixels. | |
| bool | IsRGB () const |
| Retrieve if image is composed by RGB type pixels. | |
| bool | IsRGBA () const |
| Retrieve if image is composed by RGBA type pixels. | |
| bool | IsHLS () const |
| Retrieve if image is composed by HLS type pixels. | |
| bool | IsXYZ () const |
| Retrieve if image is composed by CIE XYZ type pixels. | |
| bool | IsLuv () const |
| Retrieve if image is composed by CIE Luv type pixels. | |
| bool | IsLab () const |
| Retrieve if image is composed by CIE Lab type pixels. | |
| bool | IsLch () const |
| Retrieve if image is composed by CIE Lch type pixels. | |
| bool | IsHLab () const |
| Retrieve if image is composed by Hunter Lab type pixels. | |
| 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 |
| Check image validity. | |
| uint32 | GetWidth () const |
| Retrieve image width in pixels. | |
| uint32 | GetHeight () const |
| Retrieve image height in pixels. | |
| uint32 | GetPixelCount () const |
| Compute the number of pixel. | |
| uint32 | GetSampleCount () const |
| Retrieve the number of samples for whole map. | |
| uint32 | sizeofMap () const |
| Retrieve the number of bytes for whole map. | |
Pixel iterators | |
| virtual boost::shared_ptr < IPixelIterator > | Begin ()=0 |
| Returns an iterator pointing to the beginning of the Pixel map. | |
| virtual boost::shared_ptr < IPixelIterator > | Begin () const =0 |
| Returns an const iterator pointing to the beginning of the Pixel map. | |
| virtual boost::shared_ptr < IPixelIterator > | End ()=0 |
| Returns an iterator pointing to the end of the Pixel map. | |
| virtual boost::shared_ptr < IPixelIterator > | End () const =0 |
| Returns an const iterator pointing to the end of the Pixel map. | |
Protected Attributes | |
| uint32 | _width |
| The image width in pixels. | |
| uint32 | _height |
| The image height in pixels. | |
Constructors, destructor and assignment | |
| AbstractImage (uint32 iWidth=0, uint32 iHeight=0) | |
| Default constructor can not be called directly as AbstractImage has pure virtual methods. | |
| AbstractImage (const AbstractImage &iImage) | |
| Copy constructor can not be called directly as AbstractImage has pure virtual methods. | |
| virtual | ~AbstractImage () |
| virtual destructor. | |
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()
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 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 >.
| uint32 eLynx::Image::AbstractImage::GetBitsPerPixel | ( | ) | const |
Retrieve the number of bits per pixel.
- Returns:
- The number of bits per pixel.
| uint32 eLynx::Image::AbstractImage::GetChannelCount | ( | ) | const |
Retrieve the number of channel.
- Returns:
- The pixel number of channel.
| EColorSpace eLynx::Image::AbstractImage::GetColorSpace | ( | ) | const |
Retrieve the pixel color space.
- Returns:
- The pixel color space, EColorSpace.
| 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.
| 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.
| EResolution eLynx::Image::AbstractImage::GetResolution | ( | ) | const |
Retrieve the image pixel samples resolution.
- Returns:
- The image pixel samples resolution.
| 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::GetWidth | ( | ) | const |
Retrieve image width in pixels.
- Returns:
- The image width in pixels.
| 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::IsColor | ( | ) | const |
Retrieve if image is composed by pixels in color mode.
- Returns:
- true if pixels mode is color.
| 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::IsGrey | ( | ) | const |
Retrieve if image is composed by pixels in grey mode.
- Returns:
- true if pixels mode is Grey.
| 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::IsHLS | ( | ) | const |
Retrieve if image is composed by HLS type pixels.
- Returns:
- true if pixels type is HLS, see EPixelType.
| 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::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::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::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.
| 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 >.
| 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.
| 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 >.
| uint32 eLynx::Image::AbstractImage::sizeofPixel | ( | ) | const |
Retrieve the number of bytes per pixel.
- Returns:
- The number of bytes per pixel.
The documentation for this class was generated from the following file:
- E:/dev/eLynx/include/elx/image/AbstractImage.h