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_EXPORT FourierSeriesPath:public
  ParametricPath< VDimension >
{
public:
  typedef FourierSeriesPath            Self;
  typedef ParametricPath< VDimension > Superclass;
  typedef SmartPointer< Self >         Pointer;
  typedef SmartPointer< const Self >   ConstPointer;

  itkTypeMacro(FourierSeriesPath, ParametricPath);

  typedef typename Superclass::InputType InputType;

  typedef typename Superclass::OutputType OutputType;

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

  virtual OutputType Evaluate(const InputType & input) const;

  virtual VectorType EvaluateDerivative(const InputType & input) const;

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

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

  itkNewMacro(Self);

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

protected:
  FourierSeriesPath();
  ~FourierSeriesPath(){}
  void PrintSelf(std::ostream & os, Indent indent) const;

private:
  FourierSeriesPath(const Self &); //purposely not implemented
  void operator=(const Self &);    //purposely not implemented

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

// Define instantiation macro for this template.
#define ITK_TEMPLATE_FourierSeriesPath(_, EXPORT, TypeX, TypeY)     \
  namespace itk                                                     \
  {                                                                 \
  _( 1 ( class EXPORT FourierSeriesPath< ITK_TEMPLATE_1 TypeX > ) ) \
  namespace Templates                                               \
  {                                                                 \
  typedef FourierSeriesPath< ITK_TEMPLATE_1 TypeX >                 \
  FourierSeriesPath##TypeY;                                       \
  }                                                                 \
  }

#if ITK_TEMPLATE_EXPLICIT
#include "Templates/itkFourierSeriesPath+-.h"
#endif

#if ITK_TEMPLATE_TXX
#include "itkFourierSeriesPath.hxx"
#endif

#endif