itkLabelToRGBImageFilter.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 itkLabelToRGBImageFilter_h
#define itkLabelToRGBImageFilter_h
 
#include "itkUnaryFunctorImageFilter.h"
#include "itkLabelToRGBFunctor.h"
 
namespace itk
{
template <typename TLabelImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT LabelToRGBImageFilter
  : public UnaryFunctorImageFilter<
      TLabelImage,
      TOutputImage,
      Functor::LabelToRGBFunctor<typename TLabelImage::PixelType, typename TOutputImage::PixelType>>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(LabelToRGBImageFilter);

  using Self = LabelToRGBImageFilter;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using Superclass = UnaryFunctorImageFilter<
    TLabelImage,
    TOutputImage,
    Functor::LabelToRGBFunctor<typename TLabelImage::PixelType, typename TOutputImage::PixelType>>;
 
  using OutputImageType = TOutputImage;
  using LabelImageType = TLabelImage;
 
  using OutputPixelType = typename TOutputImage::PixelType;
  using LabelPixelType = typename TLabelImage::PixelType;
  using OutputPixelValueType = typename NumericTraits<OutputPixelType>::ValueType;

  itkOverrideGetNameOfClassMacro(LabelToRGBImageFilter);

  itkNewMacro(Self);

  itkSetMacro(BackgroundValue, LabelPixelType);
  itkGetConstReferenceMacro(BackgroundValue, LabelPixelType);

  itkSetMacro(BackgroundColor, OutputPixelType);
  itkGetConstReferenceMacro(BackgroundColor, OutputPixelType);

  void
  ResetColors();

  unsigned int
  GetNumberOfColors() const;

  using ComponentType = typename OutputPixelType::ComponentType;

  void
  AddColor(ComponentType r, ComponentType g, ComponentType b);
 
protected:
  LabelToRGBImageFilter();
  ~LabelToRGBImageFilter() override = default;

  void
  BeforeThreadedGenerateData() override;

  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  GenerateOutputInformation() override;
 
private:
  OutputPixelType m_BackgroundColor{};
  LabelPixelType  m_BackgroundValue{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkLabelToRGBImageFilter.hxx"
#endif
 
#endif