ITK  5.2.0
Insight Toolkit
itkKernelFunctionBase.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright NumFOCUS
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 #ifndef itkKernelFunctionBase_h
19 #define itkKernelFunctionBase_h
20 
21 #include "itkFunctionBase.h"
22 #include "itkConceptChecking.h"
23 #include "itkNumericTraits.h"
24 #include "itkMath.h"
25 
26 namespace itk
27 {
42 template <typename TRealValueType = double>
43 class KernelFunctionBase : public FunctionBase<TRealValueType, TRealValueType>
44 {
45 public:
51 
52  using RealType = TRealValueType;
53 
55  itkTypeMacro(KernelFunctionBase, FunctionBase);
56 
58  TRealValueType
59  Evaluate(const TRealValueType & u) const override = 0;
60 
61 #ifdef ITK_USE_CONCEPT_CHECKING
62  // Begin concept checking
63  itkConceptMacro(TRealValueTypeIsFloatingPointCheck, (Concept::IsFloatingPoint<TRealValueType>));
64  // End concept checking
65 #endif
66 
67 protected:
68  KernelFunctionBase() = default;
69  ~KernelFunctionBase() override = default;
70  void
71  PrintSelf(std::ostream & os, Indent indent) const override
72  {
73  Superclass::PrintSelf(os, indent);
74  }
75 };
76 } // end namespace itk
77 
78 #endif // itkKernelFunctionBase_h
itk::KernelFunctionBase< double >::RealType
double RealType
Definition: itkKernelFunctionBase.h:52
itk::KernelFunctionBase
Kernel used for density estimation and nonparametric regression.
Definition: itkKernelFunctionBase.h:43
itkConceptChecking.h
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itkFunctionBase.h
itk::KernelFunctionBase::~KernelFunctionBase
~KernelFunctionBase() override=default
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itk::KernelFunctionBase::KernelFunctionBase
KernelFunctionBase()=default
itk::Concept::IsFloatingPoint
Definition: itkConceptChecking.h:945
itk::KernelFunctionBase::Evaluate
TRealValueType Evaluate(const TRealValueType &u) const override=0
itk::KernelFunctionBase::PrintSelf
void PrintSelf(std::ostream &os, Indent indent) const override
Definition: itkKernelFunctionBase.h:71
itk::FunctionBase
Base class for all ITK function objects.
Definition: itkFunctionBase.h:44
itkConceptMacro
#define itkConceptMacro(name, concept)
Definition: itkConceptChecking.h:64
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itkNumericTraits.h
itk::Object::PrintSelf
void PrintSelf(std::ostream &os, Indent indent) const override
itkMath.h