ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
itk::RGBAPixel< TComponent > Class Template Reference

#include <itkRGBAPixel.h>

+ Inheritance diagram for itk::RGBAPixel< TComponent >:
+ Collaboration diagram for itk::RGBAPixel< TComponent >:

Detailed Description

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

Represent Red, Green, Blue and Alpha components 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]

Wiki Examples:
Examples:
WikiExamples/Images/ConvertPixelBuffer.cxx, and WikiExamples/SimpleOperations/Transparency.cxx.

Definition at line 59 of file itkRGBAPixel.h.

Public Types

typedef FixedArray< TComponent, 4 > BaseArray
 
typedef TComponent ComponentType
 
typedef NumericTraits
< ComponentType >::RealType 
LuminanceType
 
typedef RGBAPixel Self
 
typedef FixedArray< TComponent, 4 > Superclass
 
- Public Types inherited from itk::FixedArray< TComponent, 4 >
typedef ValueType CArray [VLength]
 
typedef const ValueType * const_pointer
 
typedef const ValueType & const_reference
 
typedef const ValueType * ConstIterator
 
typedef ValueType * Iterator
 
typedef ValueType * pointer
 
typedef ValueType & reference
 
typedef unsigned int SizeType
 
typedef TComponent ValueType
 

Public Member Functions

const ComponentType & GetAlpha (void) const
 
const ComponentType & GetBlue (void) const
 
const ComponentType & GetGreen (void) const
 
LuminanceType GetLuminance () const
 
ComponentType GetNthComponent (int c) const
 
const ComponentType & GetRed (void) const
 
ComponentType GetScalarValue () const
 
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)
 
RGBAPixel & operator= (const Self &r)
 
RGBAPixel & operator= (const ComponentType r[4])
 
bool operator== (const Self &vec) const
 
void SetAlpha (ComponentType alpha)
 
void SetBlue (ComponentType blue)
 
void SetGreen (ComponentType green)
 
void SetNthComponent (int c, const ComponentType &v)
 
void SetRed (ComponentType red)
 
 RGBAPixel ()
 
 RGBAPixel (const ComponentType &r)
 
template<typename TRGBAPixelValueType >
 RGBAPixel (const RGBAPixel< TRGBAPixelValueType > &r)
 
 RGBAPixel (const ComponentType r[4])
 
void Set (ComponentType red, ComponentType green, ComponentType blue, ComponentType alpha)
 
- Public Member Functions inherited from itk::FixedArray< TComponent, 4 >
Iterator Begin ()
 
ConstIterator Begin () const
 
Iterator End ()
 
ConstIterator End () const
 
void Fill (const ValueType &)
 
 FixedArray (const TScalarValue *r)
 
ValueType * GetDataPointer ()
 
const ValueType * GetDataPointer () const
 
bool operator!= (const FixedArray &r) const
 
FixedArray & operator= (const ValueType r[VLength])
 
bool operator== (const FixedArray &r) const
 
ReverseIterator rBegin ()
 
ConstReverseIterator rBegin () const
 
ReverseIterator rEnd ()
 
ConstReverseIterator rEnd () const
 
SizeType Size () const
 
 FixedArray ()
 
 FixedArray (const ValueType r[VLength])
 
 FixedArray (const ValueType &r)
 
 FixedArray (const FixedArray< TFixedArrayValueType, VLength > &r)
 
FixedArray & operator= (const FixedArray< TFixedArrayValueType, VLength > &r)
 
reference operator[] (short index)
 
const_reference operator[] (short index) const
 
reference operator[] (unsigned short index)
 
const_reference operator[] (unsigned short index) const
 
reference operator[] (int index)
 
const_reference operator[] (int index) const
 
reference operator[] (unsigned int index)
 
const_reference operator[] (unsigned int index) const
 
reference operator[] (long index)
 
const_reference operator[] (long index) const
 
reference operator[] (unsigned long index)
 
const_reference operator[] (unsigned long index) const
 
reference operator[] (long long index)
 
const_reference operator[] (long long index) const
 
reference operator[] (unsigned long long index)
 
const_reference operator[] (unsigned long long index) const
 
void SetElement (unsigned short index, const_reference value)
 
const_reference GetElement (unsigned short index) const
 

Static Public Member Functions

static unsigned int GetNumberOfComponents ()
 
- Static Public Member Functions inherited from itk::FixedArray< TComponent, 4 >
static FixedArray Filled (const ValueType &)
 

Static Public Attributes

static const unsigned int Dimension = 4
 
static const unsigned int Length = 4
 
- Static Public Attributes inherited from itk::FixedArray< TComponent, 4 >
static const unsigned int Dimension
 
static const unsigned int Length
 

Member Typedef Documentation

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

Convenience typedefs.

Definition at line 73 of file itkRGBAPixel.h.

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

Define the component type.

Definition at line 76 of file itkRGBAPixel.h.

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

Definition at line 77 of file itkRGBAPixel.h.

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

Standard class typedefs.

Definition at line 63 of file itkRGBAPixel.h.

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

Definition at line 64 of file itkRGBAPixel.h.

Constructor & Destructor Documentation

template<typename TComponent = unsigned short>
itk::RGBAPixel< TComponent >::RGBAPixel ( )
inline

Default constructor has nothing to do.

Definition at line 80 of file itkRGBAPixel.h.

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

Default constructor has nothing to do.

Definition at line 81 of file itkRGBAPixel.h.

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

Pass-through constructor for the Array base class.

Definition at line 86 of file itkRGBAPixel.h.

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

Pass-through constructor for the Array base class.

Definition at line 87 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 161 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 158 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 155 of file itkRGBAPixel.h.

template<typename TComponent = unsigned short>
LuminanceType itk::RGBAPixel< TComponent >::GetLuminance ( ) 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 112 of file itkRGBAPixel.h.

template<typename TComponent = unsigned short>
static unsigned int itk::RGBAPixel< TComponent >::GetNumberOfComponents ( )
inlinestatic

Return the number of componentsxquery-rep.

Definition at line 109 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 152 of file itkRGBAPixel.h.

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

Return the Euclidean norm of the vector defined by the RGB components. Alpha is not used.

Definition at line 115 of file itkRGBAPixel.h.

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

Aritmetic operations between pixels. Return a new RGBPixel.

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

Pass-through assignment operator for the Array base class.

template<typename TComponent = unsigned short>
RGBAPixel& itk::RGBAPixel< TComponent >::operator= ( const ComponentType  r[4])
template<typename TComponent = unsigned short>
bool itk::RGBAPixel< TComponent >::operator== ( const Self &  vec) const
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 142 of file itkRGBAPixel.h.

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

Set the Alpha component.

Definition at line 139 of file itkRGBAPixel.h.

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

Set the Blue component.

Definition at line 136 of file itkRGBAPixel.h.

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

Set the Green component.

Definition at line 133 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 127 of file itkRGBAPixel.h.

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

Set the Red component.

Definition at line 130 of file itkRGBAPixel.h.

Member Data Documentation

template<typename TComponent = unsigned short>
const unsigned int itk::RGBAPixel< TComponent >::Dimension = 4
static

Dimension of the vector space.

Definition at line 67 of file itkRGBAPixel.h.

template<typename TComponent = unsigned short>
const unsigned int itk::RGBAPixel< TComponent >::Length = 4
static

Length of the pixel.

Definition at line 70 of file itkRGBAPixel.h.


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