itkTimeVaryingVelocityFieldIntegrationImageFilter.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 itkTimeVaryingVelocityFieldIntegrationImageFilter_h
#define itkTimeVaryingVelocityFieldIntegrationImageFilter_h

#include "itkImageToImageFilter.h"

#include "itkVectorInterpolateImageFunction.h"

namespace itk
{
template<typename TTimeVaryingVelocityField, typename TDisplacementField =
 Image<typename TTimeVaryingVelocityField::PixelType,
 TTimeVaryingVelocityField::ImageDimension - 1> >
class TimeVaryingVelocityFieldIntegrationImageFilter :
  public ImageToImageFilter<TTimeVaryingVelocityField, TDisplacementField>
{
public:
  typedef TimeVaryingVelocityFieldIntegrationImageFilter  Self;
  typedef ImageToImageFilter
    <TTimeVaryingVelocityField, TDisplacementField>       Superclass;
  typedef SmartPointer<Self>                              Pointer;
  typedef SmartPointer<const Self>                        ConstPointer;

  itkNewMacro( Self );

  itkTypeMacro( TimeVaryingVelocityFieldIntegrationImageFilter, ImageToImageFilter );

  itkStaticConstMacro( InputImageDimension, unsigned int,
    TTimeVaryingVelocityField::ImageDimension );

  itkStaticConstMacro( OutputImageDimension, unsigned int,
    TDisplacementField::ImageDimension );

  typedef TTimeVaryingVelocityField                   TimeVaryingVelocityFieldType;
  typedef TDisplacementField                          DisplacementFieldType;
  typedef typename DisplacementFieldType::Pointer     DisplacementFieldPointer;
  typedef typename DisplacementFieldType::PixelType   VectorType;
  typedef typename VectorType::RealValueType          RealType;
  typedef typename VectorType::ValueType              ScalarType;
  typedef typename DisplacementFieldType::PointType   PointType;
  typedef typename DisplacementFieldType::RegionType  OutputRegionType;

  typedef VectorInterpolateImageFunction
    <TimeVaryingVelocityFieldType, ScalarType>    VelocityFieldInterpolatorType;
  typedef typename VelocityFieldInterpolatorType::Pointer
                                                  VelocityFieldInterpolatorPointer;

  typedef VectorInterpolateImageFunction<DisplacementFieldType, ScalarType>   DisplacementFieldInterpolatorType;
  typedef typename DisplacementFieldInterpolatorType::Pointer                 DisplacementFieldInterpolatorPointer;

  itkSetObjectMacro( VelocityFieldInterpolator, VelocityFieldInterpolatorType );
  itkGetModifiableObjectMacro(VelocityFieldInterpolator, VelocityFieldInterpolatorType );

  itkSetObjectMacro( DisplacementFieldInterpolator, DisplacementFieldInterpolatorType );
  itkGetModifiableObjectMacro(DisplacementFieldInterpolator, DisplacementFieldInterpolatorType );

  itkSetObjectMacro( InitialDiffeomorphism, DisplacementFieldType );
  itkGetModifiableObjectMacro(InitialDiffeomorphism, DisplacementFieldType );

  itkSetClampMacro( LowerTimeBound, RealType, 0, 1 );

  itkGetConstMacro( LowerTimeBound, RealType );

  itkSetClampMacro( UpperTimeBound, RealType, 0, 1 );

  itkGetConstMacro( UpperTimeBound, RealType );

  itkSetMacro( NumberOfIntegrationSteps, unsigned int );

  itkGetConstMacro( NumberOfIntegrationSteps, unsigned int );

protected:
  TimeVaryingVelocityFieldIntegrationImageFilter();
  ~TimeVaryingVelocityFieldIntegrationImageFilter();

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

  virtual void GenerateOutputInformation() ITK_OVERRIDE;

  virtual void BeforeThreadedGenerateData() ITK_OVERRIDE;

  virtual void ThreadedGenerateData( const OutputRegionType &, ThreadIdType ) ITK_OVERRIDE;

  VectorType IntegrateVelocityAtPoint( const PointType &initialSpatialPoint, const TimeVaryingVelocityFieldType * inputField );

  RealType                                  m_LowerTimeBound;
  RealType                                  m_UpperTimeBound;

  DisplacementFieldPointer                  m_InitialDiffeomorphism;

  unsigned int                              m_NumberOfIntegrationSteps;

  unsigned int                              m_NumberOfTimePoints;

  DisplacementFieldInterpolatorPointer      m_DisplacementFieldInterpolator;

private:
  TimeVaryingVelocityFieldIntegrationImageFilter( const Self & ) ITK_DELETE_FUNCTION;
  void operator=( const Self & ) ITK_DELETE_FUNCTION;

  VelocityFieldInterpolatorPointer          m_VelocityFieldInterpolator;
};
}

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

#endif