itkScalarToRGBColormapImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 itkScalarToRGBColormapImageFilter_h
#define itkScalarToRGBColormapImageFilter_h
 
#include "itkImageToImageFilter.h"
#include "itkColormapFunction.h"
#include "ITKColormapExport.h"
 
namespace itk
{
class ScalarToRGBColormapImageFilterEnums
{
public:
  enum class RGBColormapFilter : uint8_t
  {
    Red,
    Green,
    Blue,
    Grey,
    Hot,
    Cool,
    Spring,
    Summer,
    Autumn,
    Winter,
    Copper,
    Jet,
    HSV,
    OverUnder
  };
};
#if !defined(ITK_LEGACY_REMOVE)
using RGBColormapFilterEnum = ScalarToRGBColormapImageFilterEnums::RGBColormapFilter;
using RGBColormapFilterEnumType = ScalarToRGBColormapImageFilterEnums::RGBColormapFilter;
// We need to expose the enum values at the class level
// for backwards compatibility
static constexpr RGBColormapFilterEnum Red = RGBColormapFilterEnum::Red;
static constexpr RGBColormapFilterEnum Green = RGBColormapFilterEnum::Green;
static constexpr RGBColormapFilterEnum Blue = RGBColormapFilterEnum::Blue;
static constexpr RGBColormapFilterEnum Grey = RGBColormapFilterEnum::Grey;
static constexpr RGBColormapFilterEnum Hot = RGBColormapFilterEnum::Hot;
static constexpr RGBColormapFilterEnum Cool = RGBColormapFilterEnum::Cool;
static constexpr RGBColormapFilterEnum Spring = RGBColormapFilterEnum::Spring;
static constexpr RGBColormapFilterEnum Summer = RGBColormapFilterEnum::Summer;
static constexpr RGBColormapFilterEnum Autumn = RGBColormapFilterEnum::Autumn;
static constexpr RGBColormapFilterEnum Winter = RGBColormapFilterEnum::Winter;
static constexpr RGBColormapFilterEnum Copper = RGBColormapFilterEnum::Copper;
static constexpr RGBColormapFilterEnum Jet = RGBColormapFilterEnum::Jet;
static constexpr RGBColormapFilterEnum HSV = RGBColormapFilterEnum::HSV;
static constexpr RGBColormapFilterEnum OverUnder = RGBColormapFilterEnum::OverUnder;
#endif
extern ITKColormap_EXPORT std::ostream &
operator<<(std::ostream & out, const ScalarToRGBColormapImageFilterEnums::RGBColormapFilter value);

template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT ScalarToRGBColormapImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ScalarToRGBColormapImageFilter);

  using Self = ScalarToRGBColormapImageFilter;
  using Superclass = ImageToImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ScalarToRGBColormapImageFilter);

  using InputImageType = TInputImage;
  using InputImagePointer = typename InputImageType::ConstPointer;
  using InputImageRegionType = typename InputImageType::RegionType;
  using InputImagePixelType = typename InputImageType::PixelType;
  using OutputImageType = TOutputImage;
  using OutputImagePointer = typename OutputImageType::Pointer;
  using OutputImageRegionType = typename OutputImageType::RegionType;
  using OutputImagePixelType = typename OutputImageType::PixelType;
 
  using ColormapType = Function::ColormapFunction<InputImagePixelType, OutputImagePixelType>;
 
  using RGBColormapFilterEnum = ScalarToRGBColormapImageFilterEnums::RGBColormapFilter;
#if !defined(ITK_LEGACY_REMOVE)
  using ColormapEnumType = RGBColormapFilterEnum;
#endif
 
#if !defined(ITK_LEGACY_REMOVE)
  // We need to expose the enum values at the class level
  // for backwards compatibility
  static constexpr RGBColormapFilterEnum Red = RGBColormapFilterEnum::Red;
  static constexpr RGBColormapFilterEnum Green = RGBColormapFilterEnum::Green;
  static constexpr RGBColormapFilterEnum Blue = RGBColormapFilterEnum::Blue;
  static constexpr RGBColormapFilterEnum Grey = RGBColormapFilterEnum::Grey;
  static constexpr RGBColormapFilterEnum Hot = RGBColormapFilterEnum::Hot;
  static constexpr RGBColormapFilterEnum Cool = RGBColormapFilterEnum::Cool;
  static constexpr RGBColormapFilterEnum Spring = RGBColormapFilterEnum::Spring;
  static constexpr RGBColormapFilterEnum Summer = RGBColormapFilterEnum::Summer;
  static constexpr RGBColormapFilterEnum Autumn = RGBColormapFilterEnum::Autumn;
  static constexpr RGBColormapFilterEnum Winter = RGBColormapFilterEnum::Winter;
  static constexpr RGBColormapFilterEnum Copper = RGBColormapFilterEnum::Copper;
  static constexpr RGBColormapFilterEnum Jet = RGBColormapFilterEnum::Jet;
  static constexpr RGBColormapFilterEnum HSV = RGBColormapFilterEnum::HSV;
  static constexpr RGBColormapFilterEnum OverUnder = RGBColormapFilterEnum::OverUnder;
#endif

  itkSetObjectMacro(Colormap, ColormapType);
  itkGetModifiableObjectMacro(Colormap, ColormapType);
  void SetColormap(RGBColormapFilterEnum);

  itkSetMacro(UseInputImageExtremaForScaling, bool);
  itkGetConstMacro(UseInputImageExtremaForScaling, bool);
  itkBooleanMacro(UseInputImageExtremaForScaling);
protected:
  ScalarToRGBColormapImageFilter();
  ~ScalarToRGBColormapImageFilter() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  GenerateOutputInformation() override
  {
    Superclass::GenerateOutputInformation();
    OutputImageType * output = this->GetOutput();
 
    if (!output)
    {
      return;
    }
    if (output->GetNumberOfComponentsPerPixel() != 3)
    {
      output->SetNumberOfComponentsPerPixel(3);
    }
  }

  void
  DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;

  void
  BeforeThreadedGenerateData() override;
 
private:
private:
  typename ColormapType::Pointer m_Colormap{};
 
  bool m_UseInputImageExtremaForScaling{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkScalarToRGBColormapImageFilter.hxx"
#endif
 
#endif