itkBlockMatchingImageFilter.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 __itkBlockMatchingImageFilter_h
#define __itkBlockMatchingImageFilter_h

#include "itkMeshToMeshFilter.h"
#include "itkImage.h"
#include "itkPointSet.h"
#include "itkVector.h"
#include "itkDefaultDynamicMeshTraits.h"


namespace itk
{
template<
  class TFixedImage,
  class TMovingImage = TFixedImage,
  class TFeatures = PointSet< Matrix< double, TFixedImage::ImageDimension, TFixedImage::ImageDimension>, TFixedImage::ImageDimension >,
  class TDisplacements = PointSet< Vector< typename TFeatures::PointType::ValueType, TFeatures::PointDimension >, TFeatures::PointDimension >,
  class TSimilarities = PointSet< double, TDisplacements::PointDimension > >
class ITK_EXPORT BlockMatchingImageFilter:
public MeshToMeshFilter< TFeatures, TDisplacements>
{
public:
  itkStaticConstMacro(ImageDimension, unsigned, TFixedImage::ImageDimension);

  typedef ImageRegion< ImageDimension >  ImageRegionType;
  typedef Size< ImageDimension >         ImageSizeType;
  typedef Index< ImageDimension >        ImageIndexType;

  typedef TFixedImage                            FixedImageType;
  typedef typename FixedImageType::ConstPointer  FixedImageConstPointer;
  typedef typename FixedImageType::PixelType     FixedImagePixelType;

  typedef TMovingImage                            MovingImageType;
  typedef typename MovingImageType::ConstPointer  MovingImageConstPointer;

  typedef TFeatures                                 FeaturePointsType;
  typedef typename FeaturePointsType::Pointer       FeaturePointsPointer;
  typedef typename FeaturePointsType::ConstPointer  FeaturePointsConstPointer;
  typedef typename FeaturePointsType::PointType     FeaturePointsPhysicalCoordinates;

  typedef TDisplacements                            DisplacementsType;
  typedef typename DisplacementsType::Pointer       DisplacementsPointer;
  typedef typename DisplacementsType::ConstPointer  DisplacementsConstPointer;
  typedef typename DisplacementsType::PixelType     DisplacementsVector;

  typedef TSimilarities                            SimilaritiesType;
  typedef typename SimilaritiesType::Pointer       SimilaritiesPointer;
  typedef typename SimilaritiesType::ConstPointer  SimilaritiesConstPointer;
  typedef typename SimilaritiesType::PixelType     SimilaritiesValue;

  typedef MeshToMeshFilter< FeaturePointsType, DisplacementsType >  Superclass;
  typedef BlockMatchingImageFilter                                  Self;
  typedef SmartPointer< Self >                                      Pointer;
  typedef SmartPointer< const Self >                                ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(BlockMatchingImageFilter, MeshToMeshFilter);

  itkSetMacro(BlockRadius, ImageSizeType);
  itkGetConstMacro(BlockRadius, ImageSizeType);

  itkSetMacro(SearchRadius, ImageSizeType);
  itkGetConstMacro(SearchRadius, ImageSizeType);

  itkSetInputMacro(FixedImage, FixedImageType);
  itkGetInputMacro(FixedImage, FixedImageType);

  itkSetInputMacro(MovingImage, MovingImageType);
  itkGetInputMacro(MovingImage, MovingImageType);

  itkSetInputMacro(FeaturePoints, FeaturePointsType);
  itkGetInputMacro(FeaturePoints, FeaturePointsType);

  inline DisplacementsType * GetDisplacements()
  {
    return dynamic_cast< DisplacementsType * >( this->ProcessObject::GetOutput( 0 ) );
  }

  inline SimilaritiesType * GetSimilarities()
  {
    return dynamic_cast< SimilaritiesType * >( this->ProcessObject::GetOutput( 1 ) );
  }

protected:
  virtual ProcessObject::DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs() const;

  using Superclass::MakeOutput;
  virtual DataObject::Pointer MakeOutput( ProcessObject::DataObjectPointerArraySizeType idx );

  virtual void AllocateOutputs();

  virtual void BeforeThreadedGenerateData();

  virtual void ThreadedGenerateData( ThreadIdType threadId ) throw ( ExceptionObject );

  virtual void AfterThreadedGenerateData();

  virtual void GenerateData();

  BlockMatchingImageFilter();
  ~BlockMatchingImageFilter();

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

  static ITK_THREAD_RETURN_TYPE ThreaderCallback(void *arg);

  struct ThreadStruct {
    Pointer Filter;
  };

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

  // algorithm parameters
  ImageSizeType  m_BlockRadius;
  ImageSizeType  m_SearchRadius;

  // temporary dynamic arrays for storing threads outputs
  SizeValueType         m_PointsCount;
  DisplacementsVector  *m_DisplacementsVectorsArray;
  SimilaritiesValue    *m_SimilaritiesValuesArray;

};
} // end namespace itk

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

#endif