itkLabelOverlayImageFilter.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 itkLabelOverlayImageFilter_h
#define itkLabelOverlayImageFilter_h
 
#include "itkLabelOverlayFunctor.h"
#include "itkBinaryGeneratorImageFilter.h"
#include "itkConceptChecking.h"
 
namespace itk
{
template <typename TInputImage, typename TLabelImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT LabelOverlayImageFilter
  : public BinaryGeneratorImageFilter<TInputImage, TLabelImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(LabelOverlayImageFilter);
 
  using Self = LabelOverlayImageFilter;
 
  using Superclass = BinaryGeneratorImageFilter<TInputImage, TLabelImage, TOutputImage>;
 
  using FunctorType = Functor::LabelOverlayFunctor<typename TInputImage::PixelType,
                                                   typename TLabelImage::PixelType,
                                                   typename TOutputImage::PixelType>;
 
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using OutputImageType = TOutputImage;
  using LabelImageType = TLabelImage;
  using InputImageType = TInputImage;
 
  using OutputPixelType = typename TOutputImage::PixelType;
  using LabelPixelType = typename TLabelImage::PixelType;
  using InputPixelType = typename TInputImage::PixelType;
 
  itkOverrideGetNameOfClassMacro(LabelOverlayImageFilter);
 
  itkNewMacro(Self);
 
  void
  SetLabelImage(const TLabelImage * input);
  const LabelImageType *
  GetLabelImage() const;
  itkSetMacro(Opacity, double);
  itkGetConstReferenceMacro(Opacity, double);
  itkSetMacro(BackgroundValue, LabelPixelType);
  itkGetConstReferenceMacro(BackgroundValue, LabelPixelType);
#ifdef ITK_USE_CONCEPT_CHECKING
  // Begin concept checking
  itkConceptMacro(OutputPixelShouldHaveValueType, (Concept::HasValueType<OutputPixelType>));
  itkConceptMacro(OutputPixelShouldHaveBracketOperator,
                  (Concept::BracketOperator<OutputPixelType, unsigned int, typename OutputPixelType::ValueType>));
  // End concept checking
#endif
 
  void
  ResetColors();
 
  unsigned int
  GetNumberOfColors() const;
 
  using ComponentType = typename OutputPixelType::ComponentType;
 
  void
  AddColor(ComponentType r, ComponentType g, ComponentType b);
 
 
  itkGetConstReferenceMacro(Functor, FunctorType);
  FunctorType &
  GetFunctor()
  {
    return m_Functor;
  }
 
protected:
  LabelOverlayImageFilter();
  ~LabelOverlayImageFilter() override = default;
 
  void
  BeforeThreadedGenerateData() override;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  GenerateOutputInformation() override;
 
private:
  FunctorType    m_Functor{};
  double         m_Opacity{};
  LabelPixelType m_BackgroundValue{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkLabelOverlayImageFilter.hxx"
#endif
 
#endif