Developer Documentation
RAVL, Recognition And Vision Library
USER HOME PAGE CLASS LIST CONTENTS
Ravl - Images - Pixel Types - RGBValueC<class CompT>
 

  PUBLIC
RGBValueC::RGBValueC(void)
RGBValueC::RGBValueC(const CompT &,const CompT &,const CompT &)
RGBValueC::RGBValueC(RGBValueC &)
RGBValueC::RGBValueC(const TFVectorC &)
RGBValueC::Set(const CompT &,const CompT &,const CompT &)
RGBValueC::Red(void) const
RGBValueC::Green(void) const
RGBValueC::Blue(void) const
RGBValueC::Red(void)
RGBValueC::Green(void)
RGBValueC::Blue(void)
RGBValueC::NTSC_Y(void)
RGBValueC::Y(void) const
TFVectorC::Size(void) const
TFVectorC::Contains(UIntT) const
TFVectorC::operator [](UIntT)
TFVectorC::operator [](UIntT) const
TFVectorC::operator ==(const TFVectorC &) const
TFVectorC::operator !=(const TFVectorC &) const
TFVectorC::Fill(const DataT &)
TFVectorC::Abs(void) const
TFVectorC::operator +=(const TFVectorC &)
TFVectorC::operator -=(const TFVectorC &)
TFVectorC::operator *=(const TFVectorC &)
TFVectorC::operator /=(const TFVectorC &)
TFVectorC::operator +(const TFVectorC &) const
TFVectorC::operator -(const TFVectorC &) const
TFVectorC::operator *(const TFVectorC &) const
TFVectorC::operator /(const TFVectorC &) const
TFVectorC::operator -(void) const
TFVectorC::operator *=(const DataT &)
TFVectorC::operator /=(const DataT &)
TFVectorC::operator *(const DataT &) const
TFVectorC::operator /(const DataT &) const
TFVectorC::Dot(const TFVectorC &) const
TFVectorC::OuterProduct(const TFVectorC &,TFMatrixC &) const
TFVectorC::OuterProduct(TFMatrixC &) const
TFVectorC::Limit(const DataT &,const DataT &)
TFVectorC::MaxValueDistance(const TFVectorC &) const
TFVectorC::CityBlockDistance(const TFVectorC &) const
TFVectorC::SqrEuclidDistance(const TFVectorC &) const
TFVectorC::Sum(void) const
TFVectorC::SumSqr(void) const
TFVectorC::T(void) const
TFVectorC::operator >>(istream &,TFVectorC &)
TFVectorC::operator <<(ostream &,const TFVectorC &)
TFVectorC::operator >>(BinIStreamC &,TFVectorC &)
TFVectorC::operator <<(BinOStreamC &,const TFVectorC &)

   RGBValueC<class CompT>   
 
RGB Pixel base class.
 
include "Ravl/Image/RGBValue.hh"
Created:24/01/2001 
Source file:Ravl/Image/Base/RGBValue.hh
User Level:Normal
Library:RavlImage
In Scope:RavlImageN

Parent Classes: Derived Classes: Methods:
RGBValueC()
Default constructor.
Creates an undefined value.

RGBValueC(const CompT & r,const CompT & g,const CompT & b)
Construct from component values.

RGBValueC(RGBValueC<OCompT> & oth)
Construct from another component type.

RGBValueC(const TFVectorC<CompT,3> & v)
Constructor from base class.

void Set(const CompT & r,const CompT & g,const CompT & b)
Set the values.

const CompT & Red() const
Returns the level of the red component.

const CompT & Green() const
Returns the level of the green component.

const CompT & Blue() const
Returns the level of the blue component.

CompT & Red()
Returns the level of the red component.

CompT & Green()
Returns the level of the green component.

CompT & Blue()
Returns the level of the blue component.

CompT NTSC_Y()
Get the pixel intensity of an NTSC colour system.
the NTSC RGB color system.

CompT Y() const
Calculate intensity of the pixel.
This returns the average of the red, green and blue components.

#include "Ravl/TFVector.hh"
UIntT Size() const
Get size of array
Used by some templates.

bool Contains(UIntT i) const
Test if array contains index i·

CompT & operator [](UIntT ind)
Access item.

const CompT & operator [](UIntT ind) const
Access item.

bool operator ==(const TFVectorC<CompT,3> & ind) const
is equal

bool operator !=(const TFVectorC<CompT,3> & ind) const
is not equal

void Fill(const CompT & dat)
Fill array with value 'dat'.

TFVectorC<CompT,3> Abs() const
Get an vector with Abs(x) run on all it values.

const TFVectorC<CompT,3> & operator +=(const TFVectorC<CompT,3> & ind)
Add an array to this one, inplace.

const TFVectorC<CompT,3> & operator -=(const TFVectorC<CompT,3> & ind)
Returns this index multiplied by index 'ind' item by item.

const TFVectorC<CompT,3> & operator *=(const TFVectorC<CompT,3> & ind)
Multiplies this index by index 'ind' item by item.

const TFVectorC<CompT,3> & operator /=(const TFVectorC<CompT,3> & ind)
Divides this index by index 'ind' item by item.

TFVectorC<CompT,3> operator +(const TFVectorC<CompT,3> & ind) const
Adds this index and 'ind'.

TFVectorC<CompT,3> operator -(const TFVectorC<CompT,3> & ind) const
Subtracts index 'ind' from this index.

TFVectorC<CompT,3> operator *(const TFVectorC<CompT,3> & ind) const
Returns this object multiplied by index 'ind' item by item.

TFVectorC<CompT,3> operator /(const TFVectorC<CompT,3> & ind) const
Returns this object devided by index 'ind' item by item.

TFVectorC<CompT,3> operator -() const
Returns opposite elements (unary minus operator).

const TFVectorC<CompT,3> & operator *=(const CompT & alpha)
Multiplies this index by number 'alpha'.

const TFVectorC<CompT,3> & operator /=(const CompT & alpha)
Divides this index by number 'alpha'.

TFVectorC<CompT,3> operator *(const CompT & alpha) const
Returns this object mutliplied by alpha.

TFVectorC<CompT,3> operator /(const CompT & alpha) const
Returns this object devided by alpha.

CompT Dot(const TFVectorC<CompT,3> & oth) const
Calculate the dot product of this and 'oth' vector.

TFMatrixC<CompT,3,3> & OuterProduct(const TFVectorC<CompT,3> & av,TFMatrixC<CompT,3,3> & result) const
Calculate the outer product of this vector with av.
The output is assigned to 'result'. A reference to 'result' is returned.

The implementation is in "Ravl/FMatrix.hh", it must be included to use this function.


TFMatrixC<CompT,3,3> & OuterProduct(TFMatrixC<CompT,3,3> & result) const
Calculate the outer product of this vector with itsself.
The output is assigned to 'result'. A reference to 'result' is returned.

The implementation is in "Ravl/FMatrix.hh", it must be included to use this function.


bool Limit(const CompT & min,const CompT & max)
Limit all values in this vector to between min and max.
Returns true if all values in the vector are between the limits. Distance calculations ---------------------

CompT MaxValueDistance(const TFVectorC<CompT,3> & i) const
Returns the distance of two indexes in maximum value metric.

CompT CityBlockDistance(const TFVectorC<CompT,3> & i) const
Returns the distance of two indexes in absolute value metric.

CompT SqrEuclidDistance(const TFVectorC<CompT,3> & i) const
Returns the distance of two indexes in square Euclid metric.

CompT Sum() const
Calculate the sum of all the vector elements.

CompT SumSqr() const
Calculate the sum of the squares of all the vector elements.

const TFMatrixC<CompT,1,3> & T() const
Transpose vector.
The implementation for this can be found in "Ravl/TFMatrix.hh"

istream & operator >>(istream & in,TFVectorC<CompT,3> & dat)

ostream & operator <<(ostream & in,const TFVectorC<CompT,3> & dat)

BinIStreamC & operator >>(BinIStreamC & in,TFVectorC<CompT,3> & dat)

BinOStreamC & operator <<(BinOStreamC & in,const TFVectorC<CompT,3> & dat)


Maintainer:Charles Galambos, Created: 24/01/2001, Documentation by CxxDoc: Tue Aug 13 09:59:30 2002