RealRGBImageC - The class RealRGBImageC represents colour image with colour represented by a triple of real RGB components.

User Documentation

Centre for Vision, Speech & Signal Processing

Parent Classes:

ImageC

Derived Classes:

RealRGBImageCnvC

Methods:

RealRGBImageC(): Creates an empty image.
RealRGBImageC(ImageIStreamC & inS): Creates an image from the input stream.
RealRGBImageC(ImageFileInfoC * info,ImageIStreamC & inS): Creates an image from the information stored in 'info' and from data stored in the image stream 'inS'.
RealRGBImageC(SizeT rows,SizeT columns): Creates a new image.
RealRGBImageC(SizeT rows,SizeT columns,RGBPointC * rgb): Creates a new image from a memory location.
RealRGBImageC(const ImageRectangleC & rect): Creates a new image.
RealRGBImageC(const RealRGBImageC & image,const ImageRectangleC & rect): Subimage.
RealRGBImageC(const RealRGBImageC & image): A new handle for the image.
RealRGBImageC(const ByteImageC & redIm,const ByteImageC & greenIm,const ByteImageC & blueIm): Creates the RGB image from three component channel images.
RealRGBImageC(const DoubleImageC & redIm,const DoubleImageC & greenIm,const DoubleImageC & blueIm): Creates the RGB image from three component channel images.
RealRGBImageC(const RGBImageC & rgb): Creates the RGB image from the byte RGB image.
RealRGBImageC(const YUVImageC & yuv): Creates the RGB image from YUV image.
RealRGBImageC(const RealYUVImageC & yuv): Creates the RGB image from the real YUV image.
RealRGBImageC(const XYZPolynomialC & pol,const ImageRectangleC & polRect,const ImageRectangleC & rect): Generate a real RGB image of the size determined by the image image rectangle 'rect'. The values are defined by the three 2D algebraic polynomial 'pol' which was determined on the domain 'polRect'.
RealRGBImageC(const Point3ImageC & image): The image is treated as an image of RGB values and it is converted into real RGB values.
RealRGBImageC(const ImageC<RGBPointC> & image): A new identifier for the image
RealRGBImageC Copy() const: A physical copy of image.
ImageAC * ACopy() const: A physical copy of this image.
ImageAC * AnotherImage() const: Creates a new empty image of the same type and size as this image is. Conversions between color images. ---------------------------------
ByteImageC Y() const: Returns the byte grey level image of Y component.
ByteImageC Red() const: Returns the byte red component of the color image.
ByteImageC Green() const: Returns the byte green component of the color image.
ByteImageC Blue() const: Returns the byte blue component of the color image.
DoubleImageC & RealY(DoubleImageC & image) const: Copies the Y component into the 'image' and returns the result.
DoubleImageC RealY() const: Returns the grey level image of Y component.
DoubleImageC RealRed() const: Returns the red component of the color image.
DoubleImageC RealGreen() const: Returns the green component of the color image.
DoubleImageC RealBlue() const: Returns the blue component of the color image.
RGBImageC Rgb() const: Converts the image into the image of byte colors in RGB space..
RealRGBImageC RealRgb() const: Creates a new handle for the image.
YUVImageC Yuv() const: Converts the image into the image of colors in YUV space.
RealYUVImageC RealYuv() const: Converts the image into the image of colors in real YUV color space. Geometric operations --------------------
RealRGBImageC ReduceAverage() const: Generates the new image which has half ranges of indexes. The new pixel values are averages of old ones.
RealRGBImageC ReduceSample() const: Generates the new image which has half ranges of indexes. The new pixel values are samples of old ones.
RealRGBImageC Rotate(const Point2dC & center,RealT angle,RGBPointC background) const: Rotates the image around the 'center' about the 'angle'. The values of the new image which are not defined have value 'background'. Colour operations -----------------
RealRGBImageC & Palette(): Color palette image.
const RealRGBImageC & operator/=(const RealT alpha): Divides every color components by 'alpha' in each pixel.
const RealRGBImageC & operator+=(const RealRGBImageC & image): Adds color components of the image to the related color components in each pixel of this image.
const RealRGBImageC & operator+=(const RGBImageC & image): Adds color components of the image to the related color components in each pixel of this image.
const RealRGBImageC & operator/=(const RealRGBImageC & image): Divides pixel by pixel and color component by color component in each pixel.
RGBImageC ScaleToRGBImage(const RGBPointC & min,const RGBPointC & max) const: Converts this image into the RGBImageC. The real RGB values are linearly scaled that 'min' values are related to the BLACK value and 'max' values are related to the WHITE value. The result values are cut. Colour statistics -----------------
MinMaxMeanCovariance3dC ExMeCo() const: Returns minima, maxima, mean values, and covariance matrix of RGB value in the image.
ByteImageC RGBChromaticityDiagram(const IndexT resolution) const: Returns the chromaticity diagram with the specific 'resolution using chromaticity derived from RGB values.
ByteImageC XYZChromaticityDiagram(const IndexT resolution) const: Returns the chromaticity diagram with the specific 'resolution using chromaticity derived from XYZ values. Input/Output operations -----------------------
void SaveAs(ImageOStreamC & outS,ImageFileFormatT format = ARY_RGB_R8): Write the image into the output image stream. The format of the data in the stream is determined by 'format'.

#include "amma/Image.hh"

ImageC<RGBPointC> Copy() const: Creates another physical copy of this image.
void Copy(const ImageC<RGBPointC> & image): Copies the contents of image "img" into this image.
void Copy(const ImageRectangleC & rect,const PixelC & newOrigin): Copies the region of the image defined by rectangle "rect" into the region whose origin is "newOrigin".
ImageAC * ACopy() const: A physical copy of this image.
ImageAC * AnotherImage() const: Creates a new empty image of the same type and size as this image is.
const ImageC<RGBPointC> & operator=(const ImageC<RGBPointC> & image): Assigment of a big object.
void ReflectUp(const ImageRectangleC & rect): Mirrors the image rectangle along its top edge.
void ReflectDown(const ImageRectangleC & rect): Mirrors the image rectangle along its bottom edge.
void ReflectLeft(const ImageRectangleC & rect): Mirrors the image rectangle along its left edge.
void ReflectRight(const ImageRectangleC & rect): Mirrors the image rectangle along its right edge.
void ReflectFrom(const ImageRectangleC & rect): Mirrors the image rectangle "rect" along its sides to fill the whole image.
void Rotate90(const ImageC<RGBPointC> & originalImage): The values of image "originalImage" rotated about PI/2 rad and shifted to have the original upper-left corner and are saved into this image.
void Rotate180(const ImageC<RGBPointC> & originalImage): The values of image "originalImage" rotated about PI rad and shifted to have the original upper-left corner and are saved into this image.
void Rotate270(const ImageC<RGBPointC> & originalImage): The values of image "originalImage" rotated about 3/2*PI rad and shifted to have the original upper-left corner and are saved into this image.
ImageC<RGBPointC> Rotate(const Point2dC & center,RealT angle,RGBPointC background) const: The values of this image are rotated about "angle" (in rad) and saved to the result image.
Note the AMMA convention that the 1st or "x" coordinate of Point2dC is associated with the image row no., and the 2nd or "y" coordinate with the image column no.
void Rotate(const ImageC<RGBPointC> & originalImage,const Point2dC & center,RealT angle,RGBPointC background): The values of image "originalImage" rotated about "angle" rad are saved into this image.
Note the AMMA convention that the 1st or "x" coordinate of Point2dC is associated with the image row no., and the 2nd or "y" coordinate with the image column no.
void ShiftRowIndexes(const IndexT offset): Row indices of the items will be shifted by "offset".
There must be only one reference to this image.
For +ve "offset", the image is shifted down, or the coordinate system is shifted up.
void ShiftColIndexes(const IndexT offset): Column indices of the items will be shifted by "offset".
There must be only one reference to this image.
For +ve "offset", the image is shifted down, or the coordinate system is shifted up.
ImageC<RGBPointC> Subsample(IntT factor = 2) const: returns an image subsampled by a factor of "factor"
void SetOrigin(const PixelC & newOrigin): The image coordinates are changed so that the top left pixel will have coordinates of "newOrigin".
There must be only one reference to this image.

Grey level operations.
ImageC<RGBPointC> & Fill(RGBPointC value): Fills the image with "value"
ImageC<RGBPointC> & Frame(RGBPointC value): Fills a 1-pixel-wide border around the image with "value"
ImageC<RGBPointC> & Frame(RGBPointC v,const ImageRectangleC & rect): Fills a 1-pixel-wide rectangle with "v";
the rectangle is the intersection of "this" with "rect".
ImageC<RGBPointC> Pad(const ImageRectangleC & rect) const: Creates a new image whose frame is from "rect", with pixels copied from "this".
Where the new image lies outside "this", it is padded out with the nearest value from "this".

Logical conditions.
BooleanT IsValid() const: Returns FALSE if the image does not have a valid data area allocated

Access to pixels values.
const RangeBufferAccessC<RGBPointC> operator[](IndexT r) const: Access to the row of the row of pixels.
RangeBufferAccessC<RGBPointC> operator[](IndexT r): Access to the row of the row of pixels.
RGBPointC & operator[](const Index2dC & pxl): Returns the content of the pixel.
const RGBPointC & operator[](const Index2dC & pxl) const: Returns the content of the pixel.
RGBPointC & operator[](const PixelC & pxl): Returns the content of the pixel.
const RGBPointC & operator[](const PixelC & pxl) const: Returns the content of the pixel.
const RGBPointC * CRow(PixelIndexT row) const: Access to the beginning of the row, eg. t
The returned pointer points to the first pixel of the "row".
RGBPointC * Row(PixelIndexT row): Access to the beginning of the constant "row"
I.e. the returned pointer points to the first pixel of "row".
void Save(ostream & outS,BooleanT useHeader = TRUE) const: Saves templated image to stream.
For byte images it will save them in either PGM or PPM binary format. For other types it will save them in ascii if a suitable stream operator has been written for the templated class. NB. These treat images of ByteGreyValueT specialy, the image values are read as numbers not as charactors.
void Load(istream & outS,BooleanT useHeader = TRUE): Loads templated image type from ascii stream.
Should not be used for binary PGM/PPM files, but should work on most templated types. NB. These treat images of ByteGreyValueT specialy, the image values are written as numbers not as charactors.
RGBPointC ** StartAddress() const: Returns the pointer to the table of pointers to image.
This being public is really only a hack! EXPERTS ONLY!
BufferRC<RGBPointC> & Buffer(): Access buffer where data is stored.
const BufferRC<RGBPointC> & Buffer() const: Access buffer where data is stored.

#include "amma/BasImage.hh"

const ImageRectangleC & Rectangle() const: Returns the image rectangle.
const Index2dC & Origin() const: Returns the upper-left pixel coordinates of the image rectangle.
const Index2dC & End() const: Returns the lower right pixel coordinates of the image rectangle.
const ImageFileInfoC & ImageFileInfo() const: Access to the origin.
const BaseImageC & BaseImage() const: access to the constant object
BaseImageC & BaseImage(): access to the object
Modification of the object --------------------------
void SetRowSubRange(const IndexT newMin,const IndexT newMax): The range of indexes of the array will be constrained
void SetColSubRange(const IndexT newMin,const IndexT newMax): The range of indexes of the array will be constrained.
void SetSubRange(const ImageRectangleC & range): Constrains the domain of the image.
void SetFullRectangle(): Sets the working rectangle to be allocated rectangle of the image.
void SetImageFileInfo(ImageFileInfoC * newInfo): Sets a new image file information respecting the current size of the image.
BooleanT IsEmpty() const: Returns TRUE if the image has zero size
void ErrDifferentSize(const BaseImageC & image,char * functionName) const: Triggers an error event if this image has different size from `image'.
The functionName should be the name of the function that triggers the error event.
SizeT Rnum() const: Returns number of rows.
SizeT Cnum() const: Returns number of columns.
IndexT TRow() const: Returns the top row index.
IndexT LCol() const: Returns the left side column index.
IndexT BRow() const: Returns the bottom row index.
IndexT RCol() const: Returns the right side column index.
LongIntT Area() const: Returns the area of the image rectangle expressed in number of indexs.
UIntT Count() const: Returns the number of refrences to this object.
NB. The following definition is now obsolete, The value 0 means there is no other reference to this object.
const ImageRectangleC & AllocatedRect() const: Access allocated rectangle.
BooleanT IsBlock() const: Returns TRUE if the image is allocated as one block of memory.

#include "amma/ImageA.hh"

ImageAC * ACopy() const: A physical copy of the image.
ImageAC * AnotherImage() const: Creates a new empty image of the same type and size as this image is.
const ImageRectangleC & Rectangle() const: Returns the working image rectangle.
void ShiftRowIndexes(const IndexT offset): all indexes of the items will be shift by 'offset'
void ShiftColIndexes(const IndexT offset): all indexes of the items will be shift by 'offset'
void SetRowSubRange(const IndexT newMin,const IndexT newMax): the range of indexes of the array will be constrained
void SetColSubRange(const IndexT newMin,const IndexT newMax): the range of indexes of the array will be constrained
const ImageFileInfoC & ImageFileInfo() const: access to the const origin

Programmer:Radek Marik, Documentation by CxxDoc: Tue Mar 20 10:48:08 2001

RealRGBImageC

The class RealRGBImageC represents colour image with colour represented by a triple of real RGB components.

include	"amma/ReRGBImg.hh"
User Level:	Default
Library:	ColorImg
Example:	exIter.cc
Section:	Image.Image Representations
In Scope:	std

Grey level operations.

Logical conditions.

Access to pixels values.