ImageBMPFileInfoC -

Developer Documentation

Centre for Vision, Speech & Signal Processing

Comments:
------------------------------------------------------------------------ *** ImageBMPFileInfoC ********************************************** ------------------------------------------------------------------------

Parent Classes:

ImageFileInfoC

Variables:

BitmapFileHeaderT iBmpHead;
BitmapInfoHeaderT iBmpInfoHeader;
IntT colorNumber;: the number of colors in the palette
IntT dummyRest;: the size of dummy part
RgbQuadT * palette;: the original palette
char * dummy;: dummy part after palette
PixelC luPxl;: left upper corner of the image
PixelC rdPxl;: right down corner of the image
ImageFileFormatT fFormat;: the image file format
IntT maxLevel;: the maximum level in the image

Methods:

ImageBMPFileInfoC(istream & s): the image is created from the stream
ImageBMPFileInfoC(const ImageBMPFileInfoC & info): Copy constructor.
ImageFileInfoC * ACopy() const: Create an abstract copy of this object.
GreyLevelsT Levels() const: get number of grey levels in the image
PixelIndexT Rnum() const: get number of rows
PixelIndexT Cnum() const: get number of columns
PixelC LUCorner() const: left upper corner of the image
PixelC RDCorner() const: right down corner of the image
ImageRectangleC Rectangle() const: Return the image rectangle
ImageFileFormatT Format() const: get image file format
ImageFileDataFormatT DataFormat() const: get format of data stored in the image file
void SetSize(const ImageRectangleC & rect): Set the new size of the image.
void ReadData(ByteGreyValueT ** rows,const ImageRectangleC & rect,ImageIStreamC & inS,BooleanT oneBlock) const: Read grey data from the stream 'inS' and put them into the memory organized according 'rows' and 'rect'.
void ReadData(ByteRGBValueC ** rows,const ImageRectangleC & rect,ImageIStreamC & inS,BooleanT oneBlock) const: Read RGB data from the stream 'inS' and put them into the memory organized according 'rows' and 'rect'.
void WriteData(ByteGreyValueT ** rows,const ImageRectangleC & rect,ImageOStreamC & outS,BooleanT oneBlock) const: Write grey data into the stream 'outS' from the memory organized according 'rows' and 'rect'.
void WriteData(ByteRGBValueC ** rows,const ImageRectangleC & rect,ImageOStreamC & outS,BooleanT oneBlock) const: Read RGB data from the stream 'outS' from the memory organized according 'rows' and 'rect'.
void PrintInfo(ostream & os) const: print the header information into the stream 'os'
void WriteHead(ImageOStreamC & outS) const
~ImageBMPFileInfoC(): destructor
IntT PaletteSize() const: Return the size of the palette.
const RgbQuadT * Palette() const: Return the palette of the image if any.
void ReadData(RGBPointC ** rows,const ImageRectangleC & rect,ImageIStreamC & inS,BooleanT oneBlock) const: This function should not be used because the format is not defined for BMP files.
void ReadData(ByteYUVValueC ** rows,const ImageRectangleC & rect,ImageIStreamC & inS,BooleanT oneBlock) const: This function should not be used because the format is not defined for BMP files.
void ReadData(YUVPointC ** rows,const ImageRectangleC & rect,ImageIStreamC & inS,BooleanT oneBlock) const: This function should not be used because the format is not defined for BMP files.
void WriteData(RGBPointC ** rows,const ImageRectangleC & rect,ImageOStreamC & outS,BooleanT oneBlock) const: This function should not be used because the format is not defined for BMP files.
void WriteData(ByteYUVValueC ** rows,const ImageRectangleC & rect,ImageOStreamC & outS,BooleanT oneBlock) const: This function should not be used because the format is not defined for BMP files.
void WriteData(YUVPointC ** rows,const ImageRectangleC & rect,ImageOStreamC & outS,BooleanT oneBlock) const: This function should not be used because the format is not defined for BMP files.

#include "amma/ImgFileI.hh"

ImageFileInfoC * ACopy() const: Creates an abstract copy of this object.
GreyLevelsT Levels() const: Gets number of grey levels in the image.
PixelIndexT Rnum() const: Gets number of rows.
PixelIndexT Cnum() const: Gets number of columns.
PixelC LUCorner() const: Returns the left upper corner of the image.
PixelC RDCorner() const: Returns the right down corner of the image.
ImageRectangleC Rectangle() const: Returns the rectangle of the image.
ImageFileFormatT Format() const: Gets image file format.
ImageFileDataFormatT DataFormat() const: Gets format of data stored in the image file
void SetSize(const ImageRectangleC & rect): Sets the new size of the image.
void WriteHead(ImageOStreamC & outS) const: Writes the header of file according the information stored in this object.
void ReadData(ByteGreyValueT ** rows,const ImageRectangleC & rect,ImageIStreamC & inS,BooleanT oneBlock) const: Reads grey data from the stream 'inS' and put them into the memory organized according 'rows' and 'rect'.The memory pointed by 'rows' is allocated as one block if 'oneBlock' is set TRUE.
void ReadData(ByteRGBValueC ** rows,const ImageRectangleC & rect,ImageIStreamC & inS,BooleanT oneBlock) const: Reads RGB data from the stream 'inS' and put them into the memory organized according 'rows' and 'rect'.The memory pointed by 'rows' is allocated as one block if 'oneBlock' is set TRUE.
void ReadData(RGBPointC ** rows,const ImageRectangleC & rect,ImageIStreamC & inS,BooleanT oneBlock) const: Reads RGB data from the stream 'inS' and put them into the memory organized according 'rows' and 'rect'.The memory pointed by 'rows' is allocated as one block if 'oneBlock' is set TRUE. The image file must contain RealFT (see StdType.hh) according to the machine architecture on which the function is running.
void ReadData(ByteYUVValueC ** rows,const ImageRectangleC & rect,ImageIStreamC & inS,BooleanT oneBlock) const: Reads YUV data from the stream 'inS' and put them into the memory organized according 'rows' and 'rect'. The memory pointed by 'rows' is allocated as one block if 'oneBlock' is set TRUE.
void ReadData(YUVPointC ** rows,const ImageRectangleC & rect,ImageIStreamC & inS,BooleanT oneBlock) const: Reads YUV data from the stream 'inS' and put them into the memory organized according 'rows' and 'rect'.The memory pointed by 'rows' is allocated as one block if 'oneBlock' is set TRUE. The image file must contain RealFT (see StdType.hh) according to the machine architecture on which the function is running.
void WriteData(ByteGreyValueT ** rows,const ImageRectangleC & rect,ImageOStreamC & outS,BooleanT oneBlock) const: Writes grey data into the stream 'outS' from the memory organized according 'rows' and 'rect'. The memory pointed by 'rows' is allocated as one block if 'oneBlock' is set TRUE.
void WriteData(ByteRGBValueC ** rows,const ImageRectangleC & rect,ImageOStreamC & outS,BooleanT oneBlock) const: Writes RGB data into the stream 'outS' from the memory organized according 'rows' and 'rect'. The memory pointed by 'rows' is allocated as one block if 'oneBlock' is set TRUE.
void WriteData(RGBPointC ** rows,const ImageRectangleC & rect,ImageOStreamC & outS,BooleanT oneBlock) const: Writes RGB data into the stream 'outS' from the memory organized according 'rows' and 'rect'. The memory pointed by 'rows' is allocated as one block if 'oneBlock' is set TRUE. The values of the image are stored as RealFT (see StdType.hh) according to the machine architecture.
void WriteData(ByteYUVValueC ** rows,const ImageRectangleC & rect,ImageOStreamC & outS,BooleanT oneBlock) const: Writes YUV data into the stream 'outS' from the memory organized according 'rows' and 'rect'. The memory pointed by 'rows' is allocated as one block if 'oneBlock' is set TRUE.
void WriteData(YUVPointC ** rows,const ImageRectangleC & rect,ImageOStreamC & outS,BooleanT oneBlock) const: Writes YUV data into the stream 'outS' from the memory organized according 'rows' and 'rect'. The memory pointed by 'rows' is allocated as one block if 'oneBlock' is set TRUE. The values of the image are stored as RealFT (see StdType.hh) according to the machine architecture.
void PrintInfo(ostream & os) const: Prints the header information into the stream 'os'
const ImageFileInfoC * GetRealInfo() const: Returns the pointer to the base class part of the real object.

Programmer:Radek Marik, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001

ImageBMPFileInfoC

include	"amma/ImgBMPi.hh"
User Level:	Default
Library:	Mimage
Example:	doNumClassComb.cc
Section:	Obsolete
In Scope:	std