itkScalarToRGBColormapImageFilter.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkScalarToRGBColormapImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2009-05-15 12:51:13 $
  Version:   $Revision: 1.2 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkScalarToRGBColormapImageFilter_h
#define __itkScalarToRGBColormapImageFilter_h

#include "itkImageToImageFilter.h"

#include "itkColormapFunctor.h"

namespace itk
{

template <class TInputImage, class TOutputImage>
class ITK_EXPORT ScalarToRGBColormapImageFilter
: public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  typedef ScalarToRGBColormapImageFilter                 Self;
  typedef ImageToImageFilter<TInputImage, TOutputImage>  Superclass;
  typedef SmartPointer<Self>                             Pointer;
  typedef SmartPointer<const Self>                       ConstPointer;

  itkNewMacro( Self );

  itkTypeMacro( ScalarToRGBColormapImageFilter, ImageToImageFilter );

  typedef TInputImage                                    InputImageType;
  typedef typename InputImageType::ConstPointer          InputImagePointer;
  typedef typename InputImageType::RegionType            InputImageRegionType;
  typedef typename InputImageType::PixelType             InputImagePixelType;
  typedef TOutputImage                                   OutputImageType;
  typedef typename OutputImageType::Pointer              OutputImagePointer;
  typedef typename OutputImageType::RegionType           OutputImageRegionType;
  typedef typename OutputImageType::PixelType            OutputImagePixelType;

  typedef Functor::ColormapFunctor<InputImagePixelType,
    OutputImagePixelType>                                ColormapType;

  typename ColormapType::Pointer GetColormap() { return m_Colormap; }

  void SetColormap( ColormapType *colormap )
    {
    if ( m_Colormap != colormap )
      {
      m_Colormap = colormap;
      this->Modified();
      }
    }

  typedef enum { Red, Green, Blue, Grey, Hot, Cool, Spring, Summer,
    Autumn, Winter, Copper, Jet, HSV, OverUnder } ColormapEnumType;

  void SetColormap( ColormapEnumType );

  itkSetMacro( UseInputImageExtremaForScaling, bool );
  itkGetConstMacro( UseInputImageExtremaForScaling, bool );
  itkBooleanMacro( UseInputImageExtremaForScaling );

protected:
  ScalarToRGBColormapImageFilter();
  virtual ~ScalarToRGBColormapImageFilter() {};

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

  void ThreadedGenerateData( const OutputImageRegionType& outputRegionForThread,
                             int threadId );

  void BeforeThreadedGenerateData();

private:
  ScalarToRGBColormapImageFilter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  typename ColormapType::Pointer     m_Colormap;

  bool                               m_UseInputImageExtremaForScaling;
};

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkScalarToRGBColormapImageFilter.txx"
#endif

#endif