itkVariationalRegistrationDiffusionRegularizer.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 itkVariationalRegistrationDiffusionRegularizer_h
#define itkVariationalRegistrationDiffusionRegularizer_h

#include "itkVariationalRegistrationRegularizer.h"

namespace itk {

template< typename TDisplacementField >
class VariationalRegistrationDiffusionRegularizer
  : public VariationalRegistrationRegularizer< TDisplacementField >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(VariationalRegistrationDiffusionRegularizer);

  using Self = VariationalRegistrationDiffusionRegularizer;
  using Superclass = VariationalRegistrationRegularizer<
      TDisplacementField >;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkNewMacro(Self);

  itkTypeMacro( VariationalRegistrationDiffusionRegularizer, 
    VariationalRegistrationRegularizer);

  static constexpr unsigned int ImageDimension = TDisplacementField::ImageDimension;

  using DisplacementFieldType = typename Superclass::DisplacementFieldType;
  using DisplacementFieldPointer = typename Superclass::DisplacementFieldPointer;
  using DisplacementFieldConstPointer = typename Superclass::DisplacementFieldConstPointer;
  using PixelType = typename Superclass::PixelType;
  using ValueType = typename Superclass::ValueType;

  using BufferImageType = Image<ValueType, ImageDimension>;
  using BufferImagePointer = typename BufferImageType::Pointer;
  using BufferImageRegionType = typename BufferImageType::RegionType;

  itkSetMacro( Alpha, ValueType );

  itkGetConstMacro( Alpha, ValueType );

protected:
  VariationalRegistrationDiffusionRegularizer();
  ~VariationalRegistrationDiffusionRegularizer() override {}

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

  void GenerateData() override;

  void Initialize() override;

  virtual void InitLUMatrices( ValueType** alpha, ValueType** beta,
      ValueType** gamma, int n, int dim );

  virtual void RegularizeComponent( const int component );

  struct CalcBufferThreadStruct
  {
    VariationalRegistrationDiffusionRegularizer *Filter;
    unsigned int component;        // The current dimension.
    BufferImagePointer bPtr;       // Pointer to the image buffer.
  };

  struct RegularizeThreadStruct
  {
    VariationalRegistrationDiffusionRegularizer *Filter;
    unsigned int direction;        // Current direction.
    ValueType* alpha;              // Pointer to matrix diagonal.
    ValueType* beta;               // Pointer to matrix subdiagonal.
    ValueType* gamma;              // Pointer to matrix superdiagonal.
    BufferImagePointer bPtr;       // Pointer to force field image buffer.
    BufferImagePointer vPtr;       // Pointer to temporal result image buffer.
  };

  struct MergeDirectionsThreadStruct
  {
    VariationalRegistrationDiffusionRegularizer *Filter;
    unsigned int component;        // The current dimension.
    BufferImagePointer* vPtr;      // Pointer to temporal image buffers.
  };

  static ITK_THREAD_RETURN_TYPE CalcBufferCallback( void *arg );

  static ITK_THREAD_RETURN_TYPE RegularizeDirectionCallback( void *arg );

  static ITK_THREAD_RETURN_TYPE MergeDirectionsCallback( void *arg );

  virtual int SplitBoundaryFaceRegion( int i, int num, int inDir,
      BufferImageRegionType& splitRegion );

private:
  ValueType m_Alpha;

  typename DisplacementFieldType::SizeType m_Size;

  typename DisplacementFieldType::SpacingType m_Spacing;

  // Attributes for AOS calculation
  BufferImagePointer m_BufferImage;

  BufferImagePointer m_V[ImageDimension];

  ValueType* m_MatrixAlpha[ImageDimension];

  ValueType* m_MatrixBeta[ImageDimension];

  ValueType* m_MatrixGamma[ImageDimension];
};

}

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

#endif