itkVariationalRegistrationElasticRegularizer.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 itkVariationalRegistrationElasticRegularizer_h
#define itkVariationalRegistrationElasticRegularizer_h

#include "itkVariationalRegistrationRegularizer.h"
#include "itkMultiThreaderBase.h"

#if defined( ITK_USE_FFTWD ) || defined( ITK_USE_FFTWF )

// other includes:
#include "itkFFTWCommon.h"

namespace itk {

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

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

  itkNewMacro(Self);

  itkTypeMacro( VariationalRegistrationElasticRegularizer, 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;
  typedef typename DisplacementFieldType::SizeType::SizeValueType
                                                             OffsetValueType;

  #if defined( ITK_USE_FFTWD )
  //Prefer to use double precision
  using RealTypeFFT = double;
  #else
    #if defined( ITK_USE_FFTWF )
      //Allow to use single precision
      #warning "Using single precision for FFT computations!"
  using RealTypeFFT = float;
    #endif
  #endif

  using FFTWProxyType = typename fftw::Proxy<RealTypeFFT>;

  itkSetMacro( Lambda, ValueType );

  itkGetConstMacro( Lambda, ValueType );

  itkSetMacro( Mu, ValueType );

  itkGetConstMacro( Mu, ValueType );

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

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

  void GenerateData() override;

  void Initialize() override;

  virtual bool InitializeElasticFFTPlans();

  virtual bool InitializeElasticMatrix();

  virtual void FreeData();

  virtual void Regularize();

  virtual void SolveElasticLES();

  virtual void ThreadedSolveElasticLES( OffsetValueType from, OffsetValueType to );

  typename DisplacementFieldType::IndexType CalculateComplexImageIndex(
      OffsetValueType offset );

private:
  ValueType m_Lambda;

  ValueType m_Mu;

  typename DisplacementFieldType::SpacingType m_Spacing;

  typename DisplacementFieldType::SizeType    m_Size;

  OffsetValueType m_TotalSize;

  typename DisplacementFieldType::SizeType    m_ComplexSize;

  OffsetValueType m_TotalComplexSize;

  OffsetValueType m_ComplexOffsetTable[ImageDimension];

  double * m_MatrixCos[ImageDimension];
  double * m_MatrixSin[ImageDimension];

  struct ElasticFFTThreadStruct
    {
    VariationalRegistrationElasticRegularizer *Filter;
    OffsetValueType totalComplexSize;
    };

  static ITK_THREAD_RETURN_TYPE SolveElasticLESThreaderCallback(void *vargs);
};

}

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

#endif
#endif