itkVariationalRegistrationGaussianRegularizer.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 itkVariationalRegistrationGaussianRegularizer_h
#define itkVariationalRegistrationGaussianRegularizer_h

#include "itkVariationalRegistrationRegularizer.h"

namespace itk {

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

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

  itkNewMacro(Self);

  itkTypeMacro( VariationalRegistrationGaussianRegularizer, 
    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;

  using StandardDeviationsType = FixedArray< double, ImageDimension >;

  itkSetMacro( StandardDeviations, StandardDeviationsType );
  virtual void SetStandardDeviations( double value );

  itkGetConstReferenceMacro(StandardDeviations, StandardDeviationsType);

  itkSetMacro( MaximumError, double );

  itkGetConstMacro( MaximumError, double );

  itkSetMacro( MaximumKernelWidth, unsigned int );

  itkGetConstMacro( MaximumKernelWidth, unsigned int );

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

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

  void GenerateData() override;

  void Initialize() override;

private:
  StandardDeviationsType m_StandardDeviations;

  double         m_MaximumError;

  unsigned int   m_MaximumKernelWidth;
};

}

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

#endif