vpRGBf Class Reference

#include <vpRGBf.h>

Public Member Functions
	vpRGBf ()
	vpRGBf (float r, float g, float b)
	vpRGBf (float v)
	vpRGBf (const vpRGBf &v)
	vpRGBf (const vpColVector &v)
vpRGBf &	operator= (float v)
vpRGBf &	operator= (const vpRGBf &v)
vpRGBf &	operator= (const vpRGBf &&v)
vpRGBf &	operator= (const vpColVector &v)
bool	operator== (const vpRGBf &v) const
bool	operator!= (const vpRGBf &v) const
vpColVector	operator- (const vpRGBf &v) const
vpRGBf	operator+ (const vpRGBf &v) const
vpColVector	operator- (const vpColVector &v) const
vpColVector	operator+ (const vpColVector &v) const
vpColVector	operator* (float v) const
vpColVector	operator* (double v) const
bool	operator< (const vpRGBf &v) const
bool	operator> (const vpRGBf &v) const

Public Attributes
float	R
float	G
float	B

Friends
VISP_EXPORT std::ostream &	operator<< (std::ostream &os, const vpRGBf &rgb)
VISP_EXPORT vpRGBf	operator* (double x, const vpRGBf &rgb)

Detailed Description

Class that defines a RGB 32-bit floating point structure that is used to build color images. RGB stands for red green blue color space.

See also

vpRGBa

vpImage

Examples

testImageDifference.cpp.

Definition at line 56 of file vpRGBf.h.

Constructor & Destructor Documentation

vpRGBf() [1/5]

vpRGBf::vpRGBf ( )

inline

Basic constructor.

Build a black value.

Definition at line 64 of file vpRGBf.h.

References B, G, and R.

Referenced by operator!=(), operator*, operator+(), operator-(), operator<(), operator<<, operator=(), operator=(), operator=(), operator=(), operator==(), operator>(), and vpRGBf().

vpRGBf() [2/5]

vpRGBf::vpRGBf ( float r, float g, float b )

inline

Constructor.

Initialize the color with R, G, B values.

Parameters

r	: Red value.
g	: Green value.
b	: Blue value.

Definition at line 75 of file vpRGBf.h.

References B, G, and R.

vpRGBf() [3/5]

vpRGBf::vpRGBf ( float v )

inline

Constructor.

Initialize all the R, G, B components to v.

Parameters

v	: Value to set.

Definition at line 87 of file vpRGBf.h.

References B, G, and R.

vpRGBf() [4/5]

vpRGBf::vpRGBf ( const vpRGBf & v )

inline

Copy constructor.

Definition at line 92 of file vpRGBf.h.

References B, G, R, and vpRGBf().

vpRGBf() [5/5]

vpRGBf::vpRGBf ( const vpColVector & v )

inline

Create a RGB value from a 3 dimensional column vector.

R=v[0] G=v[1] B=v[2]

Definition at line 101 of file vpRGBf.h.

References B, G, and R.

Member Function Documentation

operator!=()

bool vpRGBf::operator!=

(

const vpRGBf &

v

)

const

Compare two color pixels.

Returns

true if the values are different, false if they are exactly the same.

Definition at line 126 of file vpRGBf.cpp.

References B, G, R, and vpRGBf().

operator*() [1/2]

vpColVector vpRGBf::operator*

(

double

v

)

const

Multiplication operator : v * "this".

Parameters

v	: Value to multiply.

Returns

v * "this"

Definition at line 209 of file vpRGBf.cpp.

References B, G, and R.

operator*() [2/2]

vpColVector vpRGBf::operator*

(

float

v

)

const

Multiplication operator : v * "this".

Parameters

v	: Value to multiply.

Returns

v * "this"

Definition at line 195 of file vpRGBf.cpp.

References B, G, and R.

Referenced by operator*.

operator+() [1/2]

vpColVector vpRGBf::operator+

(

const vpColVector &

v

)

const

Addition operator : "this" + v.

Parameters

v	: Color to add to the current object "this".

Returns

"this" + v

Definition at line 181 of file vpRGBf.cpp.

References B, G, and R.

operator+() [2/2]

vpRGBf vpRGBf::operator+

(

const vpRGBf &

v

)

const

Addition operator : "this" + v.

Parameters

v	: Color to add to the current object "this".

Returns

"this" + v

Warning

in case of overflow : e.g. 128+128 returns 0 for all 4 channels

Definition at line 153 of file vpRGBf.cpp.

References B, G, R, and vpRGBf().

operator-() [1/2]

vpColVector vpRGBf::operator-

(

const vpColVector &

v

)

const

subtraction operator : "this" - v.

Parameters

v	: Color to subtract to the current object "this".

Returns

"this" - v

Definition at line 167 of file vpRGBf.cpp.

References B, G, and R.

operator-() [2/2]

vpColVector vpRGBf::operator-

(

const vpRGBf &

v

)

const

subtraction operator : "this" - v.

Parameters

v	: Color to subtract to the current object "this".

Returns

"this" - v

Definition at line 138 of file vpRGBf.cpp.

References B, G, R, and vpRGBf().

operator<()

bool vpRGBf::operator<

(

const vpRGBf &

v

)

const

Definition at line 218 of file vpRGBf.cpp.

References B, G, R, and vpRGBf().

operator=() [1/4]

vpRGBf & vpRGBf::operator=

(

const vpColVector &

v

)

Cast a vpColVector in a vpRGBf

Parameters

v	: Input vector. v[0], v[1], v[2] are to make into relation with respectively R, G and B.

Exceptions

vpException::dimensionError

: If v is not a 3-dimentional vector.

Definition at line 93 of file vpRGBf.cpp.

References B, vpException::dimensionError, G, vpArray2D< Type >::getRows(), R, vpERROR_TRACE, and vpRGBf().

operator=() [2/4]

vpRGBf & vpRGBf::operator=

(

const vpRGBf &&

v

)

Move operator.

Definition at line 76 of file vpRGBf.cpp.

References B, G, R, and vpRGBf().

operator=() [3/4]

vpRGBf & vpRGBf::operator=

(

const vpRGBf &

v

)

Copy operator.

Definition at line 64 of file vpRGBf.cpp.

References B, G, R, and vpRGBf().

operator=() [4/4]

vpRGBf & vpRGBf::operator=

(

float

v

)

Copy operator (from a floating-point value)

Parameters

v	: Input color ( R = G = B = v )

Definition at line 53 of file vpRGBf.cpp.

References B, G, R, and vpRGBf().

operator==()

bool vpRGBf::operator==

(

const vpRGBf &

v

)

const

Compare two RGB values.

Returns

true if the values are exactly the same, false otherwise.

Definition at line 110 of file vpRGBf.cpp.

References B, G, R, and vpRGBf().

operator>()

bool vpRGBf::operator>

(

const vpRGBf &

v

)

const

Definition at line 226 of file vpRGBf.cpp.

References B, G, R, and vpRGBf().

Friends And Related Symbol Documentation

operator*

VISP_EXPORT vpRGBf operator* ( double x, const vpRGBf & rgb )

friend

Definition at line 234 of file vpRGBf.cpp.

References operator*(), and vpRGBf().

operator<<

VISP_EXPORT std::ostream & operator<< ( std::ostream & os, const vpRGBf & rgb )

friend

Writes the RGB values to the stream os, and returns a reference to the stream. The coordinates are separated by a comma.

The following code prints the intensity of the pixel in the middle of the image:

#include <visp3/core/vpImage.h>
 
int main()
{
  vpImage<vpRGBf> I(480,640);
 
  std::cout << "RGB: " << I[240][320] << std::endl;
 
  return 0;
}

Definition at line 257 of file vpRGBf.cpp.

References B, G, operator<<, R, and vpRGBf().

Referenced by operator<<.

Member Data Documentation

B

float vpRGBf::B

Blue component.

Definition at line 127 of file vpRGBf.h.

Referenced by vpImageConvert::convert(), vpImage< vpRGBa >::getMinMaxValue(), operator!=(), operator*(), operator*(), operator+(), operator+(), operator-(), operator-(), operator<(), operator<<, operator=(), operator=(), operator=(), operator=(), operator==(), operator>(), vpRGBf(), vpRGBf(), vpRGBf(), vpRGBf(), and vpRGBf().

G

float vpRGBf::G

Green component.

Definition at line 126 of file vpRGBf.h.

Referenced by vpImageConvert::convert(), vpImage< vpRGBa >::getMinMaxValue(), operator!=(), operator*(), operator*(), operator+(), operator+(), operator-(), operator-(), operator<(), operator<<, operator=(), operator=(), operator=(), operator=(), operator==(), operator>(), vpRGBf(), vpRGBf(), vpRGBf(), vpRGBf(), and vpRGBf().

R

float vpRGBf::R

Red component.

Definition at line 125 of file vpRGBf.h.

Referenced by vpImageConvert::convert(), vpImage< vpRGBa >::getMinMaxValue(), operator!=(), operator*(), operator*(), operator+(), operator+(), operator-(), operator-(), operator<(), operator<<, operator=(), operator=(), operator=(), operator=(), operator==(), operator>(), vpRGBf(), vpRGBf(), vpRGBf(), vpRGBf(), and vpRGBf().