itkImageToImageMetricv4GetValueAndDerivativeThreaderBase.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 __itkImageToImageMetricv4GetValueAndDerivativeThreaderBase_h
#define __itkImageToImageMetricv4GetValueAndDerivativeThreaderBase_h

#include "itkDomainThreader.h"
#include "itkCompensatedSummation.h"

namespace itk
{

template < typename TDomainPartitioner, typename TImageToImageMetricv4 >
class ImageToImageMetricv4GetValueAndDerivativeThreaderBase
  : public DomainThreader< TDomainPartitioner, TImageToImageMetricv4 >
{
public:
  typedef ImageToImageMetricv4GetValueAndDerivativeThreaderBase       Self;
  typedef DomainThreader< TDomainPartitioner, TImageToImageMetricv4 > Superclass;
  typedef SmartPointer< Self >                                        Pointer;
  typedef SmartPointer< const Self >                                  ConstPointer;

  itkTypeMacro( ImageToImageMetricv4GetValueAndDerivativeThreaderBase, DomainThreader );

  typedef typename Superclass::DomainType    DomainType;
  typedef typename Superclass::AssociateType AssociateType;

  typedef TImageToImageMetricv4                                      ImageToImageMetricv4Type;
  typedef typename ImageToImageMetricv4Type::VirtualImageType        VirtualImageType;
  typedef typename ImageToImageMetricv4Type::VirtualIndexType        VirtualIndexType;
  typedef typename ImageToImageMetricv4Type::VirtualPointType        VirtualPointType;
  typedef typename ImageToImageMetricv4Type::FixedImagePointType     FixedImagePointType;
  typedef typename ImageToImageMetricv4Type::FixedImagePixelType     FixedImagePixelType;
  typedef typename ImageToImageMetricv4Type::FixedImageIndexType     FixedImageIndexType;
  typedef typename ImageToImageMetricv4Type::FixedImageGradientType  FixedImageGradientType;
  typedef typename ImageToImageMetricv4Type::MovingImagePointType    MovingImagePointType;
  typedef typename ImageToImageMetricv4Type::MovingImagePixelType    MovingImagePixelType;
  typedef typename ImageToImageMetricv4Type::MovingImageGradientType MovingImageGradientType;

  typedef typename ImageToImageMetricv4Type::FixedTransformType      FixedTransformType;
  typedef typename FixedTransformType::OutputPointType               FixedOutputPointType;
  typedef typename ImageToImageMetricv4Type::MovingTransformType     MovingTransformType;
  typedef typename MovingTransformType::OutputPointType              MovingOutputPointType;

  typedef typename ImageToImageMetricv4Type::MeasureType             MeasureType;
  typedef typename ImageToImageMetricv4Type::DerivativeType          DerivativeType;
  typedef typename ImageToImageMetricv4Type::DerivativeValueType     DerivativeValueType;
  typedef typename ImageToImageMetricv4Type::JacobianType            JacobianType;
  typedef typename ImageToImageMetricv4Type::ImageDimensionType      ImageDimensionType;

  typedef typename ImageToImageMetricv4Type::InternalComputationValueType InternalComputationValueType;
  typedef typename ImageToImageMetricv4Type::NumberOfParametersType       NumberOfParametersType;

  typedef CompensatedSummation<DerivativeValueType>                   CompensatedDerivativeValueType;
  typedef std::vector<CompensatedDerivativeValueType>                 CompensatedDerivativeType;

  virtual bool GetComputeDerivative() const;

protected:
  ImageToImageMetricv4GetValueAndDerivativeThreaderBase();
  virtual ~ImageToImageMetricv4GetValueAndDerivativeThreaderBase();

  virtual void BeforeThreadedExecution();

  virtual void AfterThreadedExecution();

  virtual bool ProcessVirtualPoint( const VirtualIndexType & virtualIndex,
                                    const VirtualPointType & virtualPoint,
                                    const ThreadIdType threadId );

  virtual bool ProcessPoint(
        const VirtualIndexType &          virtualIndex,
        const VirtualPointType &          virtualPoint,
        const FixedImagePointType &       mappedFixedPoint,
        const FixedImagePixelType &       mappedFixedPixelValue,
        const FixedImageGradientType &    mappedFixedImageGradient,
        const MovingImagePointType &      mappedMovingPoint,
        const MovingImagePixelType &      mappedMovingPixelValue,
        const MovingImageGradientType &   mappedMovingImageGradient,
        MeasureType &                     metricValueReturn,
        DerivativeType &                  localDerivativeReturn,
        const ThreadIdType                threadId ) const = 0;


  virtual void StorePointDerivativeResult( const VirtualIndexType & virtualIndex,
                                           const ThreadIdType threadId );

  struct GetValueAndDerivativePerThreadStruct
    {
    InternalComputationValueType Measure;

    DerivativeType               Derivatives;

    CompensatedDerivativeType    CompensatedDerivatives;

    DerivativeType               LocalDerivatives;

    SizeValueType                NumberOfValidPoints;

    JacobianType                 MovingTransformJacobian;
    JacobianType                 MovingTransformJacobianPositional;
    };
  itkPadStruct( ITK_CACHE_LINE_ALIGNMENT, GetValueAndDerivativePerThreadStruct,
                                            PaddedGetValueAndDerivativePerThreadStruct);
  itkAlignedTypedef( ITK_CACHE_LINE_ALIGNMENT, PaddedGetValueAndDerivativePerThreadStruct,
                                               AlignedGetValueAndDerivativePerThreadStruct );
  mutable AlignedGetValueAndDerivativePerThreadStruct * m_GetValueAndDerivativePerThreadVariables;

  mutable NumberOfParametersType                      m_CachedNumberOfParameters;
  mutable NumberOfParametersType                      m_CachedNumberOfLocalParameters;

private:
  ImageToImageMetricv4GetValueAndDerivativeThreaderBase( const Self & ); // purposely not implemented
  void operator=( const Self & ); // purposely not implemented
};

} // end namespace itk

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

#endif