itkTransformToDeformationFieldSource.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkTransformToDeformationFieldSource.h,v $
  Language:  C++
  Date:      $Date: 2008-08-01 13:42:00 $
  Version:   $Revision: 1.3 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
/*======================================================================

This file is part of the elastix software.

Copyright (c) University Medical Center Utrecht. All rights reserved.
See src/CopyrightElastix.txt or http://elastix.isi.uu.nl/legal.php for
details.

This software is distributed WITHOUT ANY WARRANTY; without even 
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.

======================================================================*/

#ifndef __itkTransformToDeformationFieldSource_h
#define __itkTransformToDeformationFieldSource_h

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

namespace itk
{

template <class TOutputImage,
class TTransformPrecisionType=double>
class ITK_EXPORT TransformToDeformationFieldSource:
    public ImageSource<TOutputImage>
{
public:
  typedef TransformToDeformationFieldSource       Self;
  typedef ImageSource<TOutputImage>               Superclass;
  typedef SmartPointer<Self>                      Pointer;
  typedef SmartPointer<const Self>                ConstPointer;

  typedef TOutputImage                            OutputImageType;
  typedef typename OutputImageType::Pointer       OutputImagePointer;
  typedef typename OutputImageType::ConstPointer  OutputImageConstPointer;
  typedef typename OutputImageType::RegionType    OutputImageRegionType;
 
  itkNewMacro( Self );

  itkTypeMacro( TransformToDeformationFieldSource, ImageSource );

  itkStaticConstMacro( ImageDimension, unsigned int,
    TOutputImage::ImageDimension );

  typedef Transform<TTransformPrecisionType, 
    itkGetStaticConstMacro( ImageDimension ), 
    itkGetStaticConstMacro( ImageDimension )>     TransformType;
  typedef typename TransformType::ConstPointer    TransformPointerType;

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

  typedef ImageBase< itkGetStaticConstMacro( ImageDimension ) > ImageBaseType;

  itkSetConstObjectMacro( Transform, TransformType ); 

  itkGetConstObjectMacro( Transform, TransformType );

  virtual void SetOutputSize( const SizeType & size );

  virtual const SizeType & GetOutputSize();

  virtual void SetOutputIndex( const IndexType & index );

  virtual const IndexType & GetOutputIndex();

  itkSetMacro( OutputRegion, OutputImageRegionType );

  itkGetConstReferenceMacro( OutputRegion, OutputImageRegionType );

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

  itkGetConstReferenceMacro( OutputSpacing, SpacingType );

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

  itkGetConstReferenceMacro( OutputOrigin, OriginType );

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

  void SetOutputParametersFromImage( const ImageBaseType * image );

  virtual void GenerateOutputInformation( void );

  virtual void BeforeThreadedGenerateData( void );

  unsigned long GetMTime( void ) const;

#ifdef ITK_USE_CONCEPT_CHECKING

  itkStaticConstMacro(PixelDimension, unsigned int,
                      PixelType::Dimension );
  itkConceptMacro(SameDimensionCheck,
    (Concept::SameDimension<ImageDimension,PixelDimension>));

#endif

protected:
  TransformToDeformationFieldSource( void );
  ~TransformToDeformationFieldSource( void ) {};

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

  void ThreadedGenerateData(
    const OutputImageRegionType & outputRegionForThread,
    int threadId );

  void NonlinearThreadedGenerateData(
    const OutputImageRegionType& outputRegionForThread,
    int threadId );

  void LinearThreadedGenerateData(
    const OutputImageRegionType & outputRegionForThread,
    int threadId );

private:

  TransformToDeformationFieldSource( const Self& ); //purposely not implemented
  void operator=( const Self& ); //purposely not implemented

  RegionType              m_OutputRegion;      // region of the output image
  TransformPointerType    m_Transform;         // Coordinate transform to use
  SpacingType             m_OutputSpacing;     // output image spacing
  OriginType              m_OutputOrigin;      // output image origin
  DirectionType           m_OutputDirection;   // output image direction cosines

}; // end class TransformToDeformationFieldSource
  
} // end namespace itk
  
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkTransformToDeformationFieldSource.txx"
#endif
  
#endif // end #ifndef __itkTransformToDeformationFieldSource_h