sitkScalarToRGBColormapImageFilter.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 sitkScalarToRGBColormapImageFilter_h
#define sitkScalarToRGBColormapImageFilter_h

/*
 * WARNING: DO NOT EDIT THIS FILE!
 * THIS FILE IS AUTOMATICALLY GENERATED BY THE SIMPLEITK BUILD PROCESS.
 * Please look at sitkImageFilterTemplate.h.in to make changes.
 */

#include <memory>

#include "sitkBasicFilters.h"
#include "sitkImageFilter.h"

namespace itk {
  namespace simple {

    class SITKBasicFilters_EXPORT ScalarToRGBColormapImageFilter : public ImageFilter<1> {
    public:
      typedef ScalarToRGBColormapImageFilter Self;

      virtual ~ScalarToRGBColormapImageFilter();

      ScalarToRGBColormapImageFilter();

      typedef BasicPixelIDTypeList  PixelIDTypeList;



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

      SITK_RETURN_SELF_TYPE_HEADER SetColormap ( ColormapType Colormap ) { this->m_Colormap = Colormap; return *this; }

        ColormapType GetColormap() const { return this->m_Colormap; }

      SITK_RETURN_SELF_TYPE_HEADER SetUseInputImageExtremaForScaling ( bool UseInputImageExtremaForScaling ) { this->m_UseInputImageExtremaForScaling = UseInputImageExtremaForScaling; return *this; }

      SITK_RETURN_SELF_TYPE_HEADER UseInputImageExtremaForScalingOn() { return this->SetUseInputImageExtremaForScaling(true); }
      SITK_RETURN_SELF_TYPE_HEADER UseInputImageExtremaForScalingOff() { return this->SetUseInputImageExtremaForScaling(false); }

        bool GetUseInputImageExtremaForScaling() const { return this->m_UseInputImageExtremaForScaling; }
      std::string GetName() const { return std::string ("ScalarToRGBColormapImageFilter"); }

      std::string ToString() const;


      Image Execute ( const Image& image1 );


      Image Execute ( const Image& image1, ScalarToRGBColormapImageFilter::ColormapType colormap, bool useInputImageExtremaForScaling );

    private:

      typedef Image (Self::*MemberFunctionType)( const Image& image1 );
      template <class TImageType> Image ExecuteInternal ( const Image& image1 );


      friend struct detail::MemberFunctionAddressor<MemberFunctionType>;

      nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;


      ColormapType  m_Colormap;
      bool  m_UseInputImageExtremaForScaling;
    };


     SITKBasicFilters_EXPORT Image ScalarToRGBColormap ( const Image& image1, ScalarToRGBColormapImageFilter::ColormapType colormap = itk::simple::ScalarToRGBColormapImageFilter::Grey, bool useInputImageExtremaForScaling = true );

  }
}
#endif