itkTransformToDisplacementFieldFilter.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 itkTransformToDisplacementFieldFilter_h
#define itkTransformToDisplacementFieldFilter_h

#include "itkDataObjectDecorator.h"
#include "itkTransform.h"
#include "itkImageSource.h"

namespace itk
{
template< typename TOutputImage,
          typename TParametersValueType = double>
class ITK_TEMPLATE_EXPORT TransformToDisplacementFieldFilter:
  public ImageSource< TOutputImage >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(TransformToDisplacementFieldFilter);

  using Self = TransformToDisplacementFieldFilter;
  using Superclass = ImageSource< TOutputImage >;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  using OutputImageType = TOutputImage;
  using OutputImageRegionType = typename OutputImageType::RegionType;

  itkNewMacro(Self);

  itkTypeMacro(TransformToDisplacementFieldFilter, ImageSource);

  static constexpr unsigned int ImageDimension = TOutputImage::ImageDimension;

  using TransformType = Transform<TParametersValueType, ImageDimension, ImageDimension>;
  using TransformInputType = DataObjectDecorator< TransformType >;

  using PixelType = typename OutputImageType::PixelType;
  using PixelValueType = typename PixelType::ValueType;
  using RegionType = typename OutputImageType::RegionType;
  using SizeType = typename RegionType::SizeType;
  using IndexType = typename OutputImageType::IndexType;
  using PointType = typename OutputImageType::PointType;
  using SpacingType = typename OutputImageType::SpacingType;
  using OriginType = typename OutputImageType::PointType;
  using DirectionType = typename OutputImageType::DirectionType;

  using ReferenceImageBaseType = ImageBase< ImageDimension >;

  using Superclass::SetInput;
  virtual void SetInput( const TransformInputType * transform );
  const TransformInputType * GetInput() const;
  itkSetGetDecoratedObjectInputMacro(Transform, TransformType);

  itkSetMacro(OutputStartIndex, IndexType);
  itkGetConstReferenceMacro(OutputStartIndex, IndexType);

  itkSetMacro(Size, SizeType);
  itkGetConstReferenceMacro(Size, SizeType);

  itkSetMacro(OutputSpacing, SpacingType);
  virtual void SetOutputSpacing(const SpacePrecisionType *values);

  itkGetConstReferenceMacro(OutputSpacing, SpacingType);

  itkSetMacro(OutputOrigin, OriginType);
  virtual void SetOutputOrigin(const SpacePrecisionType *values);

  itkGetConstReferenceMacro(OutputOrigin, OriginType);

  itkSetMacro(OutputDirection, DirectionType);
  itkGetConstReferenceMacro(OutputDirection, DirectionType);

  itkSetInputMacro(ReferenceImage, ReferenceImageBaseType);

  itkGetInputMacro(ReferenceImage, ReferenceImageBaseType);

  itkSetMacro(UseReferenceImage, bool);
  itkBooleanMacro(UseReferenceImage);
  itkGetConstMacro(UseReferenceImage, bool);

#ifdef ITK_USE_CONCEPT_CHECKING
  // Begin concept checking
  static constexpr unsigned int PixelDimension = PixelType::Dimension;
  itkConceptMacro( SameDimensionCheck,
                   ( Concept::SameDimension< ImageDimension, PixelDimension > ) );
  // End concept checking
#endif

protected:
  TransformToDisplacementFieldFilter();
  ~TransformToDisplacementFieldFilter() override = default;

  void GenerateOutputInformation() override;

  void DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;


  void NonlinearThreadedGenerateData( const OutputImageRegionType & outputRegionForThread );

  void LinearThreadedGenerateData( const OutputImageRegionType & outputRegionForThread );

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

private:
  SizeType             m_Size;            // size of the output region
  IndexType            m_OutputStartIndex; // start index of the output region
  SpacingType          m_OutputSpacing;   // output image spacing
  OriginType           m_OutputOrigin;    // output image origin
  DirectionType        m_OutputDirection; // output image direction cosines
  bool                 m_UseReferenceImage{ false };

};
} // end namespace itk

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

#endif