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

#include <itkRGBAPixel.h>

Inheritance diagram for itk::RGBAPixel< TComponent >:

[legend]Collaboration diagram for itk::RGBAPixel< TComponent >:

[legend]List of all members.

---

Detailed Description

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

Represent Red, Green, Blue cand Alpha 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:

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

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

Definition at line 52 of file itkRGBAPixel.h.

Public Types
typedef FixedArray< TComponent, 4 >	BaseArray
typedef TComponent	ComponentType
typedef RGBAPixel	Self
typedef FixedArray< TComponent, 4 >	Super
Public Member Functions
const ComponentType &	GetAlpha (void) const
const ComponentType &	GetBlue (void) const
const ComponentType &	GetGreen (void) const
ComponentType	GetLuminance (void) const
ComponentType	GetNthComponent (int c) const
const ComponentType &	GetRed (void) const
ComponentType	GetScalarValue () const
	itkStaticConstMacro (Length, unsigned int, 4)
	itkStaticConstMacro (Dimension, unsigned int, 4)
Pass through assignment	operator for the Array base class.*/RGBAPixel &operator= (const Self &r)
RGBAPixel &	operator= (const ComponentType r[4])
	RGBAPixel (const ComponentType r[4])
Pass through constructor for the Array base class *	RGBAPixel (const Self &r)
	RGBAPixel (const ComponentType &r)
Default constructor has nothing to do *	RGBAPixel ()
void	Set (ComponentType red, ComponentType green, ComponentType blue, ComponentType alpha)
void	SetAlpha (ComponentType alpha)
void	SetBlue (ComponentType blue)
void	SetGreen (ComponentType green)
void	SetNthComponent (int c, const ComponentType &v)
void	SetRed (ComponentType red)
Static Public Member Functions
static unsigned int	GetNumberOfComponents ()

---

Member Typedef Documentation

template<typename TComponent = unsigned short> typedef FixedArray<TComponent, 4> itk::RGBAPixel< TComponent >::BaseArray

Convenience typedefs. Definition at line 66 of file itkRGBAPixel.h.

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

Define the component type. Definition at line 69 of file itkRGBAPixel.h.

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

Standard class typedefs. Definition at line 56 of file itkRGBAPixel.h.

template<typename TComponent = unsigned short> typedef FixedArray<TComponent, 4> itk::RGBAPixel< TComponent >::Super

Definition at line 57 of file itkRGBAPixel.h.

---

Constructor & Destructor Documentation

template<typename TComponent = unsigned short> Default constructor has nothing to do* itk::RGBAPixel< TComponent >::RGBAPixel (   )  [inline]

Definition at line 72 of file itkRGBAPixel.h.

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

Definition at line 73 of file itkRGBAPixel.h.

template<typename TComponent = unsigned short> Pass through constructor for the Array base class* itk::RGBAPixel< TComponent >::RGBAPixel (  const Self &  r  )  [inline]

Definition at line 78 of file itkRGBAPixel.h.

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

Definition at line 79 of file itkRGBAPixel.h.

---

Member Function Documentation

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

Get the Alpha component. Definition at line 133 of file itkRGBAPixel.h.

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

Get the Blue component. Definition at line 130 of file itkRGBAPixel.h.

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

Get the Green component. Definition at line 127 of file itkRGBAPixel.h.

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

Get Luminance out of RGB

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

Return the value for the Nth component. Definition at line 91 of file itkRGBAPixel.h.

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

Return the number of componentsxquery-rep. Definition at line 88 of file itkRGBAPixel.h.

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

Get the Red component. Definition at line 124 of file itkRGBAPixel.h.

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

Return the value for the Nth component. Definition at line 95 of file itkRGBAPixel.h.

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

Length of the pixel.

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

Dimension of the vector space.

template<typename TComponent = unsigned short> Pass through assignment itk::RGBAPixel< TComponent >::operator for the Array base class.*/RGBAPixel &operator= (  const Self &  r  )

template<typename TComponent = unsigned short> RGBAPixel& itk::RGBAPixel< TComponent >::operator= (  const ComponentType  r[4]  )

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

Set the four components. Definition at line 120 of file itkRGBAPixel.h.

template<typename TComponent = unsigned short> void itk::RGBAPixel< TComponent >::SetAlpha (  ComponentType  alpha  )  [inline]

Set the Alpha component. Definition at line 117 of file itkRGBAPixel.h.

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

Set the Blue component. Definition at line 114 of file itkRGBAPixel.h.

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

Set the Green component. Definition at line 111 of file itkRGBAPixel.h.

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

Set the Nth component to v. Definition at line 104 of file itkRGBAPixel.h.

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

Set the Red component. Definition at line 108 of file itkRGBAPixel.h.

---

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

• itkRGBAPixel.h

---