itkComputeDisplacementDistribution.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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 itkComputeDisplacementDistribution_h
#define itkComputeDisplacementDistribution_h
 
#include "itkScaledSingleValuedNonLinearOptimizer.h"
 
#include "itkImageGridSampler.h"
#include "itkImageRandomSamplerBase.h"
#include "itkImageRandomCoordinateSampler.h"
#include "itkImageFullSampler.h"
#include "itkMultiThreaderBase.h"
 
#include <vector>
 
namespace itk
{
 
template <typename TFixedImage, typename TTransform>
class ITK_TEMPLATE_EXPORT ComputeDisplacementDistribution : public ScaledSingleValuedNonLinearOptimizer
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ComputeDisplacementDistribution);

  using Self = ComputeDisplacementDistribution;
  using Superclass = ScaledSingleValuedNonLinearOptimizer;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ComputeDisplacementDistribution);

  using FixedImageType = TFixedImage;
  using FixedImagePixelType = typename TFixedImage::PixelType;
  using TransformType = TTransform;
  using TransformPointer = typename TTransform::Pointer;
  using FixedImageRegionType = typename TFixedImage::RegionType;
  using Superclass::ParametersType;
  using Superclass::DerivativeType;
  using Superclass::ScalesType;

  itkStaticConstMacro(FixedImageDimension, unsigned int, TFixedImage::ImageDimension);
  using FixedImageMaskType = ImageMaskSpatialObject<Self::FixedImageDimension>;
  using FixedImageMaskPointer = typename FixedImageMaskType::Pointer;
  using FixedImageMaskConstPointer = typename FixedImageMaskType::ConstPointer;
  using NonZeroJacobianIndicesType = typename TTransform::NonZeroJacobianIndicesType;

  itkSetConstObjectMacro(FixedImage, TFixedImage);

  itkSetObjectMacro(Transform, TTransform);

  itkSetObjectMacro(FixedImageMask, FixedImageMaskType);
  itkSetConstObjectMacro(FixedImageMask, FixedImageMaskType);
  itkGetConstObjectMacro(FixedImageMask, FixedImageMaskType);

  itkSetMacro(NumberOfJacobianMeasurements, SizeValueType);

  void
  SetFixedImageRegion(const FixedImageRegionType & region)
  {
    m_FixedImageRegion = region;
  }
 

  itkGetConstReferenceMacro(FixedImageRegion, FixedImageRegionType);

  virtual void
  Compute(const ParametersType & mu, double & jacg, double & maxJJ, std::string method);

  virtual void
  ComputeSingleThreaded(const ParametersType & mu, double & jacg, double & maxJJ, std::string method);
 
  virtual void
  ComputeUsingSearchDirection(const ParametersType & mu, double & jacg, double & maxJJ, std::string methods);

  void
  SetNumberOfWorkUnits(ThreadIdType numberOfThreads)
  {
    m_Threader->SetNumberOfWorkUnits(numberOfThreads);
  }
 
 
  virtual void
  BeforeThreadedCompute(const ParametersType & mu);
 
  virtual void
  AfterThreadedCompute(double & jacg, double & maxJJ);
 
protected:
  ComputeDisplacementDistribution();
  ~ComputeDisplacementDistribution() override = default;

  using ThreadInfoType = MultiThreaderBase::WorkUnitInfo;
 
  typename TFixedImage::ConstPointer      m_FixedImage{ nullptr };
  FixedImageRegionType                    m_FixedImageRegion{};
  FixedImageMaskConstPointer              m_FixedImageMask{ nullptr };
  TransformPointer                        m_Transform{ nullptr };
  ScaledSingleValuedCostFunction::Pointer m_CostFunction{};
  SizeValueType                           m_NumberOfJacobianMeasurements{ 0 };
  DerivativeType                          m_ExactGradient{};
  SizeValueType                           m_NumberOfParameters{};
  MultiThreaderBase::Pointer              m_Threader{ MultiThreaderBase::New() };
 
  using FixedImageIndexType = typename TFixedImage::IndexType;
  using FixedImagePointType = typename TFixedImage::PointType;
  using JacobianType = typename TTransform::JacobianType;
  using JacobianValueType = typename JacobianType::ValueType;
 
  using ImageSampleType = ImageSample<TFixedImage>;

  using TransformJacobianType = JacobianType;
  using CoordinateRepresentationType = typename TTransform::ScalarType;
  using NumberOfParametersType = typename TTransform::NumberOfParametersType;

  // \todo: note that this is an exact copy of itk::ComputeJacobianTerms
  // in the future it would be better to refactoring this part of the code
  std::vector<ImageSampleType>
  SampleFixedImageForJacobianTerms() const;

  void
  LaunchComputeThreaderCallback() const;

  static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION
  ComputeThreaderCallback(void * arg);

  virtual void
  ThreadedCompute(ThreadIdType threadID);

  virtual void
  InitializeThreadingParameters();

  struct MultiThreaderParameterType
  {
    Self * st_Self;
  };
  struct ComputePerThreadStruct
  {
    double        st_MaxJJ;
    double        st_Displacement;
    double        st_DisplacementSquared;
    SizeValueType st_NumberOfPixelsCounted;
  };
  itkPadStruct(ITK_CACHE_LINE_ALIGNMENT, ComputePerThreadStruct, PaddedComputePerThreadStruct);
  itkAlignedTypedef(ITK_CACHE_LINE_ALIGNMENT, PaddedComputePerThreadStruct, AlignedComputePerThreadStruct);
 
private:
  mutable MultiThreaderParameterType m_ThreaderParameters{};
 
  mutable std::vector<AlignedComputePerThreadStruct> m_ComputePerThreadVariables{};
 
  bool                         m_UseMultiThread{ true };
  std::vector<ImageSampleType> m_Samples{};
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkComputeDisplacementDistribution.hxx"
#endif
 
#endif // end #ifndef itkComputeDisplacementDistribution_h