itkPCAMetric_F_multithreaded.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 __itkPCAMetric_F_multithreaded_H__
#define __itkPCAMetric_F_multithreaded_H__
 
#include "itkAdvancedImageToImageMetric.h"
 
#include "itkSmoothingRecursiveGaussianImageFilter.h"
#include "itkImageRandomCoordinateSampler.h"
#include "itkNearestNeighborInterpolateImageFunction.h"
#include "itkExtractImageFilter.h"
 
namespace itk
{
template< class TFixedImage, class TMovingImage >
class PCAMetric :
  public AdvancedImageToImageMetric< TFixedImage, TMovingImage >
{
public:
 
  typedef PCAMetric                   Self;
  typedef AdvancedImageToImageMetric<
    TFixedImage, TMovingImage >       Superclass;
  typedef SmartPointer< Self >        Pointer;
  typedef SmartPointer< const Self >  ConstPointer;
 
  typedef typename Superclass::FixedImageRegionType FixedImageRegionType;
  typedef typename FixedImageRegionType::SizeType   FixedImageSizeType;
 
  itkNewMacro( Self );
 
  itkTypeMacro( PCAMetric, AdvancedImageToImageMetric );
 
  itkSetMacro( SubtractMean, bool );
  itkSetMacro( GridSize, FixedImageSizeType );
  itkSetMacro( TransformIsStackTransform, bool );
  itkSetMacro( NumEigenValues, unsigned int );
 
  typedef typename
    Superclass::CoordinateRepresentationType              CoordinateRepresentationType;
  typedef typename Superclass::MovingImageType            MovingImageType;
  typedef typename Superclass::MovingImagePixelType       MovingImagePixelType;
  typedef typename Superclass::MovingImageConstPointer    MovingImageConstPointer;
  typedef typename Superclass::FixedImageType             FixedImageType;
  typedef typename Superclass::FixedImageConstPointer     FixedImageConstPointer;
  typedef typename Superclass::TransformType              TransformType;
  typedef typename Superclass::TransformPointer           TransformPointer;
  typedef typename Superclass::InputPointType             InputPointType;
  typedef typename Superclass::OutputPointType            OutputPointType;
  typedef typename Superclass::TransformParametersType    TransformParametersType;
  typedef typename Superclass::TransformJacobianType      TransformJacobianType;
  typedef typename Superclass::InterpolatorType           InterpolatorType;
  typedef typename Superclass::InterpolatorPointer        InterpolatorPointer;
  typedef typename Superclass::RealType                   RealType;
  typedef typename Superclass::GradientPixelType          GradientPixelType;
  typedef typename Superclass::GradientImageType          GradientImageType;
  typedef typename Superclass::GradientImagePointer       GradientImagePointer;
  typedef typename Superclass::GradientImageFilterType    GradientImageFilterType;
  typedef typename Superclass::GradientImageFilterPointer GradientImageFilterPointer;
  typedef typename Superclass::FixedImageMaskType         FixedImageMaskType;
  typedef typename Superclass::FixedImageMaskPointer      FixedImageMaskPointer;
  typedef typename Superclass::MovingImageMaskType        MovingImageMaskType;
  typedef typename Superclass::MovingImageMaskPointer     MovingImageMaskPointer;
  typedef typename Superclass::MeasureType                MeasureType;
  typedef typename Superclass::DerivativeType             DerivativeType;
  typedef typename Superclass::ParametersType             ParametersType;
  typedef typename Superclass::FixedImagePixelType        FixedImagePixelType;
  typedef typename Superclass::MovingImageRegionType      MovingImageRegionType;
  typedef typename Superclass::ImageSamplerType           ImageSamplerType;
  typedef typename Superclass::ImageSamplerPointer        ImageSamplerPointer;
  typedef typename Superclass::ImageSampleContainerType   ImageSampleContainerType;
  typedef typename
    Superclass::ImageSampleContainerPointer               ImageSampleContainerPointer;
  typedef typename Superclass::FixedImageLimiterType      FixedImageLimiterType;
  typedef typename Superclass::MovingImageLimiterType     MovingImageLimiterType;
  typedef typename
    Superclass::FixedImageLimiterOutputType               FixedImageLimiterOutputType;
 typedef typename
    Superclass::MovingImageLimiterOutputType              MovingImageLimiterOutputType;
  typedef typename
    Superclass::MovingImageDerivativeScalesType           MovingImageDerivativeScalesType;
  typedef typename DerivativeType::ValueType              DerivativeValueType;
  typedef typename Superclass::ThreaderType               ThreaderType;
  typedef typename Superclass::ThreadInfoType             ThreadInfoType;
 
  typedef vnl_matrix< RealType >            MatrixType;
  typedef vnl_matrix< DerivativeValueType > DerivativeMatrixType;
 
//    typedef vnl_matrix< double > MatrixType;
//    typedef vnl_matrix< double > DerivativeMatrixType;
 
  itkStaticConstMacro( FixedImageDimension, unsigned int,
    FixedImageType::ImageDimension );
 
  itkStaticConstMacro( MovingImageDimension, unsigned int,
    MovingImageType::ImageDimension );
 
  MeasureType GetValue( const TransformParametersType & parameters ) const override;
 
  void GetDerivative( const TransformParametersType & parameters,
    DerivativeType & derivative ) const override;
 
  void GetValueAndDerivativeSingleThreaded( const TransformParametersType & parameters,
    MeasureType & Value, DerivativeType & Derivative ) const;
 
  void GetValueAndDerivative( const TransformParametersType & parameters,
    MeasureType & Value, DerivativeType & Derivative ) const override;
 
  void Initialize( void ) override;
 
protected:
 
  PCAMetric();
  ~PCAMetric() override;
  void PrintSelf( std::ostream & os, Indent indent ) const override;
 
  typedef typename Superclass::FixedImageIndexType      FixedImageIndexType;
  typedef typename Superclass::FixedImageIndexValueType FixedImageIndexValueType;
  typedef typename Superclass::MovingImageIndexType     MovingImageIndexType;
  typedef typename Superclass::FixedImagePointType      FixedImagePointType;
  typedef typename itk::ContinuousIndex< CoordinateRepresentationType, FixedImageDimension >
    FixedImageContinuousIndexType;
  typedef typename Superclass::MovingImagePointType                MovingImagePointType;
  typedef typename Superclass::MovingImageContinuousIndexType      MovingImageContinuousIndexType;
  typedef typename Superclass::BSplineInterpolatorType             BSplineInterpolatorType;
  typedef typename Superclass::CentralDifferenceGradientFilterType CentralDifferenceGradientFilterType;
  typedef typename Superclass::MovingImageDerivativeType           MovingImageDerivativeType;
  typedef typename Superclass::NonZeroJacobianIndicesType          NonZeroJacobianIndicesType;
 
  void EvaluateTransformJacobianInnerProduct(
    const TransformJacobianType & jacobian,
    const MovingImageDerivativeType & movingImageDerivative,
    DerivativeType & imageJacobian ) const override;
 
  struct PCAMetricMultiThreaderParameterType
  {
    Self * m_Metric;
  };
 
  PCAMetricMultiThreaderParameterType m_PCAMetricThreaderParameters;
 
  struct PCAMetricGetSamplesPerThreadStruct
  {
    SizeValueType                      st_NumberOfPixelsCounted;
    MatrixType                         st_DataBlock;
    std::vector< FixedImagePointType > st_ApprovedSamples;
    DerivativeType                     st_Derivative;
  };
 
  itkPadStruct( ITK_CACHE_LINE_ALIGNMENT, PCAMetricGetSamplesPerThreadStruct,
    PaddedPCAMetricGetSamplesPerThreadStruct );
 
  itkAlignedTypedef( ITK_CACHE_LINE_ALIGNMENT,
    PaddedPCAMetricGetSamplesPerThreadStruct,
    AlignedPCAMetricGetSamplesPerThreadStruct );
 
  mutable AlignedPCAMetricGetSamplesPerThreadStruct * m_PCAMetricGetSamplesPerThreadVariables;
  mutable ThreadIdType                                m_PCAMetricGetSamplesPerThreadVariablesSize;
 
  inline void ThreadedGetSamples( ThreadIdType threadID );
 
  inline void ThreadedComputeDerivative( ThreadIdType threadID );
 
  inline void AfterThreadedGetSamples( MeasureType & value ) const;
 
  inline void AfterThreadedComputeDerivative( DerivativeType & derivative ) const;
 
  static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION GetSamplesThreaderCallback( void * arg );
 
  static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ComputeDerivativeThreaderCallback( void * arg );
 
  void LaunchGetSamplesThreaderCallback( void ) const;
 
  void LaunchComputeDerivativeThreaderCallback( void ) const;
 
  void InitializeThreadingParameters( void ) const override;
 
private:
 
  PCAMetric( const Self & );      // purposely not implemented
  void operator=( const Self & ); // purposely not implemented
 
  unsigned int m_G;
  unsigned int m_LastDimIndex;
 
  bool m_SubtractMean;
 
  FixedImageSizeType m_GridSize;
 
  bool m_TransformIsStackTransform;
 
  unsigned int m_NumEigenValues;
 
  mutable std::vector< unsigned int > m_PixelStartIndex;
  mutable MatrixType                  m_Atmm;
  mutable DerivativeMatrixType        m_vSAtmm;
  mutable DerivativeMatrixType        m_CSv;
  mutable DerivativeMatrixType        m_Sv;
  mutable DerivativeMatrixType        m_vdSdmu_part1;
 
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkPCAMetric_F_multithreaded.hxx"
#endif
 
#endif // end #ifndef __itkPCAMetric_F_multithreaded_H__