/*=========================================================================
 *
 *  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 __itkBSplineKernelFunction_h
#define __itkBSplineKernelFunction_h

#include "itkKernelFunctionBase.h"

namespace itk
{
/** \class BSplineKernelFunction
 * \brief BSpline kernel used for density estimation and nonparameteric
 *  regression.
 *
 * This class enscapsulates BSpline kernel for
 * density estimation or nonparameteric regression.
 * See documentation for KernelFunctionBase for more details.
 *
 * This class is templated over the spline order.
 * \warning Evaluate is only implemented for spline order 0 to 3
 *
 * \sa KernelFunctionBase
 *
 * \ingroup Functions
 * \ingroup ITKCommon
 */
template< unsigned int VSplineOrder = 3, typename TRealValueType = double >
class BSplineKernelFunction:public KernelFunctionBase<TRealValueType>
{
public:
  /** Standard class typedefs. */
  typedef BSplineKernelFunction              Self;
  typedef KernelFunctionBase<TRealValueType> Superclass;
  typedef SmartPointer< Self >               Pointer;

  typedef typename Superclass::RealType  RealType;
  /** Method for creation through the object factory. */
  itkNewMacro(Self);

  /** Run-time type information (and related methods). */
  itkTypeMacro(BSplineKernelFunction, KernelFunctionBase);

  /** Enum of for spline order. */
  itkStaticConstMacro(SplineOrder, unsigned int, VSplineOrder);

  /** Evaluate the function. */
  inline TRealValueType Evaluate(const TRealValueType & u) const
  {
    return this->Evaluate(Dispatch< VSplineOrder >(), u);
  }

protected:
  BSplineKernelFunction(){}
  virtual ~BSplineKernelFunction(){}
  void PrintSelf(std::ostream & os, Indent indent) const
  {
    Superclass::PrintSelf(os, indent);
    os << indent  << "Spline Order: " << SplineOrder << std::endl;
  }

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

  /** Structures to control overloaded versions of Evaluate */
  struct DispatchBase {};
  template< unsigned int >
  struct Dispatch: public DispatchBase {};

  /** Zeroth order spline. */
  inline TRealValueType Evaluate(const Dispatch< 0 > &, const TRealValueType & u) const
  {
    const TRealValueType absValue = vnl_math_abs(u);
    if ( absValue  < static_cast< TRealValueType >(0.5) )
      {
      return NumericTraits< TRealValueType >::One;
      }
    else if ( absValue == static_cast< TRealValueType >(0.5) )
      {
      return static_cast< TRealValueType >(0.5);
      }
    else
      {
      return NumericTraits< TRealValueType >::Zero;
      }
  }

  /** First order spline */
  inline TRealValueType Evaluate(const Dispatch< 1 > &, const TRealValueType & u) const
  {
    const TRealValueType absValue = vnl_math_abs(u);
    if ( absValue  < NumericTraits< TRealValueType >::One )
      {
      return NumericTraits< TRealValueType >::One - absValue;
      }
    else
      {
      return NumericTraits< TRealValueType >::Zero;
      }
  }

  /** Second order spline. */
  inline TRealValueType Evaluate(const Dispatch< 2 > &, const TRealValueType & u) const
  {
    const TRealValueType absValue = vnl_math_abs(u);
    if ( absValue  < static_cast< TRealValueType >(0.5) )
      {
      const TRealValueType sqrValue = vnl_math_sqr(absValue);
      return static_cast< TRealValueType >(0.75) - sqrValue;
      }
    else if ( absValue < static_cast< TRealValueType >(1.5) )
      {
      const TRealValueType sqrValue = vnl_math_sqr(absValue);
      // NOTE: 1.0/8.0 == static_cast< TRealValueType >( 0.125 )
      return ( static_cast< TRealValueType >(9.0) - static_cast< TRealValueType >(12.0) * absValue
        + static_cast< TRealValueType >(4.0) * sqrValue ) * static_cast< TRealValueType >(0.125);
      }
    else
      {
      return NumericTraits< TRealValueType >::Zero;
      }
  }

  /**  Third order spline. */
  inline TRealValueType Evaluate(const Dispatch< 3 > &, const TRealValueType & u) const
  {
    const TRealValueType absValue = vnl_math_abs(u);
    if ( absValue  < NumericTraits< TRealValueType >::One )
      {
      const TRealValueType sqrValue = vnl_math_sqr(absValue);
      return ( static_cast< TRealValueType >(4.0) - static_cast< TRealValueType >(6.0) * sqrValue
        + static_cast< TRealValueType >(3.0) * sqrValue * absValue ) / static_cast< TRealValueType >(6.0);
      }
    else if ( absValue < static_cast< TRealValueType >(2.0) )
      {
      const TRealValueType sqrValue = vnl_math_sqr(absValue);
      return ( static_cast< TRealValueType >(8.0) - static_cast< TRealValueType >(12.0) * absValue + static_cast< TRealValueType >(6.0) * sqrValue
               - sqrValue * absValue ) / static_cast< TRealValueType >(6.0);
      }
    else
      {
      return NumericTraits< TRealValueType >::Zero;
      }
  }

  /** Unimplemented spline order */
  inline TRealValueType Evaluate(const DispatchBase &, const TRealValueType &) const
  {
    itkExceptionMacro( "Evaluate not implemented for spline order "
      << SplineOrder);
    return NumericTraits< TRealValueType >::Zero; // This is to avoid compiler warning about missing
                // return statement.  It should never be evaluated.
  }
};
} // end namespace itk

#endif
