itkGaussianSpatialFunction.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 itkGaussianSpatialFunction_h
#define itkGaussianSpatialFunction_h
 
#include "itkSpatialFunction.h"
#include "itkFixedArray.h"
#include "itkFloatTypes.h"
 
namespace itk
{
template <typename TOutput = double,
          unsigned int VImageDimension = 3,
          typename TInput = Point<SpacePrecisionType, VImageDimension>>
class ITK_TEMPLATE_EXPORT GaussianSpatialFunction : public SpatialFunction<TOutput, VImageDimension, TInput>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(GaussianSpatialFunction);

  using Self = GaussianSpatialFunction;
  using Superclass = SpatialFunction<TOutput, VImageDimension, TInput>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(GaussianSpatialFunction);

  using typename Superclass::InputType;

  using typename Superclass::OutputType;

  using ArrayType = FixedArray<double, VImageDimension>;

  OutputType
  Evaluate(const TInput & position) const override;

  itkSetMacro(Scale, double);
  itkGetConstMacro(Scale, double);

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

  itkSetMacro(Sigma, ArrayType);
  itkGetConstMacro(Sigma, ArrayType);

  itkSetMacro(Mean, ArrayType);
  itkGetConstMacro(Mean, ArrayType);
 
protected:
  GaussianSpatialFunction() = default;
  ~GaussianSpatialFunction() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  ArrayType m_Sigma{ ArrayType::Filled(5.0) };
 
  ArrayType m_Mean{ ArrayType::Filled(10.0) };
 
  double m_Scale{ 1.0 };
 
  bool m_Normalized{ false };
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkGaussianSpatialFunction.hxx"
#endif
 
#endif