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 ITK_TEMPLATE_EXPORT TimeVaryingVelocityFieldIntegrationImageFilter :
  public ImageToImageFilter<TTimeVaryingVelocityField, TDisplacementField>
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(TimeVaryingVelocityFieldIntegrationImageFilter);

  using Self = TimeVaryingVelocityFieldIntegrationImageFilter;
  using Superclass = ImageToImageFilter
    <TTimeVaryingVelocityField, TDisplacementField>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro( Self );

  itkTypeMacro( TimeVaryingVelocityFieldIntegrationImageFilter, ImageToImageFilter );

  static constexpr unsigned int InputImageDimension = TTimeVaryingVelocityField::ImageDimension;

  static constexpr unsigned int OutputImageDimension = TDisplacementField::ImageDimension;

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

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

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

  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() override = default;

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

  void GenerateOutputInformation() override;

  void BeforeThreadedGenerateData() override;

  void DynamicThreadedGenerateData( const OutputRegionType & ) 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:
  VelocityFieldInterpolatorPointer          m_VelocityFieldInterpolator;
};
}

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

#endif