ossimHsvVector Class Reference

#include <ossimHsvVector.h>

Public Member Functions
	ossimHsvVector (float h=0, float s=0, float i=0)
	ossimHsvVector (const ossimRgbVector &rgb)
const ossimHsvVector &	operator= (const ossimRgbVector &rgb)
float	getH () const
float	getS () const
float	getV () const
unsigned char	getVUnNormalized () const
void	setH (float H)
void	setS (float S)
void	setV (float V)
float	clamp (float colorValue, float min=0, float max=255) const

Static Public Attributes
static const float	OSSIM_HSV_UNDEFINED = -1

Protected Attributes
float	theBuf [3]

Friends
ostream &	operator<< (ostream &out, const ossimHsvVector &data)

Detailed Description

Definition at line 18 of file ossimHsvVector.h.

Constructor & Destructor Documentation

ossimHsvVector() [1/2]

ossimHsvVector::ossimHsvVector ( float  h = 0, float  s = 0, float  i = 0  )

inline

Definition at line 32 of file ossimHsvVector.h.

      {
         theBuf[0] = h;
         theBuf[1] = s;
         theBuf[2] = i;
      }

ossimHsvVector() [2/2]

ossimHsvVector::ossimHsvVector

(

const ossimRgbVector &

rgb

)

Definition at line 19 of file ossimHsvVector.cpp.

References clamp(), ossimRgbVector::getB(), ossimRgbVector::getG(), ossimRgbVector::getR(), max, min, OSSIM_HSV_UNDEFINED, theBuf, and x.

{
   float r,g,b;
     
   r = rgb.getR()/255.0;
   g = rgb.getG()/255.0;
   b = rgb.getB()/255.0;

   // this code was taken from http://www.acm.org/jgt/papers/SmithLyons96/hsv_rgb.html
   // the input RGB is required to be on [0, 1].
   // Their S and V are returned on [0, 1] and H is but we will try
   // to make it return on 0..255 for S and V and see what that looks
   // like and keep the H on 0..6.
   // returned on [0, 6]. Exception: H is returned UNDEFINED if S==0.
   
   float x, v, f, i;
   
   x = min(min(r, g), b);
   v = max(max(r, g), b); 
   if(v==x)
   {
      theBuf[0] = OSSIM_HSV_UNDEFINED, // we really need to mark as undefined 
      theBuf[1] = 0;
      theBuf[2] = v;
   }
   else
   {
      f = (r == x) ? g - b : ((g == x) ? b - r : r - g); 
      i = (r == x) ? 3 : ((g == x) ? 5 : 1);
      
      theBuf[0] = clamp(i - f /(v - x), 0, 6);
      theBuf[0]/=6.0;
      theBuf[1] = clamp((v - x)/v, 0, 1);
      theBuf[2] = clamp(v, 0, 1);
   }
}

Member Function Documentation

clamp()

float ossimHsvVector::clamp ( float  colorValue, float  min = 0, float  max = 255  ) const

inline

Definition at line 54 of file ossimHsvVector.h.

References max, and min.

Referenced by operator=(), and ossimHsvVector().

      {
         colorValue = colorValue > max? max:colorValue;
         colorValue = colorValue < min? min:colorValue;
         
         return colorValue;
      }

getH()

float ossimHsvVector::getH ( ) const

inline

Definition at line 42 of file ossimHsvVector.h.

Referenced by ossimRgbToHsvSource::getTile(), ossimNormRgbVector::operator=(), ossimRgbVector::operator=(), and ossimRgbVector::ossimRgbVector().

{ return theBuf[0]; }

getS()

float ossimHsvVector::getS ( ) const

inline

Definition at line 43 of file ossimHsvVector.h.

Referenced by ossimRgbToHsvSource::getTile(), ossimNormRgbVector::operator=(), ossimRgbVector::operator=(), and ossimRgbVector::ossimRgbVector().

{ return theBuf[1]; }

getV()

float ossimHsvVector::getV ( ) const

inline

Definition at line 44 of file ossimHsvVector.h.

Referenced by ossimIntensityAdjustmentFilter::computeMeanIntensity(), ossimIntensityAdjustmentFilter::getTile(), ossimRgbToHsvSource::getTile(), ossimNormRgbVector::operator=(), ossimRgbVector::operator=(), and ossimRgbVector::ossimRgbVector().

{ return theBuf[2]; }

getVUnNormalized()

unsigned char ossimHsvVector::getVUnNormalized ( ) const

inline

Definition at line 46 of file ossimHsvVector.h.

      {
         return static_cast<unsigned char>(theBuf[2]*255);
      }

operator=()

const ossimHsvVector & ossimHsvVector::operator=

(

const ossimRgbVector &

rgb

)

Definition at line 56 of file ossimHsvVector.cpp.

References clamp(), ossimRgbVector::getB(), ossimRgbVector::getG(), ossimRgbVector::getR(), max, min, OSSIM_HSV_UNDEFINED, theBuf, and x.

{
   float r,g,b;
     
   r = rgb.getR()/255.0;
   g = rgb.getG()/255.0;
   b = rgb.getB()/255.0;

   // this code was taken from http://www.acm.org/jgt/papers/SmithLyons96/hsv_rgb.html
   // the input RGB is required to be on [0, 1].
   // Their S and V are returned on [0, 1] and H is but we will try
   // to make it return on 0..255 for S and V and see what that looks
   // like and keep the H on 0..6.
   // returned on [0, 6]. Exception: H is returned UNDEFINED if S==0.
   
   float x, v, f, i;
   
   x = min(min(r, g), b);
   v = max(max(r, g), b); 
   if(v==x)
   {
      theBuf[0] = OSSIM_HSV_UNDEFINED, // we really need to mark as undefined 
      theBuf[1] = 0;
      theBuf[2] = v;
   }
   else
   {
      f = (r == x) ? g - b : ((g == x) ? b - r : r - g); 
      i = (r == x) ? 3 : ((g == x) ? 5 : 1);
      
      theBuf[0] = clamp(i - f /(v - x), 0, 6);
      theBuf[0]/=6.0;
      theBuf[1] = clamp((v - x)/v, 0, 1);
      theBuf[2] = clamp(v, 0, 1);
   }

   return *this;
}

setH()

void ossimHsvVector::setH ( float  H )

inline

Definition at line 50 of file ossimHsvVector.h.

{ theBuf[0] = H; }

setS()

void ossimHsvVector::setS ( float  S )

inline

Definition at line 51 of file ossimHsvVector.h.

{ theBuf[1] = S; }

setV()

void ossimHsvVector::setV ( float  V )

inline

Definition at line 52 of file ossimHsvVector.h.

Referenced by ossimIntensityAdjustmentFilter::getTile().

{ theBuf[2] = V; }

Friends And Related Function Documentation

operator<<

ostream& operator<< ( ostream &  out, const ossimHsvVector &  data  )

friend

Definition at line 21 of file ossimHsvVector.h.

      {
         out << "<" << data.theBuf[0] << ", "
             << data.theBuf[1] << ", "
             << data.theBuf[2] << ">";

         return out;
      }

Member Data Documentation

OSSIM_HSV_UNDEFINED

const float ossimHsvVector::OSSIM_HSV_UNDEFINED = -1

static

Definition at line 62 of file ossimHsvVector.h.

Referenced by operator=(), ossimNormRgbVector::operator=(), ossimRgbVector::operator=(), ossimHsvVector(), and ossimRgbVector::ossimRgbVector().

theBuf

float ossimHsvVector::theBuf[3]

protected

buf[0] = hue [0..1] buf[1] = saturation [0..1] buf[2] = value [0..1]

Definition at line 69 of file ossimHsvVector.h.

Referenced by operator=(), and ossimHsvVector().

---

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

• ossimHsvVector.h
• ossimHsvVector.cpp