itkGridScheduleComputer.h

Go to the documentation of this file.

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

  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 __itkGridScheduleComputer_H__
#define __itkGridScheduleComputer_H__

#include "itkObject.h"
#include "itkImageBase.h"
#include "itkTransform.h"

namespace itk
{

template< typename TTransformScalarType, unsigned int VImageDimension >
class GridScheduleComputer :
  public Object
{
public:

  typedef GridScheduleComputer       Self;
  typedef Object                     Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  itkNewMacro( Self );

  itkTypeMacro( GridScheduleComputer, Object );

  itkStaticConstMacro( Dimension, unsigned int, VImageDimension );

  typedef TTransformScalarType TransformScalarType;
  typedef ImageBase<
    itkGetStaticConstMacro( Dimension ) >       ImageBaseType;
  typedef typename ImageBaseType::PointType     PointType;
  typedef typename ImageBaseType::PointType     OriginType;
  typedef typename ImageBaseType::SpacingType   SpacingType;
  typedef typename ImageBaseType::DirectionType DirectionType;
  typedef typename ImageBaseType::SizeType      SizeType;
  typedef typename ImageBaseType::SizeValueType SizeValueType;
  typedef typename ImageBaseType::RegionType    RegionType;
  typedef SpacingType                           GridSpacingFactorType;
  typedef std::vector< OriginType >             VectorOriginType;
  typedef std::vector< SpacingType >            VectorSpacingType;
  typedef std::vector< DirectionType >          VectorDirectionType;
  typedef std::vector< RegionType >             VectorRegionType;
  typedef std::vector< GridSpacingFactorType >  VectorGridSpacingFactorType;

  typedef Transform<
    TransformScalarType,
    itkGetStaticConstMacro( Dimension ),
    itkGetStaticConstMacro( Dimension ) >       TransformType;
  typedef typename TransformType::Pointer      TransformPointer;
  typedef typename TransformType::ConstPointer TransformConstPointer;

  itkSetMacro( ImageOrigin, OriginType );

  itkGetConstMacro( ImageOrigin, OriginType );

  itkSetMacro( ImageSpacing, SpacingType );

  itkGetConstMacro( ImageSpacing, SpacingType );

  itkSetMacro( ImageDirection, DirectionType );

  itkGetConstMacro( ImageDirection, DirectionType );

  itkSetMacro( ImageRegion, RegionType );

  itkGetConstMacro( ImageRegion, RegionType );

  itkSetClampMacro( BSplineOrder, unsigned int, 0, 5 );

  itkGetConstMacro( BSplineOrder, unsigned int );

  itkSetMacro( FinalGridSpacing, SpacingType );

  itkGetConstMacro( FinalGridSpacing, SpacingType );

  virtual void SetDefaultSchedule(
    unsigned int levels,
    double upsamplingFactor );

  virtual void SetSchedule(
    const VectorGridSpacingFactorType & schedule );

  virtual void GetSchedule( VectorGridSpacingFactorType & schedule ) const;

  itkSetConstObjectMacro( InitialTransform, TransformType );

  virtual void ComputeBSplineGrid( void );

  virtual void GetBSplineGrid( unsigned int level,
    RegionType & gridRegion,
    SpacingType & gridSpacing,
    OriginType & gridOrigin,
    DirectionType & gridDirection );

protected:

  GridScheduleComputer();

  virtual ~GridScheduleComputer() {}

  VectorSpacingType           m_GridSpacings;
  VectorOriginType            m_GridOrigins;
  VectorDirectionType         m_GridDirections;
  VectorRegionType            m_GridRegions;
  TransformConstPointer       m_InitialTransform;
  VectorGridSpacingFactorType m_GridSpacingFactors;

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

  itkGetConstMacro( NumberOfLevels, unsigned int );

  virtual void ApplyInitialTransform(
    OriginType & imageOrigin,
    SpacingType & imageSpacing,
    DirectionType & imageDirection,
    SpacingType & finalGridSpacing ) const;

private:

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

  OriginType    m_ImageOrigin;
  SpacingType   m_ImageSpacing;
  RegionType    m_ImageRegion;
  DirectionType m_ImageDirection;
  unsigned int  m_BSplineOrder;
  unsigned int  m_NumberOfLevels;
  SpacingType   m_FinalGridSpacing;

  itkSetClampMacro( UpsamplingFactor, float, 1.0, NumericTraits< float >::max() );

  float m_UpsamplingFactor;

};

} // end namespace itk

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

#endif // end #ifndef __itkGridScheduleComputer_H__