ITK  5.2.0
Insight Toolkit
itkHeavisideStepFunctionBase.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 itkHeavisideStepFunctionBase_h
19 #define itkHeavisideStepFunctionBase_h
20 
21 #include "itkFunctionBase.h"
22 #include "itkConceptChecking.h"
23 
24 namespace itk
25 {
53 template <typename TInput = float, typename TOutput = double>
54 class HeavisideStepFunctionBase : public FunctionBase<TInput, TOutput>
55 {
56 public:
57  ITK_DISALLOW_COPY_AND_ASSIGN(HeavisideStepFunctionBase);
58 
63 
66 
67 
68  using InputType = typename Superclass::InputType;
70 
73  Evaluate(const InputType & input) const override = 0;
74 
76  virtual OutputType
77  EvaluateDerivative(const InputType & input) const = 0;
78 
79 #ifdef ITK_USE_CONCEPT_CHECKING
80  itkConceptMacro(DoubleConvertibleToInputCheck, (Concept::Convertible<double, TInput>));
81 
82  itkConceptMacro(DoubleConvertibleToOutputCheck, (Concept::Convertible<double, TOutput>));
83 #endif // ITK_USE_CONCEPT_CHECKING
84 
85 protected:
87  : Superclass()
88  {}
89  ~HeavisideStepFunctionBase() override = default;
90 };
91 } // namespace itk
92 
93 #endif
itk::HeavisideStepFunctionBase::Evaluate
OutputType Evaluate(const InputType &input) const override=0
itk::HeavisideStepFunctionBase::EvaluateDerivative
virtual OutputType EvaluateDerivative(const InputType &input) const =0
itkConceptChecking.h
itk::SmartPointer< Self >
itk::FunctionBase::OutputType
TOutput OutputType
Definition: itkFunctionBase.h:62
itk::HeavisideStepFunctionBase::HeavisideStepFunctionBase
HeavisideStepFunctionBase()
Definition: itkHeavisideStepFunctionBase.h:86
itk::HeavisideStepFunctionBase::~HeavisideStepFunctionBase
~HeavisideStepFunctionBase() override=default
itkFunctionBase.h
itk::HeavisideStepFunctionBase
Base class of the Heaviside function.
Definition: itkHeavisideStepFunctionBase.h:54
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
itk::FunctionBase::InputType
TInput InputType
Definition: itkFunctionBase.h:59
itk::Concept::Convertible
Definition: itkConceptChecking.h:214
itk::Object
Base class for most ITK classes.
Definition: itkObject.h:62