[ VIGRA Homepage |
Class Index |
Function Index |
File Index |
Main Page ]
|
RGBValue Class Template Reference
|
 |
Class for a single RGB value.
More...
#include "vigra/rgbvalue.hxx"
Inheritance diagram for RGBValue:
template<class VALUETYPE>
class vigra::RGBValue< VALUETYPE >
Class for a single RGB value.
This class contains three values (of the specified type) that represent red, green, and blue color channels. There are three possibilities to access these values: accessor functions (red(), green(), blue()), index operator (operator[](dx), where 0 is red, 1 is green and 2 is blue) and iterator (STL-compatible random access iterator that references the three colors in turn). The latter two methods, together with the necessary embedded typedefs, ensure compatibility of a RGBValue with a STL vector.
Arithmetic operations are defined as component-wise applications of these operations. Addition, subtraction, and multiplication of two RGBValues (+=, -=, *=, +, -, *, unary -), multiplication and division of an RGBValue with a double, and NumericTraits/PromoteTraits are defined, so that RGBValue fulfills the requirements of a LinearAlgebra.
A number of accessors are provided that support access to RGBValues as a whole, to a selected color component, or to the luminance value.
#include "vigra/rgbvalue.hxx"
Namespace: vigra
- Examples:
-
invert.cxx, invert_explicitly.cxx, and watershed.cxx.
Member Typedef Documentation
typedef TinyVector<VALUETYPE, 3>::const_iterator const_iterator
|
|
typedef TinyVector<VALUETYPE, 3>::iterator iterator
|
|
typedef TinyVector<VALUETYPE, 3>::NormType NormType
|
|
typedef TinyVector<VALUETYPE, 3>::SquaredNormType SquaredNormType
|
|
typedef VALUETYPE value_type
|
|
Constructor & Destructor Documentation
|
Construct from explicit color values |
RGBValue |
( |
Iterator |
i, |
|
|
Iterator |
end |
|
) |
[inline] |
|
|
Construct from another sequence (must have length 3!) |
|
Default constructor (sets all components to 0) |
RGBValue |
( |
RGBValue< U > const & |
r |
) |
[inline] |
|
Member Function Documentation
RGBValue operator- |
( |
|
) |
const [inline] |
|
|
Unary negation (construct RGBValue with negative values) |
RGBValue& operator= |
( |
RGBValue< U > const & |
r |
) |
[inline] |
|
void setBlue |
( |
V |
value |
) |
[inline] |
|
|
Set blue component.The type V of the passed in value is automatically converted to VALUETYPE . |
void setGreen |
( |
V |
value |
) |
[inline] |
|
|
Set green component.The type V of the passed in value is automatically converted to VALUETYPE . |
void setRed |
( |
V |
value |
) |
[inline] |
|
|
Set red component. The type V of the passed in value is automatically converted to VALUETYPE . |
The documentation for this class was generated from the following file: