itkLabelOverlayImageFilter.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkLabelOverlayImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2009-07-07 12:27:33 $
  Version:   $Revision: 1.16 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkLabelOverlayImageFilter_h
#define __itkLabelOverlayImageFilter_h

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

namespace itk
{
template <typename  TInputImage, class TLabelImage, typename  TOutputImage>
class ITK_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

  itkConceptMacro(OutputHasPixelTraitsCheck,
    (Concept::HasPixelTraits<OutputPixelType>));
  itkConceptMacro(OutputPixelShouldHaveValueType,
    (Concept::HasValueType<OutputPixelType>));
  itkConceptMacro(OutputPixelShouldHaveBracketOperator,
    (Concept::BracketOperator<
        OutputPixelType, 
        unsigned int,
        typename OutputPixelType::ValueType>));

#endif

  void ResetColors();

  unsigned int GetNumberOfColors() const;

  typedef typename OutputPixelType::ComponentType ComponentType;

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

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

  void BeforeThreadedGenerateData(void);

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

private:
  LabelOverlayImageFilter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  double                        m_Opacity;
  LabelPixelType                m_BackgroundValue;

};


  
} // end namespace itk
  
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkLabelOverlayImageFilter.txx"
#endif

#endif