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_TEMPLATE_EXPORT GaussianImageSource :
  public ParametricImageSource< TOutputImage >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(GaussianImageSource);

  using Self = GaussianImageSource;
  using Superclass = ParametricImageSource< TOutputImage >;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  using OutputImageType = TOutputImage;

  using OutputImagePixelType = typename TOutputImage::PixelType;

  using OutputImageRegionType = typename TOutputImage::RegionType;

  using SpacingType = typename TOutputImage::SpacingType;

  using PointType = typename TOutputImage::PointType;

  using DirectionType = typename TOutputImage::DirectionType;

  static constexpr unsigned int NDimensions = TOutputImage::ImageDimension;

  using ArrayType = FixedArray< double, Self::NDimensions >;

  using SizeType = typename TOutputImage::SizeType;
  using SizeValueType = typename TOutputImage::SizeValueType;

  using ParametersValueType = typename Superclass::ParametersValueType;
  using ParametersType = typename Superclass::ParametersType;

  itkTypeMacro(GaussianImageSource, ParametricImageSource);

  itkNewMacro(Self);

  itkSetMacro(Scale, double);
  itkGetConstReferenceMacro(Scale, double);

  itkSetMacro(Normalized, bool);
  itkGetConstReferenceMacro(Normalized, bool);
  itkBooleanMacro(Normalized);

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

  itkSetMacro(Mean, ArrayType);
  itkGetConstReferenceMacro(Mean, ArrayType);

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

  unsigned int GetNumberOfParameters() const override;

protected:
  GaussianImageSource();
  ~GaussianImageSource() override = default;
  void PrintSelf(std::ostream & os, Indent indent) const override;

  void GenerateData() override;

private:
  ArrayType m_Sigma;

  ArrayType m_Mean;

  double m_Scale{ 255.0 };

  bool m_Normalized{ false };
};
} // end namespace itk

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

#endif