PixelHSV Class Reference

#include <PixelHSV.h>

Public Member Functions
	PixelHSV ()
	PixelHSV (unsigned short int h, unsigned char s, unsigned char v)
PixelHSV &	operator= (PixelHSV &p)
bool	operator== (PixelHSV &p)
bool	operator!= (PixelHSV &p)
PixelHSV &	operator+= (PixelHSV &p)
PixelHSV &	operator-= (PixelHSV &p)
PixelHSV &	operator *= (double k)
PixelHSV &	operator *= (PixelHSV &p)
PixelHSV &	operator/= (PixelHSV &p)
Data Fields
unsigned short int	hue
unsigned char	sat
unsigned char	val

---

Detailed Description

A Single pixel consisting of Hue, Sat and Val fields

The pixel is stored as an array of three ints which can be access as seperate colour fields using the FieldSelector enum in the ImageHSV class.

Definition at line 30 of file PixelHSV.h.

---

Constructor & Destructor Documentation

PixelHSV::PixelHSV (   )  [inline]

The default constructor. This zero's the values of the Hue, Sat and Val colour fields. Definition at line 68 of file PixelHSV.h.

PixelHSV::PixelHSV (  unsigned short int  h, unsigned char  s, unsigned char  v )  [inline]

Create a pixel with the specified values. This constructor creates a new pixel with the Hue, Sat and Val values specified as arguments. Definition at line 78 of file PixelHSV.h. References hue, sat, and val.

---

Member Function Documentation

PixelHSV& PixelHSV::operator *= (  double  k  )  [inline]

Overloaded multiplication operator. Multiply the fields of this pixel by a scalar value. Parameters: k  The scalar to multiply by. Returns: A reference to this object. Definition at line 224 of file PixelHSV.h. References hue, sat, and val.

bool PixelHSV::operator!= (  PixelHSV &  p  )  [inline]

Overloaded test for none equality This tests whether the pixel and the one specified are not equal i.e. they have at least one field in which their values differ. Parameters: p  The pixel to test none-equality with. Returns: true - if pixels are different false - if all fields are the same. Definition at line 169 of file PixelHSV.h. References hue, sat, and val.

PixelHSV& PixelHSV::operator+= (  PixelHSV &  p  )  [inline]

Overloaded addition operator. Add the values of the pixel specified to the fields of this pixel. Note NO checking that values are within range 0-255 is done. Parameters: p  The pixel to add the values from. Returns: A reference to this object. Definition at line 187 of file PixelHSV.h. References hue, sat, and val.

PixelHSV& PixelHSV::operator-= (  PixelHSV &  p  )  [inline]

Overloaded subtraction(difference) operator. Assign the difference of the values of the pixel specified and this pixel to the fields of this pixel. Parameters: p  The pixel to difference the values with. Returns: A reference to this object. Definition at line 206 of file PixelHSV.h. References hue, sat, and val.

PixelHSV& PixelHSV::operator= (  PixelHSV &  p  )  [inline]

Overloaded assignment operator. Assign the values of the pixel specified to the fields of this pixel. Parameters: p  The pixel to assign the values from. Returns: A reference to this object. Definition at line 96 of file PixelHSV.h. References hue, sat, and val.

bool PixelHSV::operator== (  PixelHSV &  p  )  [inline]

Overloaded equality operator. This tests whether this pixel and the one specified are equal i.e. have the same values for all fields. Parameters: p  The pixel to test equality with. Returns: true - if pixels are equal. false - if pixels differ in any fields. Definition at line 149 of file PixelHSV.h. References hue, sat, and val.

---

Field Documentation

unsigned short int PixelHSV::hue

Outputs a pixel to the output stream This overlaoded operator inserts a representation of the pixel into the output stream (os) in the form '(h,s,v)' where h, s, v are the Hue, Sat and Val fields respectively. Parameters: os  The output stream. p  The pixel to output. Returns: A reference to the output stream for chained calls. Definition at line 58 of file PixelHSV.h. Referenced by vetFrameHSV::clearChannel(), vetFrameHSV::convPixel_GREYtoHSV(), vetFrameHSV::convPixel_HSVtoGREY(), vetFrameHSV::convPixel_HSVtoRGB24(), vetFrameHSV::convPixel_HSVtoRGB32(), vetFrameHSV::convPixel_RGB24toHSV(), vetFrameHSV::convPixel_RGB32toHSV(), vetFrameHSV::getChannel(), vetNoiseGenerator::getRandomPixelHSV(), operator *=(), operator!=(), operator+=(), operator-=(), operator/=(), operator=(), operator==(), PixelHSV(), vetFrameHSV::setChannel(), and vetFrameHSV::setHSV().

---

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

• PixelHSV.h

---