itkBlockMatchingImageFilter.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 itkBlockMatchingImageFilter_h
#define itkBlockMatchingImageFilter_h
 
#include "itkMeshToMeshFilter.h"
#include "itkImage.h"
#include "itkPointSet.h"
#include "itkVector.h"
#include "itkDefaultDynamicMeshTraits.h"
 
#include <memory> // For unique_ptr.
 
namespace itk
{
 
template <
  typename TFixedImage,
  typename TMovingImage = TFixedImage,
  typename TFeatures = PointSet<Matrix<SpacePrecisionType, TFixedImage::ImageDimension, TFixedImage::ImageDimension>,
                                TFixedImage::ImageDimension>,
  class TDisplacements =
    PointSet<Vector<typename TFeatures::PointType::ValueType, TFeatures::PointDimension>, TFeatures::PointDimension>,
  class TSimilarities = PointSet<SpacePrecisionType, TDisplacements::PointDimension>>
class ITK_TEMPLATE_EXPORT BlockMatchingImageFilter : public MeshToMeshFilter<TFeatures, TDisplacements>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(BlockMatchingImageFilter);
 
  static constexpr unsigned int ImageDimension = TFixedImage::ImageDimension;

  using ImageRegionType = ImageRegion<ImageDimension>;
  using ImageSizeType = Size<ImageDimension>;
  using ImageIndexType = Index<ImageDimension>;

  using FixedImageType = TFixedImage;
  using FixedImageConstPointer = typename FixedImageType::ConstPointer;
  using FixedImagePixelType = typename FixedImageType::PixelType;

  using MovingImageType = TMovingImage;
  using MovingImageConstPointer = typename MovingImageType::ConstPointer;

  using FeaturePointsType = TFeatures;
  using FeaturePointsPointer = typename FeaturePointsType::Pointer;
  using FeaturePointsConstPointer = typename FeaturePointsType::ConstPointer;
  using FeaturePointsPhysicalCoordinates = typename FeaturePointsType::PointType;

  using DisplacementsType = TDisplacements;
  using DisplacementsPointer = typename DisplacementsType::Pointer;
  using DisplacementsConstPointer = typename DisplacementsType::ConstPointer;
  using DisplacementsVector = typename DisplacementsType::PixelType;

  using SimilaritiesType = TSimilarities;
  using SimilaritiesPointer = typename SimilaritiesType::Pointer;
  using SimilaritiesConstPointer = typename SimilaritiesType::ConstPointer;
  using SimilaritiesValue = typename SimilaritiesType::PixelType;

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

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(BlockMatchingImageFilter);

  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));
  }

  using Superclass::MakeOutput;
  DataObject::Pointer
  MakeOutput(ProcessObject::DataObjectPointerArraySizeType idx) override;
 
protected:
  void
  GenerateOutputInformation() override;

  void
  EnlargeOutputRequestedRegion(DataObject * output) override;

  virtual void
  BeforeThreadedGenerateData();
 
  virtual void
  ThreadedGenerateData(ThreadIdType threadId);

  virtual void
  AfterThreadedGenerateData();

  void
  GenerateData() override;
 
  BlockMatchingImageFilter();
  ~BlockMatchingImageFilter() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION
  ThreaderCallback(void * arg);

  struct ThreadStruct
  {
    Pointer Filter;
  };
 
private:
  // algorithm parameters
  ImageSizeType m_BlockRadius{};
  ImageSizeType m_SearchRadius{};
 
  // temporary dynamic arrays for storing threads outputs
  SizeValueType                          m_PointsCount{};
  std::unique_ptr<DisplacementsVector[]> m_DisplacementsVectorsArray;
  std::unique_ptr<SimilaritiesValue[]>   m_SimilaritiesValuesArray;
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkBlockMatchingImageFilter.hxx"
#endif
 
#endif