itkGaussianImageSource.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 __itkGaussianImageSource_h
#define __itkGaussianImageSource_h

#include "itkParametricImageSource.h"
#include "itkFixedArray.h"
#include "itkSize.h"

namespace itk
{
template< typename TOutputImage >
class ITK_EXPORT GaussianImageSource :
    public ParametricImageSource< TOutputImage >
{
public:
  typedef GaussianImageSource                   Self;
  typedef ParametricImageSource< TOutputImage > Superclass;
  typedef SmartPointer< Self >                  Pointer;
  typedef SmartPointer< const Self >            ConstPointer;

  typedef TOutputImage                     OutputImageType;

  typedef typename TOutputImage::PixelType OutputImagePixelType;

  typedef typename TOutputImage::RegionType OutputImageRegionType;

  typedef typename TOutputImage::SpacingType SpacingType;

  typedef typename TOutputImage::PointType PointType;

  typedef typename TOutputImage::DirectionType DirectionType;

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

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

  typedef typename TOutputImage::SizeType      SizeType;
  typedef typename TOutputImage::SizeValueType SizeValueType;

  typedef typename Superclass::ParametersValueType ParametersValueType;
  typedef typename Superclass::ParametersType      ParametersType;

  itkTypeMacro(GaussianImageSource, ParametricImageSource);

  itkNewMacro(Self);

  itkSetMacro(Scale, double);
  itkGetConstReferenceMacro(Scale, double);
  itkSetMacro(Normalized, bool);
  itkGetConstReferenceMacro(Normalized, bool);
  itkSetMacro(Sigma, ArrayType);
  itkGetConstReferenceMacro(Sigma, ArrayType);
  itkSetMacro(Mean, ArrayType);
  itkGetConstReferenceMacro(Mean, ArrayType);

  virtual void SetParameters(const ParametersType & parameters);
  virtual ParametersType GetParameters() const;

  virtual unsigned int GetNumberOfParameters() const;

protected:
  GaussianImageSource();
  // ~GaussianImageSource(); default implementation ok
  void PrintSelf(std::ostream & os, Indent indent) const;

  void GenerateData();

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

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

  ArrayType m_Sigma;

  ArrayType m_Mean;

  double m_Scale;

  bool m_Normalized;
};
} // end namespace itk

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

#endif