itkGaborImageSource.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkGaborImageSource.h,v $
  Language:  C++
  Date:      $Date: 2009-10-03 16:15:16 $
  Version:   $Revision: 1.1 $

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

#include "itkImageSource.h"
#include "itkFixedArray.h"

namespace itk
{

template <typename TOutputImage>
class ITK_EXPORT GaborImageSource : public ImageSource<TOutputImage>
{
public:

  typedef GaborImageSource                       Self;
  typedef ImageSource<TOutputImage>              Superclass;
  typedef SmartPointer<Self>                     Pointer;
  typedef SmartPointer<const Self>               ConstPointer;

  typedef TOutputImage                            OutputImageType;
  typedef typename OutputImageType::PixelType     PixelType;
  typedef typename OutputImageType::RegionType    RegionType;
  typedef typename OutputImageType::SpacingType   SpacingType;
  typedef typename OutputImageType::PointType     PointType;
  typedef typename OutputImageType::DirectionType DirectionType;

  typedef typename RegionType::SizeType          SizeType;

  itkTypeMacro( GaborImageSource, ImageSource );

  itkNewMacro( Self );

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

  typedef FixedArray<double, 
    itkGetStaticConstMacro( ImageDimension )>    ArrayType;

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

  itkSetMacro( Origin, PointType );
  itkGetConstReferenceMacro( Origin, PointType );

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

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

  itkSetMacro( Mean, ArrayType );
  itkGetConstReferenceMacro( Mean, ArrayType );
  
  itkSetMacro( Frequency, double );
  itkGetConstReferenceMacro( Frequency, double );
  
  itkSetMacro( CalculateImaginaryPart, bool );
  itkGetConstReferenceMacro( CalculateImaginaryPart, bool );
  itkBooleanMacro( CalculateImaginaryPart );

protected:
  GaborImageSource();
  ~GaborImageSource();
  void PrintSelf(std::ostream& os, Indent indent) const;
  void GenerateData();
  virtual void GenerateOutputInformation();

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

  SizeType           m_Size;       //size of the output image
  SpacingType        m_Spacing;    //spacing
  PointType          m_Origin;     //origin
  DirectionType      m_Direction;  //direciton

  bool m_CalculateImaginaryPart;

  double m_Frequency;

  double m_PhaseOffset;

  ArrayType m_Sigma;

  ArrayType m_Mean;
};

} // end namespace itk

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

#endif