itkSimilarityIndexImageFilter.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkSimilarityIndexImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2009-04-25 12:28:09 $
  Version:   $Revision: 1.10 $

  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 __itkSimilarityIndexImageFilter_h
#define __itkSimilarityIndexImageFilter_h

#include "itkImageToImageFilter.h"
#include "itkNumericTraits.h"
#include "itkArray.h"

namespace itk {

template<class TInputImage1, class TInputImage2>
class ITK_EXPORT SimilarityIndexImageFilter : 
    public ImageToImageFilter<TInputImage1, TInputImage1>
{
public:
  typedef SimilarityIndexImageFilter                     Self;
  typedef ImageToImageFilter<TInputImage1,TInputImage1>  Superclass;
  typedef SmartPointer<Self>                             Pointer;
  typedef SmartPointer<const Self>                       ConstPointer;

  itkNewMacro(Self);  

  itkTypeMacro(SimilarityIndexImageFilter, ImageToImageFilter);

  typedef TInputImage1                        InputImage1Type;
  typedef TInputImage2                        InputImage2Type;
  typedef typename TInputImage1::Pointer      InputImage1Pointer;
  typedef typename TInputImage2::Pointer      InputImage2Pointer;
  typedef typename TInputImage1::ConstPointer InputImage1ConstPointer;
  typedef typename TInputImage2::ConstPointer InputImage2ConstPointer;

  typedef typename TInputImage1::RegionType RegionType;
  typedef typename TInputImage1::SizeType   SizeType;
  typedef typename TInputImage1::IndexType  IndexType;

  typedef typename TInputImage1::PixelType InputImage1PixelType;
  typedef typename TInputImage2::PixelType InputImage2PixelType;
  
  itkStaticConstMacro(ImageDimension, unsigned int,
                      TInputImage1::ImageDimension );

  typedef typename NumericTraits<InputImage1PixelType>::RealType RealType;

  void SetInput1( const InputImage1Type * image )
    { this->SetInput( image ); }

  void SetInput2( const InputImage2Type * image );

  const InputImage1Type * GetInput1(void)
    { return this->GetInput(); }

  const InputImage2Type * GetInput2(void);

  itkGetConstMacro(SimilarityIndex,RealType);

#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro(Input1HasNumericTraitsCheck,
                  (Concept::HasNumericTraits<InputImage1PixelType>));
  itkConceptMacro(Input2HasNumericTraitsCheck,
                  (Concept::HasNumericTraits<InputImage2PixelType>));

#endif

protected:
  SimilarityIndexImageFilter();
  ~SimilarityIndexImageFilter(){};
  void PrintSelf(std::ostream& os, Indent indent) const;

  void AllocateOutputs();

  void BeforeThreadedGenerateData ();

  void AfterThreadedGenerateData ();

  void  ThreadedGenerateData (const RegionType& 
                              outputRegionForThread,
                              int threadId);

  // Override since the filter needs all the data for the algorithm
  void GenerateInputRequestedRegion();

  // Override since the filter produces all of its output
  void EnlargeOutputRequestedRegion(DataObject *data);

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

  RealType m_SimilarityIndex;

  Array<unsigned long> m_CountOfImage1;
  Array<unsigned long> m_CountOfImage2;
  Array<unsigned long> m_CountOfIntersection;

}; // end of class

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

#endif