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
|
/*=========================================================================
*
* 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 itkKernelFunctionBase_h
#define itkKernelFunctionBase_h
#include "itkFunctionBase.h"
#include "itkConceptChecking.h"
#include "itkNumericTraits.h"
#include "itkMath.h"
namespace itk
{
/** \class KernelFunctionBase
* \brief Kernel used for density estimation and nonparametric regression.
*
* This class encapsulates the smoothing kernel used for statistical density
* estimation and nonparametric regression. The basic idea of the kernel
* approach is to weight observations by a smooth function (the kernel)
* to created a smoothed approximation.
*
* Reference:
* Silverman, B. W. (1986) Density Estimation. London: Chapman and Hall.
*
* \ingroup Functions
* \ingroup ITKCommon
*/
template <typename TRealValueType = double>
class ITK_TEMPLATE_EXPORT KernelFunctionBase : public FunctionBase<TRealValueType, TRealValueType>
{
public:
/** Standard class type aliases. */
using Self = KernelFunctionBase;
using Superclass = FunctionBase<TRealValueType, TRealValueType>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
using RealType = TRealValueType;
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(KernelFunctionBase);
/** Evaluate the function. Subclasses must implement this. */
TRealValueType
Evaluate(const TRealValueType & u) const override = 0;
#ifdef ITK_USE_CONCEPT_CHECKING
// Begin concept checking
itkConceptMacro(TRealValueTypeIsFloatingPointCheck, (Concept::IsFloatingPoint<TRealValueType>));
// End concept checking
#endif
protected:
KernelFunctionBase() = default;
~KernelFunctionBase() override = default;
};
} // end namespace itk
#endif // itkKernelFunctionBase_h
|