itkVariationalSymmetricDiffeomorphicRegistrationFilter.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 itkVariationalSymmetricDiffeomorphicRegistrationFilter_h
#define itkVariationalSymmetricDiffeomorphicRegistrationFilter_h

#include "itkVariationalDiffeomorphicRegistrationFilter.h"

namespace itk {

template< typename TFixedImage, typename TMovingImage, typename TDisplacementField>
class VariationalSymmetricDiffeomorphicRegistrationFilter
  : public VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(VariationalSymmetricDiffeomorphicRegistrationFilter);

  using Self = VariationalSymmetricDiffeomorphicRegistrationFilter;
  using Superclass = VariationalDiffeomorphicRegistrationFilter<
      TFixedImage, TMovingImage, TDisplacementField >;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkNewMacro(Self);

  itkTypeMacro( VariationalSymmetricDiffeomorphicRegistrationFilter,
    VariationalDiffeomorphicRegistrationFilter);

  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;

  using FixedImageType = TFixedImage;
  using FixedImagePointer = typename FixedImageType::Pointer;
  using FixedImageConstPointer = typename FixedImageType::ConstPointer;

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

  using DisplacementFieldType = TDisplacementField;
  using DisplacementFieldPointer = typename DisplacementFieldType::Pointer;

  using OutputImageType = typename Superclass::OutputImageType;
  using UpdateBufferType = OutputImageType;

  using RegistrationFunctionType = typename Superclass::RegistrationFunctionType;

  using RegularizerType = typename Superclass::RegularizerType;

  using TimeStepType = typename Superclass::TimeStepType;

  itkGetModifiableObjectMacro( InverseDisplacementField, DisplacementFieldType );

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

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

  void Initialize() override;

  virtual void InitializeBackwardIteration();

  void ApplyUpdate( const TimeStepType& dt ) override;

  TimeStepType CalculateChange() override;

  virtual void CalcInverseDeformationFromVelocityField( const DisplacementFieldType * velocityField );

  itkGetModifiableObjectMacro( BackwardUpdateBuffer, UpdateBufferType );

  using ThreadRegionType = typename UpdateBufferType::RegionType;

  void ThreadedApplyUpdate( const TimeStepType &dt,
                                    const ThreadRegionType &regionToProcess,
                                    unsigned int threadId ) override;

private:
  using FieldExponentiatorType = typename Superclass::FieldExponentiatorType;
  using FieldExponentiatorPointer = typename FieldExponentiatorType::Pointer;

  FieldExponentiatorPointer            m_InverseExponentiator;
  DisplacementFieldPointer             m_InverseDisplacementField;
  typename UpdateBufferType::Pointer   m_BackwardUpdateBuffer;

};

}// end namespace itk

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

#endif