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

itkRGBAPixel.h

Go to the documentation of this file.
00001 /*=========================================================================
00002 
00003   Program:   Insight Segmentation & Registration Toolkit
00004   Module:    $RCSfile: itkRGBAPixel.h,v $
00005   Language:  C++
00006   Date:      $Date: 2009-07-31 12:54:40 $
00007   Version:   $Revision: 1.22 $
00008 
00009   Copyright (c) Insight Software Consortium. All rights reserved.
00010   See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
00011 
00012      This software is distributed WITHOUT ANY WARRANTY; without even 
00013      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
00014      PURPOSE.  See the above copyright notices for more information.
00015 
00016 =========================================================================*/
00017 #ifndef __itkRGBAPixel_h
00018 #define __itkRGBAPixel_h
00019 
00020 // Undefine an eventual RGBAPixel macro
00021 #ifdef RGBAPixel
00022 #undef RGBAPixel
00023 #endif
00024 
00025 #include <itkIndent.h>
00026 #include <itkFixedArray.h>
00027 #include "vnl/vnl_math.h"
00028 
00029 namespace itk
00030 {
00031 
00051 template < typename TComponent = unsigned short >
00052 class RGBAPixel: public FixedArray<TComponent,4>
00053 {
00054 public:
00056   typedef RGBAPixel                 Self;
00057   typedef FixedArray<TComponent, 4> Superclass;
00058 
00060 #if defined(__BORLANDC__)
00061   enum {Dimension = 4};
00062 #else
00063   itkStaticConstMacro(Dimension, unsigned int, 4);
00064 #endif
00065 
00066 
00068 #if defined(__BORLANDC__)
00069   enum {Length = 4};
00070 #else
00071   itkStaticConstMacro(Length, unsigned int, 4);
00072 #endif
00073 
00074 
00076   typedef FixedArray<TComponent, 4> BaseArray;
00077 
00079   typedef TComponent ComponentType;
00080 
00082   RGBAPixel() {this->Fill(0);}
00083   RGBAPixel (const ComponentType& r)
00084     { this->Fill(r);}
00086 
00088   template< class TRGBAPixelValueType >
00089   RGBAPixel(const RGBAPixel< TRGBAPixelValueType >& r): BaseArray(r) {}
00090   RGBAPixel(const ComponentType  r[4]): BaseArray(r) {}  
00092 
00094   RGBAPixel& operator= (const Self& r);
00095   RGBAPixel& operator= (const ComponentType r[4]);
00097 
00099   static unsigned int GetNumberOfComponents(){ return 4;}
00100 
00102   ComponentType GetNthComponent(int c) const
00103     { return this->operator[](c); }
00104 
00106   ComponentType GetScalarValue() const
00107     {
00108     return static_cast<ComponentType> (vcl_sqrt(
00109                                          static_cast<double>(this->operator[](0)) * static_cast<double>(this->operator[](0)) +
00110                                          static_cast<double>(this->operator[](1)) * static_cast<double>(this->operator[](1)) +
00111                                          static_cast<double>(this->operator[](2)) * static_cast<double>(this->operator[](2)))); 
00112     }
00113 
00115   void SetNthComponent(int c, const ComponentType& v)  
00116     {  this->operator[](c) = v; }
00117 
00119   void SetRed( ComponentType red ) { this->operator[](0) = red;}
00120 
00122   void SetGreen( ComponentType green ) {this->operator[](1) = green;}
00123 
00125   void SetBlue( ComponentType blue ) {this->operator[](2) = blue;}
00126 
00128   void SetAlpha( ComponentType alpha ) {this->operator[](3) = alpha;}
00129 
00131   void Set( ComponentType red, ComponentType green, ComponentType blue, ComponentType alpha )
00132     { this->operator[](0) = red; this->operator[](1) = green; this->operator[](2) = blue; this->operator[](3) = alpha;}
00133 
00135   const ComponentType & GetRed( void ) const { return this->operator[](0);}
00136 
00138   const ComponentType & GetGreen( void ) const { return this->operator[](1);}
00139 
00141   const ComponentType & GetBlue( void ) const { return this->operator[](2);}
00142 
00144   const ComponentType & GetAlpha( void ) const { return this->operator[](3);}
00145 
00147   ComponentType GetLuminance( void ) const;
00148 };
00149 
00150 
00151 template< typename TComponent  >  
00152 ITK_EXPORT std::ostream& operator<<(std::ostream& os, 
00153                                     const RGBAPixel<TComponent> & c); 
00154 
00155 template< typename TComponent  >  
00156 ITK_EXPORT std::istream& operator>>(std::istream& is, 
00157                                           RGBAPixel<TComponent> & c); 
00158 
00159 } // end namespace itk
00160 
00161 // Define instantiation macro for this template.
00162 #define ITK_TEMPLATE_RGBAPixel(_, EXPORT, x, y) namespace itk { \
00163   _(1(class EXPORT RGBAPixel< ITK_TEMPLATE_1 x >)) \
00164   namespace Templates { typedef RGBAPixel< ITK_TEMPLATE_1 x > RGBAPixel##y; } \
00165   }
00166 
00167 #if ITK_TEMPLATE_EXPLICIT
00168 # include "Templates/itkRGBAPixel+-.h"
00169 #endif
00170 
00171 //
00172 // Numeric traits must be included after (optionally) including the explicit
00173 // instantiations control of this class, in case the implicit instantiation
00174 // needs to be disabled. 
00175 //
00176 // NumericTraits must be included before (optionally) including the .txx file,
00177 // in case the .txx requires to use NumericTraits.
00178 //
00179 #include "itkNumericTraitsRGBAPixel.h"
00180 
00181 #if ITK_TEMPLATE_TXX
00182 # include "itkRGBAPixel.txx"
00183 #endif
00184 
00185 #endif
00186 

Generated at Mon Jul 12 2010 19:40:50 for ITK by doxygen 1.7.1 written by Dimitri van Heesch, © 1997-2000