ITK  5.3.0
Insight Toolkit
itkFourierSeriesPath.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 itkFourierSeriesPath_h
19 #define itkFourierSeriesPath_h
20 
21 #include "itkParametricPath.h"
22 #include "itkVectorContainer.h"
23 #include "itkIndex.h"
24 
25 namespace itk
26 {
58 template <unsigned int VDimension>
59 class ITK_TEMPLATE_EXPORT FourierSeriesPath : public ParametricPath<VDimension>
60 {
61 public:
62  ITK_DISALLOW_COPY_AND_MOVE(FourierSeriesPath);
63 
69 
71  itkTypeMacro(FourierSeriesPath, ParametricPath);
72 
74  using typename Superclass::InputType;
75 
77  using typename Superclass::OutputType;
78 
86 
89  Evaluate(const InputType & input) const override;
90 
94  EvaluateDerivative(const InputType & input) const override;
95 
97  void
98  AddHarmonic(const VectorType & CosCoefficients, const VectorType & SinCoefficients);
99 
101  void
103  {
104  m_CosCoefficients->Initialize();
105  m_SinCoefficients->Initialize();
106  this->Modified();
107  }
109 
111  itkNewMacro(Self);
112 
114  void
115  Initialize() override
116  {
117  this->Clear();
118  }
119 
120 protected:
122  ~FourierSeriesPath() override = default;
123  void
124  PrintSelf(std::ostream & os, Indent indent) const override;
125 
126 private:
129 };
130 } // end namespace itk
131 
132 #ifndef ITK_MANUAL_INSTANTIATION
133 # include "itkFourierSeriesPath.hxx"
134 #endif
135 
136 #endif
itk::Index
Represent a n-dimensional index in a n-dimensional image.
Definition: itkIndex.h:67
itk::FourierSeriesPath::CoefficientsPointer
typename CoefficientsType::Pointer CoefficientsPointer
Definition: itkFourierSeriesPath.h:85
itk::ParametricPath
Represent a parametric path through ND Space.
Definition: itkParametricPath.h:62
itk::Vector< double, VDimension >
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::FourierSeriesPath
Represent a closed path through ND Space by its frequency components.
Definition: itkFourierSeriesPath.h:59
itk::FourierSeriesPath::Clear
void Clear()
Definition: itkFourierSeriesPath.h:102
itk::FourierSeriesPath::m_CosCoefficients
CoefficientsPointer m_CosCoefficients
Definition: itkFourierSeriesPath.h:127
itkIndex.h
itk::Offset
Represent a n-dimensional offset between two n-dimensional indexes of n-dimensional image.
Definition: itkOffset.h:67
itkVectorContainer.h
itk::Path< double, ContinuousIndex< SpacePrecisionType, VDimension >, VDimension >::InputType
double InputType
Definition: itkPath.h:72
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::ContinuousIndex
A templated class holding a point in n-Dimensional image space.
Definition: itkContinuousIndex.h:46
itk::Object
Base class for most ITK classes.
Definition: itkObject.h:62
itkParametricPath.h
itk::FourierSeriesPath::m_SinCoefficients
CoefficientsPointer m_SinCoefficients
Definition: itkFourierSeriesPath.h:128
itk::FourierSeriesPath::Initialize
void Initialize() override
Definition: itkFourierSeriesPath.h:115
itk::VectorContainer
Define a front-end to the STL "vector" container that conforms to the IndexedContainerInterface.
Definition: itkVectorContainer.h:48
itk::DataObject
Base class for all data objects in ITK.
Definition: itkDataObject.h:293