itkGridImageSource.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkGridImageSource.h,v $
  Language:  C++
  Date:      $Date: 2009-05-14 21:12:03 $
  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.

=========================================================================*/
#ifndef __itkGridImageSource_h
#define __itkGridImageSource_h

#include "itkImageSource.h"
#include "itkFixedArray.h"
#include "itkKernelFunction.h"
#include "itkVectorContainer.h"
 
#include "vnl/vnl_vector.h" 

namespace itk
{

template <typename TOutputImage>
class ITK_EXPORT GridImageSource : public ImageSource<TOutputImage>
{
public:
  typedef GridImageSource                                  Self;
  typedef ImageSource<TOutputImage>                        Superclass;
  typedef SmartPointer<Self>                               Pointer;
  typedef SmartPointer<const Self>                         ConstPointer;

  itkTypeMacro( GridImageSource, ImageSource );

  itkNewMacro(Self);

  typedef double                                           RealType;

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

  typedef TOutputImage                                     ImageType;
  typedef typename TOutputImage::RegionType                ImageRegionType;
  typedef typename TOutputImage::PixelType                 PixelType;
  typedef typename TOutputImage::SpacingType               SpacingType;
  typedef typename TOutputImage::PointType                 OriginType;
  typedef typename TOutputImage::DirectionType             DirectionType;
  typedef typename TOutputImage::SizeType                  SizeType;

  typedef FixedArray<RealType, itkGetStaticConstMacro(ImageDimension)>
                                                           ArrayType;
  typedef FixedArray<bool, itkGetStaticConstMacro(ImageDimension)>
                                                           BoolArrayType; 
  typedef vnl_vector<RealType>                             PixelArrayType;
  typedef VectorContainer<unsigned long, PixelArrayType>   PixelArrayContainerType;

  itkSetMacro( Spacing, SpacingType );
  itkGetConstReferenceMacro( Spacing, SpacingType );

  itkSetMacro( Origin, OriginType );
  itkGetConstReferenceMacro( Origin, OriginType );

  itkSetMacro( Direction, DirectionType );
  itkGetConstReferenceMacro( Direction, DirectionType );

  itkSetMacro( Size, SizeType );
  itkGetConstReferenceMacro( Size, SizeType );
  
  itkSetObjectMacro( KernelFunction, KernelFunction );
  itkGetConstReferenceObjectMacro( KernelFunction, KernelFunction );

  itkSetMacro( Sigma, ArrayType );
  itkGetConstReferenceMacro( Sigma, ArrayType );

  itkSetMacro( GridSpacing, ArrayType );
  itkGetConstReferenceMacro( GridSpacing, ArrayType );

  itkSetMacro( GridOffset, ArrayType );
  itkGetConstReferenceMacro( GridOffset, ArrayType );

  itkSetMacro( WhichDimensions, BoolArrayType );
  itkGetConstReferenceMacro( WhichDimensions, BoolArrayType );

  itkSetMacro( Scale, RealType );
  itkGetConstReferenceMacro( Scale, RealType );

protected:
  GridImageSource();
  ~GridImageSource(){};
  void PrintSelf(std::ostream& os, Indent indent) const;

  virtual void 
  ThreadedGenerateData(const ImageRegionType& 
                       outputRegionForThread, int threadId );
  virtual void BeforeThreadedGenerateData();
  virtual void GenerateOutputInformation();

private:
  GridImageSource(const GridImageSource&); //purposely not implemented
  void operator=(const GridImageSource&); //purposely not implemented

  SizeType       m_Size;       //size 
  SpacingType    m_Spacing;    //spacing
  OriginType     m_Origin;     //origin
  DirectionType  m_Direction;  //direction

  typename PixelArrayContainerType::Pointer m_PixelArrays;

  typename KernelFunction::Pointer m_KernelFunction;

  ArrayType m_Sigma;

  ArrayType m_GridSpacing;

  ArrayType m_GridOffset;

  BoolArrayType m_WhichDimensions;

  RealType m_Scale;
};

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkGridImageSource.txx"
#endif

#endif