1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
|
/*=========================================================================
*
* 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
{
/** \class GaussianSpatialFunction
* \brief N-dimensional Gaussian spatial function class
*
* GaussianSpatialFunction implements a standard Gaussian curve in N-d.
* m_Normalized determines whether or not the Gaussian is normalized
* (whether or not the sum over infinite space is 1.0)
*
* m_Scale scales the output of the Gaussian to span a range
* larger than 0->1, and is often set to the maximum value
* of the output data type (for instance, 255 for uchars)
*
* \ingroup SpatialFunctions
* \ingroup ITKCommon
*/
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);
/** Standard class type aliases. */
using Self = GaussianSpatialFunction;
using Superclass = SpatialFunction<TOutput, VImageDimension, TInput>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(GaussianSpatialFunction);
/** Input type for the function. */
using typename Superclass::InputType;
/** Output type for the function. */
using typename Superclass::OutputType;
/** Type used to store gaussian parameters. */
using ArrayType = FixedArray<double, VImageDimension>;
/** Evaluate the function at a given position. */
OutputType
Evaluate(const TInput & position) const override;
/** Set/Get the scale factor to multiply the true value of the Gaussian. */
itkSetMacro(Scale, double);
itkGetConstMacro(Scale, double);
/** Set/Get whether or not to normalize the Gaussian. Default is false. */
itkSetMacro(Normalized, bool);
itkGetConstMacro(Normalized, bool);
itkBooleanMacro(Normalized);
/** Set/Get the standard deviation in each direction. */
itkSetMacro(Sigma, ArrayType);
itkGetConstMacro(Sigma, ArrayType);
/** Set/Get the mean in each direction. */
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
|