itkLabelOverlayImageFilter.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 itkLabelOverlayImageFilter_h
#define itkLabelOverlayImageFilter_h

#include "itkLabelOverlayFunctor.h"
#include "itkBinaryFunctorImageFilter.h"
#include "itkConceptChecking.h"

namespace itk
{
template< typename  TInputImage, typename TLabelImage, typename  TOutputImage >
class ITK_TEMPLATE_EXPORT LabelOverlayImageFilter:
  public
  BinaryFunctorImageFilter< TInputImage, TLabelImage, TOutputImage,
                            Functor::LabelOverlayFunctor<
                              typename TInputImage::PixelType,
                              typename TLabelImage::PixelType,
                              typename TOutputImage::PixelType >   >
{
public:
  typedef LabelOverlayImageFilter Self;

  typedef BinaryFunctorImageFilter< TInputImage, TLabelImage, TOutputImage,
                                    Functor::LabelOverlayFunctor<
                                      typename TInputImage::PixelType,
                                      typename TLabelImage::PixelType,
                                      typename TOutputImage::PixelType >   >  Superclass;

  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  typedef TOutputImage OutputImageType;
  typedef TLabelImage  LabelImageType;
  typedef TInputImage  InputImageType;

  typedef typename TOutputImage::PixelType OutputPixelType;
  typedef typename TLabelImage::PixelType  LabelPixelType;
  typedef typename TInputImage::PixelType  InputPixelType;

  itkTypeMacro(LabelOverlayImageFilter, BinaryFunctorImageFilter);

  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;

  typedef typename OutputPixelType::ComponentType ComponentType;

  void AddColor(ComponentType r, ComponentType g, ComponentType b);

protected:
  LabelOverlayImageFilter();
  virtual ~LabelOverlayImageFilter() ITK_OVERRIDE {}

  void BeforeThreadedGenerateData() ITK_OVERRIDE;

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

  void GenerateOutputInformation() ITK_OVERRIDE;

private:
  ITK_DISALLOW_COPY_AND_ASSIGN(LabelOverlayImageFilter);

  double         m_Opacity;
  LabelPixelType m_BackgroundValue;
};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkLabelOverlayImageFilter.hxx"
#endif

#endif