itkColorTable.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef __itkColorTable_h
#define __itkColorTable_h

#include "itkObject.h"
#include "itkRGBPixel.h"
#include "itkObjectFactory.h"

#include <string>
#include <vector>
namespace itk
{
template< class TPixel >
class ITK_EXPORT ColorTable:public Object
{
public:
  typedef ColorTable                 Self;
  typedef Object                     Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(ColorTable, Object);

  void    UseDiscreteColors(void);

  void    UseGrayColors(unsigned int n = 256);

  void    UseHeatColors(unsigned int n = 256);

  void    UseRandomColors(unsigned int n = 256);

  itkGetConstMacro(NumberOfColors, unsigned int);

  RGBPixel< TPixel > GetColor(unsigned int colorId);

  bool    SetColor(unsigned int c, TPixel r, TPixel g, TPixel b,
                   const char *name = "UserDefined");
  bool    SetColor(unsigned int c, RGBPixel<TPixel> pixel,
                   const char *name = "UserDefined");

  TPixel  GetColorComponent(unsigned int colorId, char rgb);

  std::string  GetColorName(unsigned int colorId);

  unsigned int GetClosestColorTableId(TPixel r, TPixel g, TPixel b);

protected:
  ColorTable();
  void PrintSelf(std::ostream & os, Indent indent) const;

  unsigned int m_NumberOfColors;

  std::vector<std::string>         m_ColorName;
  std::vector<RGBPixel< TPixel > > m_Color;
private:
  ColorTable(const Self &);     //purposely not implemented
  void operator=(const Self &); //purposely not implemented

  void DeleteColors();
};
} // namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_ColorTable(_, EXPORT, TypeX, TypeY)     \
  namespace itk                                              \
  {                                                          \
  _( 1 ( class EXPORT ColorTable< ITK_TEMPLATE_1 TypeX > ) ) \
  namespace Templates                                        \
  {                                                          \
  typedef ColorTable< ITK_TEMPLATE_1 TypeX >                 \
  ColorTable##TypeY;                                       \
  }                                                          \
  }

#if ITK_TEMPLATE_EXPLICIT
#include "Templates/itkColorTable+-.h"
#endif

#if ITK_TEMPLATE_TXX
#include "itkColorTable.hxx"
#endif

#endif