itkGaborImageSource.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 itkGaborImageSource_h
#define itkGaborImageSource_h
 
#include "itkGenerateImageSource.h"
#include "itkFixedArray.h"
 
namespace itk
{
template <typename TOutputImage>
class ITK_TEMPLATE_EXPORT GaborImageSource : public GenerateImageSource<TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(GaborImageSource);

  using Self = GaborImageSource;
  using Superclass = GenerateImageSource<TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  using OutputImageType = TOutputImage;
  using PixelType = typename OutputImageType::PixelType;
  using RegionType = typename OutputImageType::RegionType;
  using SpacingType = typename OutputImageType::SpacingType;
  using PointType = typename OutputImageType::PointType;
  using DirectionType = typename OutputImageType::DirectionType;
 
  using SizeType = typename RegionType::SizeType;

  itkOverrideGetNameOfClassMacro(GaborImageSource);

  itkNewMacro(Self);

  static constexpr unsigned int ImageDimension = OutputImageType::ImageDimension;

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

  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() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  GenerateData() override;
 
private:
  bool m_CalculateImaginaryPart{ false };
 
  double m_Frequency{ 0.4 };

  double m_PhaseOffset{ 0.0 };
 
  ArrayType m_Sigma{};
 
  ArrayType m_Mean{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkGaborImageSource.hxx"
#endif
 
#endif