itkFourierSeriesPath.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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
 *
 *         http://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 itkFourierSeriesPath_h
#define itkFourierSeriesPath_h

#include "itkParametricPath.h"
#include "itkVectorContainer.h"
#include "itkIndex.h"

namespace itk
{
template< unsigned int VDimension >
class ITK_TEMPLATE_EXPORT FourierSeriesPath:public
  ParametricPath< VDimension >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(FourierSeriesPath);

  using Self = FourierSeriesPath;
  using Superclass = ParametricPath< VDimension >;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkTypeMacro(FourierSeriesPath, ParametricPath);

  using InputType = typename Superclass::InputType;

  using OutputType = typename Superclass::OutputType;

  using ContinuousIndexType = ContinuousIndex< double, VDimension >;
  using IndexType = Index<  VDimension >;
  using OffsetType = Offset< VDimension >;
  using VectorType = Vector< double, VDimension >;
  using CoefficientsType = VectorContainer< unsigned, VectorType >;
  using CoefficientsPointer = typename CoefficientsType::Pointer;

  OutputType Evaluate(const InputType & input) const override;

  VectorType EvaluateDerivative(const InputType & input) const override;

  void AddHarmonic(const VectorType & CosCoefficients,
                   const VectorType & SinCoefficients);

  void Clear()
  {
    m_CosCoefficients->Initialize();
    m_SinCoefficients->Initialize();
    this->Modified();
  }

  itkNewMacro(Self);

  void Initialize() override
  {
    this->Clear();
  }

protected:
  FourierSeriesPath();
  ~FourierSeriesPath() override = default;
  void PrintSelf(std::ostream & os, Indent indent) const override;

private:
  CoefficientsPointer m_CosCoefficients;
  CoefficientsPointer m_SinCoefficients;
};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkFourierSeriesPath.hxx"
#endif

#endif