itkVariationalRegistrationStopCriterion.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 itkVariationalRegistrationStopCriterion_h
#define itkVariationalRegistrationStopCriterion_h

#include "itkCommand.h"
#include "itkEventObject.h"

#include "itkVariationalRegistrationFilter.h"
#include "itkVariationalRegistrationMultiResolutionFilter.h"

namespace itk {

template< typename TRegistrationFilter, typename TMRFilter >
class VariationalRegistrationStopCriterion
  : public Command
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(VariationalRegistrationStopCriterion);

  using Self = VariationalRegistrationStopCriterion;
  using Superclass = Command;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  using RegistrationFilterType = TRegistrationFilter;
  using MRFilterType = TMRFilter;

  itkNewMacro(Self);

  itkSetMacro( IterationModulus, int );

  itkGetMacro( IterationModulus, int );

  itkSetMacro( PerformIncreaseCountCheck, bool );
  itkGetMacro( PerformIncreaseCountCheck, bool );
  itkBooleanMacro( PerformIncreaseCountCheck );

  itkSetMacro( MaximumIncreaseCount, int );

  itkGetMacro( MaximumIncreaseCount, int );

  itkSetMacro( PerformLineFittingCheck, bool );
  itkGetMacro( PerformLineFittingCheck, bool );
  itkBooleanMacro( PerformLineFittingCheck );

  itkSetMacro( PerformLineFittingMaxDistanceCheck, bool );
  itkGetMacro( PerformLineFittingMaxDistanceCheck, bool );
  itkBooleanMacro( PerformLineFittingMaxDistanceCheck );

  itkSetMacro( LineFittingUseAbsoluteValues, bool );
  itkGetMacro( LineFittingUseAbsoluteValues, bool );
  itkBooleanMacro( LineFittingUseAbsoluteValues );

  virtual void SetNumberOfFittingIterations( const int it );

  itkGetMacro( NumberOfFittingIterations, int );

  itkSetMacro( RegressionLineSlopeThreshold, double );

  itkGetMacro( RegressionLineSlopeThreshold, double );

  itkSetMacro( MaxDistanceToRegressionLine, double );

  itkGetMacro( MaxDistanceToRegressionLine, double );

  enum LineFittingMode {
    LINE_FITTING_MODE_ORIGINAL = 0,
    LINE_FITTING_MODE_NORMALIZED = 1,
    LINE_FITTING_MODE_SCALED = 2
  };

  itkSetEnumMacro( LineFittingMode, LineFittingMode );

  itkGetEnumMacro( LineFittingMode, LineFittingMode );

  virtual void SetLineFittingModeToOriginalValues()
    { this->SetLineFittingMode( LINE_FITTING_MODE_ORIGINAL ); }

  virtual void SetLineFittingModeToNormalizedValues()
    { this->SetLineFittingMode( LINE_FITTING_MODE_NORMALIZED ); }

  virtual void SetLineFittingModeToScaledValues()
    { this->SetLineFittingMode( LINE_FITTING_MODE_SCALED ); }

  enum MultiResolutionPolicy {
    MULTI_RESOLUTION_POLICY_DEFAULT = 0,
    MULTI_RESOLUTION_POLICY_SIMPLE_GRADUATED = 1,
    MULTI_RESOLUTION_POLICY_GRADUATED = 2
  };

  itkSetEnumMacro( MultiResolutionPolicy, MultiResolutionPolicy );

  itkGetEnumMacro( MultiResolutionPolicy, MultiResolutionPolicy );

  virtual void SetMultiResolutionPolicyToDefault()
    { this->SetMultiResolutionPolicy( MULTI_RESOLUTION_POLICY_DEFAULT ); }

  virtual void SetMultiResolutionPolicyToSimpleGraduated()
    { this->SetMultiResolutionPolicy( MULTI_RESOLUTION_POLICY_SIMPLE_GRADUATED ); }

  virtual void SetMultiResolutionPolicyToGraduated()
    { this->SetMultiResolutionPolicy( MULTI_RESOLUTION_POLICY_GRADUATED ); }

  void Execute( itk::Object *caller, const itk::EventObject & event ) override;

  void Execute( const itk::Object *caller, const itk::EventObject & event ) override;

protected:
  VariationalRegistrationStopCriterion();
  ~VariationalRegistrationStopCriterion() override;

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

  virtual void SetModeForNextLevel(
      const unsigned int nextLevel, const unsigned int numberOfLevels );

  virtual void SetNextMetricValue( const double value );

  virtual void ResetFittingData();

  virtual bool CheckStopRegistration();

  virtual void FitLine( const double *const x, const double *const y,
      const int n, double *m, double *b);

private:
  // Stop criterion multi-resolution policy.
  MultiResolutionPolicy m_MultiResolutionPolicy;

  // General parameter.
  int                   m_IterationModulus;  // Only check every mod iterations.
  int                   m_ElapsedIterations; // The number of elapsed iterations.

  // Member for increase count calculation.
  bool                  m_PerformIncreaseCountCheck; // Perform increase count check?

  int                   m_CurrentIncreaseCount;
  int                   m_MaximumIncreaseCount;

  double                m_MaxMetricValue;    // Stores max metric value.
  double                m_MinMetricValue;    // Stores min metric value.

  // Member for line fitting.
  bool                  m_PerformLineFittingCheck;
  bool                  m_PerformLineFittingMaxDistanceCheck;
  bool                  m_LineFittingUseAbsoluteValues; // Use absolute values for line fitting.

  LineFittingMode       m_LineFittingMode;      // Mode for the line fitting.

  int                   m_NumberOfFittingIterations;
  double                m_RegressionLineSlopeThreshold;
  double                m_MaxDistanceToRegressionLine;

  // Distance and iteration array.
  double*               m_DistanceArray;
  double*               m_IterationArray;
  double*               m_DistanceArrayForFitting;
};

} // end namespace itk

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

#endif