Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts
itk::RGBPixel

itk::RGBPixel< TComponent > Class Template Reference
[Image Representation Objects]

#include <itkRGBPixel.h>

Inheritance diagram for itk::RGBPixel< TComponent >:

Inheritance graph
[legend]
Collaboration diagram for itk::RGBPixel< TComponent >:

Collaboration graph
[legend]
List of all members.

Detailed Description

template<typename TComponent = unsigned short>
class itk::RGBPixel< TComponent >

Represent Red, Green and Blue component for color images.

This class is templated over the representation used for each component.

The following syntax for assigning an index is allowed/suggested:

RGBPixel<float> pixel; pixel = 1.0f, 0.0f, .5f; RGBPixel<char> pixelArray[2]; pixelArray[0] = 255, 255, 255; pixelArray[1] = 255, 255, 244;

Since RGBPixel is a subclass of Array, you can access its components as: pixel[0], pixel[1], pixel[2]

Examples:

DataRepresentation/Mesh/RGBPointSet.cxx.

Definition at line 51 of file itkRGBPixel.h.

Public Types

typedef FixedArray< TComponent, 3 > BaseArray
typedef ValueType CArray [VLength]
typedef TComponent ComponentType
typedef const ValueType * const_pointer
typedef const ValueType & const_reference
typedef const ValueType * ConstIterator
typedef ValueType * Iterator
typedef ValueType * pointer
typedef ValueType & reference
typedef RGBPixel Self
typedef unsigned int SizeType
typedef FixedArray< TComponent, 3 > Superclass
typedef Superclass::ValueType ValueType

Public Member Functions

ConstIterator Begin () const
Iterator Begin ()
ConstIterator End () const
Iterator End ()
void Fill (const ValueType &)
const ComponentType & GetBlue (void) const
const ValueType * GetDataPointer () const
ValueType * GetDataPointer ()
const_reference GetElement (unsigned short index) const
const ComponentType & GetGreen (void) const
ComponentType GetLuminance (void) const
ComponentType GetNthComponent (int c) const
const ComponentType & GetRed (void) const
ComponentType GetScalarValue () const
 itkStaticConstMacro (Dimension, unsigned int, VLength)
 itkStaticConstMacro (Length, unsigned int, VLength)
bool operator!= (const FixedArray &r) const
bool operator< (const Self &vec) const
Self & operator= (const ComponentType r[3])
bool operator== (const FixedArray &r) const
bool operator== (const Self &vec) const
const_reference operator[] (unsigned long index) const
reference operator[] (unsigned long index)
const_reference operator[] (long index) const
reference operator[] (long index)
const_reference operator[] (unsigned int index) const
reference operator[] (unsigned int index)
const_reference operator[] (int index) const
reference operator[] (int index)
const_reference operator[] (unsigned short index) const
reference operator[] (unsigned short index)
const_reference operator[] (short index) const
reference operator[] (short index)
ConstReverseIterator rBegin () const
ReverseIterator rBegin ()
ConstReverseIterator rEnd () const
ReverseIterator rEnd ()
 RGBPixel (const ComponentType &r)
 RGBPixel ()
void Set (ComponentType red, ComponentType green, ComponentType blue)
void SetBlue (ComponentType blue)
void SetElement (unsigned short index, const_reference value)
void SetGreen (ComponentType green)
void SetNthComponent (int c, const ComponentType &v)
void SetRed (ComponentType red)
SizeType Size () const
 itkStaticConstMacro (Length, unsigned int, 3)
 itkStaticConstMacro (Dimension, unsigned int, 3)
Self operator * (const ComponentType &f) const
Self operator+ (const Self &vec) const
const Self & operator+= (const Self &vec)
Self operator- (const Self &vec) const
const Self & operator-= (const Self &vec)
template<class TRGBPixelValueType>
Self & operator= (const RGBPixel< TRGBPixelValueType > &r)

Static Public Member Functions

static FixedArray Filled (const ValueType &)
static unsigned int GetNumberOfComponents ()

Member Typedef Documentation

template<typename TComponent = unsigned short>
typedef FixedArray<TComponent, 3> itk::RGBPixel< TComponent >::BaseArray

Convenience typedefs.

Definition at line 64 of file itkRGBPixel.h.

typedef ValueType itk::FixedArray< TComponent , VLength >::CArray[VLength] [inherited]

A type representing the C-array version of this FixedArray.

Definition at line 77 of file itkFixedArray.h.

template<typename TComponent = unsigned short>
typedef TComponent itk::RGBPixel< TComponent >::ComponentType

Define the component type.

Definition at line 67 of file itkRGBPixel.h.

typedef const ValueType* itk::FixedArray< TComponent , VLength >::const_pointer [inherited]

A const pointer to the ValueType.

Definition at line 123 of file itkFixedArray.h.

typedef const ValueType& itk::FixedArray< TComponent , VLength >::const_reference [inherited]

A const reference to the ValueType.

Definition at line 129 of file itkFixedArray.h.

typedef const ValueType* itk::FixedArray< TComponent , VLength >::ConstIterator [inherited]

A const iterator through the array.

Definition at line 83 of file itkFixedArray.h.

typedef ValueType* itk::FixedArray< TComponent , VLength >::Iterator [inherited]

An iterator through the array.

Definition at line 80 of file itkFixedArray.h.

typedef ValueType* itk::FixedArray< TComponent , VLength >::pointer [inherited]

A pointer to the ValueType.

Definition at line 120 of file itkFixedArray.h.

typedef ValueType& itk::FixedArray< TComponent , VLength >::reference [inherited]

A reference to the ValueType.

Definition at line 126 of file itkFixedArray.h.

template<typename TComponent = unsigned short>
typedef RGBPixel itk::RGBPixel< TComponent >::Self

Standard class typedefs.

Definition at line 55 of file itkRGBPixel.h.

typedef unsigned int itk::FixedArray< TComponent , VLength >::SizeType [inherited]

Definition at line 131 of file itkFixedArray.h.

template<typename TComponent = unsigned short>
typedef FixedArray<TComponent, 3> itk::RGBPixel< TComponent >::Superclass

Definition at line 56 of file itkRGBPixel.h.

template<typename TComponent = unsigned short>
typedef Superclass::ValueType itk::RGBPixel< TComponent >::ValueType

The element type stored at each location in the FixedArray.

Reimplemented from itk::FixedArray< TComponent, 3 >.

Definition at line 68 of file itkRGBPixel.h.

Constructor & Destructor Documentation

template<typename TComponent = unsigned short>
itk::RGBPixel< TComponent >::RGBPixel (  )  [inline]

Default constructor has nothing to do

Definition at line 71 of file itkRGBPixel.h.

template<typename TComponent = unsigned short>
itk::RGBPixel< TComponent >::RGBPixel ( const ComponentType &  r  )  [inline]

Constructor to fill Red=Blug=Green= r.

Definition at line 74 of file itkRGBPixel.h.

template<typename TComponent = unsigned short>
template<class TRGBPixelValueType>
itk::RGBPixel< TComponent >::RGBPixel ( const RGBPixel< TRGBPixelValueType > &  r  )  [inline]

Pass-through constructor for the Array base class.

Definition at line 78 of file itkRGBPixel.h.

template<typename TComponent = unsigned short>
itk::RGBPixel< TComponent >::RGBPixel ( const ComponentType  r[3]  )  [inline]

Definition at line 79 of file itkRGBPixel.h.

template<typename TComponent = unsigned short>
itk::RGBPixel< TComponent >::RGBPixel ( const ComponentType  r[3]  )  [inline]

Definition at line 79 of file itkRGBPixel.h.

template<typename TComponent = unsigned short>
template<class TRGBPixelValueType>
itk::RGBPixel< TComponent >::RGBPixel ( const RGBPixel< TRGBPixelValueType > &  r  )  [inline]

Pass-through constructor for the Array base class.

Definition at line 78 of file itkRGBPixel.h.

Member Function Documentation

ConstIterator itk::FixedArray< TComponent , VLength >::Begin ( void   )  const [inherited]

Iterator itk::FixedArray< TComponent , VLength >::Begin ( void   )  [inherited]

Get various iterators to the array.

ConstIterator itk::FixedArray< TComponent , VLength >::End ( void   )  const [inherited]

Iterator itk::FixedArray< TComponent , VLength >::End ( void   )  [inherited]

void itk::FixedArray< TComponent , VLength >::Fill ( const ValueType &   )  [inherited]

Referenced by itk::RGBPixel< TPixel >::RGBPixel().

static FixedArray itk::FixedArray< TComponent , VLength >::Filled ( const ValueType &   )  [static, inherited]

template<typename TComponent = unsigned short>
const ComponentType& itk::RGBPixel< TComponent >::GetBlue ( void   )  const [inline]

Get the Blue component.

Definition at line 144 of file itkRGBPixel.h.

Referenced by itk::BluePixelAccessor< T >::Get().

const ValueType* itk::FixedArray< TComponent , VLength >::GetDataPointer (  )  const [inline, inherited]

Definition at line 201 of file itkFixedArray.h.

ValueType* itk::FixedArray< TComponent , VLength >::GetDataPointer (  )  [inline, inherited]

Return a pointer to the data.

Definition at line 200 of file itkFixedArray.h.

const_reference itk::FixedArray< TComponent , VLength >::GetElement ( unsigned short  index  )  const [inline, inherited]

Definition at line 196 of file itkFixedArray.h.

template<typename TComponent = unsigned short>
const ComponentType& itk::RGBPixel< TComponent >::GetGreen ( void   )  const [inline]

Get the Green component.

Definition at line 141 of file itkRGBPixel.h.

Referenced by itk::GreenPixelAccessor< T >::Get().

template<typename TComponent = unsigned short>
ComponentType itk::RGBPixel< TComponent >::GetLuminance ( void   )  const

Get Luminance out of RGB

template<typename TComponent = unsigned short>
ComponentType itk::RGBPixel< TComponent >::GetNthComponent ( int  c  )  const [inline]

Return the value for the Nth component.

Definition at line 108 of file itkRGBPixel.h.

template<typename TComponent = unsigned short>
static unsigned int itk::RGBPixel< TComponent >::GetNumberOfComponents (  )  [inline, static]

Return the number of components.

Definition at line 105 of file itkRGBPixel.h.

template<typename TComponent = unsigned short>
const ComponentType& itk::RGBPixel< TComponent >::GetRed ( void   )  const [inline]

Get the Red component.

Definition at line 138 of file itkRGBPixel.h.

Referenced by itk::RedPixelAccessor< T >::Get().

template<typename TComponent = unsigned short>
ComponentType itk::RGBPixel< TComponent >::GetScalarValue (  )  const [inline]

Return the value for the Nth component.

Definition at line 112 of file itkRGBPixel.h.

itk::FixedArray< TComponent , VLength >::itkStaticConstMacro ( Dimension  ,
unsigned  int,
VLength   
) [inherited]

Dimension constant

itk::FixedArray< TComponent , VLength >::itkStaticConstMacro ( Length  ,
unsigned  int,
VLength   
) [inherited]

Length constant

template<typename TComponent = unsigned short>
itk::RGBPixel< TComponent >::itkStaticConstMacro ( Length  ,
unsigned  int,
3   
)

template<typename TComponent = unsigned short>
itk::RGBPixel< TComponent >::itkStaticConstMacro ( Dimension  ,
unsigned  int,
3   
)

Dimension of the vector space.

template<typename TComponent = unsigned short>
Self itk::RGBPixel< TComponent >::operator * ( const ComponentType &  f  )  const

bool itk::FixedArray< TComponent , VLength >::operator!= ( const FixedArray< TComponent, 3 > &  r  )  const [inline, inherited]

Definition at line 172 of file itkFixedArray.h.

template<typename TComponent = unsigned short>
Self itk::RGBPixel< TComponent >::operator+ ( const Self &  vec  )  const

Aritmetic operations between pixels. Return a new RGBPixel.

template<typename TComponent = unsigned short>
const Self& itk::RGBPixel< TComponent >::operator+= ( const Self &  vec  ) 

template<typename TComponent = unsigned short>
Self itk::RGBPixel< TComponent >::operator- ( const Self &  vec  )  const

template<typename TComponent = unsigned short>
const Self& itk::RGBPixel< TComponent >::operator-= ( const Self &  vec  ) 

template<typename TComponent = unsigned short>
bool itk::RGBPixel< TComponent >::operator< ( const Self &  vec  )  const

template<typename TComponent = unsigned short>
Self& itk::RGBPixel< TComponent >::operator= ( const ComponentType  r[3]  ) 

template<typename TComponent = unsigned short>
template<class TRGBPixelValueType>
Self& itk::RGBPixel< TComponent >::operator= ( const RGBPixel< TRGBPixelValueType > &  r  )  [inline]

Pass-through assignment operator for the Array base class.

Definition at line 84 of file itkRGBPixel.h.

bool itk::FixedArray< TComponent , VLength >::operator== ( const FixedArray< TComponent, 3 > &  r  )  const [inherited]

Operators == and != are used to compare whether two arrays are equal. Note that arrays are equal when the number of components (size) is the same, and each component value is equal.

template<typename TComponent = unsigned short>
bool itk::RGBPixel< TComponent >::operator== ( const Self &  vec  )  const

const_reference itk::FixedArray< TComponent , VLength >::operator[] ( unsigned long  index  )  const [inline, inherited]

Definition at line 190 of file itkFixedArray.h.

reference itk::FixedArray< TComponent , VLength >::operator[] ( unsigned long  index  )  [inline, inherited]

Definition at line 189 of file itkFixedArray.h.

const_reference itk::FixedArray< TComponent , VLength >::operator[] ( long  index  )  const [inline, inherited]

Definition at line 188 of file itkFixedArray.h.

reference itk::FixedArray< TComponent , VLength >::operator[] ( long  index  )  [inline, inherited]

Definition at line 187 of file itkFixedArray.h.

const_reference itk::FixedArray< TComponent , VLength >::operator[] ( unsigned int  index  )  const [inline, inherited]

Definition at line 186 of file itkFixedArray.h.

reference itk::FixedArray< TComponent , VLength >::operator[] ( unsigned int  index  )  [inline, inherited]

Definition at line 185 of file itkFixedArray.h.

const_reference itk::FixedArray< TComponent , VLength >::operator[] ( int  index  )  const [inline, inherited]

Definition at line 184 of file itkFixedArray.h.

reference itk::FixedArray< TComponent , VLength >::operator[] ( int  index  )  [inline, inherited]

Definition at line 183 of file itkFixedArray.h.

const_reference itk::FixedArray< TComponent , VLength >::operator[] ( unsigned short  index  )  const [inline, inherited]

Definition at line 182 of file itkFixedArray.h.

reference itk::FixedArray< TComponent , VLength >::operator[] ( unsigned short  index  )  [inline, inherited]

Definition at line 181 of file itkFixedArray.h.

const_reference itk::FixedArray< TComponent , VLength >::operator[] ( short  index  )  const [inline, inherited]

Definition at line 180 of file itkFixedArray.h.

reference itk::FixedArray< TComponent , VLength >::operator[] ( short  index  )  [inline, inherited]

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 179 of file itkFixedArray.h.

Referenced by itk::RGBPixel< TPixel >::GetBlue(), itk::RGBPixel< TPixel >::GetGreen(), itk::RGBPixel< TPixel >::GetNthComponent(), itk::RGBPixel< TPixel >::GetRed(), itk::RGBPixel< TPixel >::Set(), itk::RGBPixel< TPixel >::SetBlue(), itk::RGBPixel< TPixel >::SetGreen(), itk::RGBPixel< TPixel >::SetNthComponent(), and itk::RGBPixel< TPixel >::SetRed().

ConstReverseIterator itk::FixedArray< TComponent , VLength >::rBegin (  )  const [inherited]

ReverseIterator itk::FixedArray< TComponent , VLength >::rBegin (  )  [inherited]

ConstReverseIterator itk::FixedArray< TComponent , VLength >::rEnd (  )  const [inherited]

ReverseIterator itk::FixedArray< TComponent , VLength >::rEnd (  )  [inherited]

template<typename TComponent = unsigned short>
void itk::RGBPixel< TComponent >::Set ( ComponentType  red,
ComponentType  green,
ComponentType  blue 
) [inline]

Set the three components.

Definition at line 134 of file itkRGBPixel.h.

Referenced by itk::Function::ComposeRGB< TInput >::operator()().

template<typename TComponent = unsigned short>
void itk::RGBPixel< TComponent >::SetBlue ( ComponentType  blue  )  [inline]

Set the Blue component.

Definition at line 131 of file itkRGBPixel.h.

Referenced by itk::BluePixelAccessor< T >::Set().

void itk::FixedArray< TComponent , VLength >::SetElement ( unsigned short  index,
const_reference  value 
) [inline, inherited]

Set/Get element methods are more convenient in wrapping languages

Definition at line 194 of file itkFixedArray.h.

template<typename TComponent = unsigned short>
void itk::RGBPixel< TComponent >::SetGreen ( ComponentType  green  )  [inline]

Set the Green component.

Definition at line 128 of file itkRGBPixel.h.

Referenced by itk::GreenPixelAccessor< T >::Set().

template<typename TComponent = unsigned short>
void itk::RGBPixel< TComponent >::SetNthComponent ( int  c,
const ComponentType &  v 
) [inline]

Set the Nth component to v.

Definition at line 121 of file itkRGBPixel.h.

template<typename TComponent = unsigned short>
void itk::RGBPixel< TComponent >::SetRed ( ComponentType  red  )  [inline]

Set the Red component.

Definition at line 125 of file itkRGBPixel.h.

Referenced by itk::RedPixelAccessor< T >::Set().

SizeType itk::FixedArray< TComponent , VLength >::Size ( void   )  const [inherited]

The documentation for this class was generated from the following file:
Generated at Mon Apr 14 21:36:09 2008 for ITK by doxygen 1.5.1 written by Dimitri van Heesch, © 1997-2000