itkRecursiveSeparableImageFilter.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 itkRecursiveSeparableImageFilter_h
#define itkRecursiveSeparableImageFilter_h

#include "itkInPlaceImageFilter.h"
#include "itkNumericTraits.h"
#include "itkImageRegionSplitterDirection.h"
#include "itkVariableLengthVector.h"

namespace itk
{
template< typename TInputImage, typename TOutputImage = TInputImage >
class RecursiveSeparableImageFilter:
  public InPlaceImageFilter< TInputImage, TOutputImage >
{
public:
  typedef RecursiveSeparableImageFilter                   Self;
  typedef InPlaceImageFilter< TInputImage, TOutputImage > Superclass;
  typedef SmartPointer< Self >                            Pointer;
  typedef SmartPointer< const Self >                      ConstPointer;

  itkTypeMacro(RecursiveSeparableImageFilter, InPlaceImageFilter);

  typedef typename TInputImage::Pointer      InputImagePointer;
  typedef typename TInputImage::ConstPointer InputImageConstPointer;

  typedef typename TInputImage::PixelType                          InputPixelType;
  typedef typename NumericTraits< InputPixelType >::RealType       RealType;
  typedef typename NumericTraits< InputPixelType >::ScalarRealType ScalarRealType;

  typedef typename TOutputImage::RegionType OutputImageRegionType;

  typedef TInputImage InputImageType;

  typedef TOutputImage OutputImageType;

  itkGetConstMacro(Direction, unsigned int);

  itkSetMacro(Direction, unsigned int);

  void SetInputImage(const TInputImage *);

  const TInputImage * GetInputImage();

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

  void BeforeThreadedGenerateData() ITK_OVERRIDE;

  void ThreadedGenerateData(const OutputImageRegionType & outputRegionForThread, ThreadIdType threadId) ITK_OVERRIDE;


  virtual const ImageRegionSplitterBase* GetImageRegionSplitter(void) const ITK_OVERRIDE;

  void EnlargeOutputRequestedRegion(DataObject *output) ITK_OVERRIDE;

  virtual void SetUp(ScalarRealType spacing) = 0;

  void FilterDataArray(RealType *outs, const RealType *data, RealType *scratch,
                       SizeValueType ln);

protected:
  ScalarRealType m_N0;
  ScalarRealType m_N1;
  ScalarRealType m_N2;
  ScalarRealType m_N3;

  ScalarRealType m_D1;
  ScalarRealType m_D2;
  ScalarRealType m_D3;
  ScalarRealType m_D4;

  ScalarRealType m_M1;
  ScalarRealType m_M2;
  ScalarRealType m_M3;
  ScalarRealType m_M4;

  ScalarRealType m_BN1;
  ScalarRealType m_BN2;
  ScalarRealType m_BN3;
  ScalarRealType m_BN4;

  ScalarRealType m_BM1;
  ScalarRealType m_BM2;
  ScalarRealType m_BM3;
  ScalarRealType m_BM4;


  template <typename T1, typename T2>
  inline void MathEMAMAMAM(T1 &out,
                           const T1 &a1, const T2 &b1,
                           const T1 &a2, const T2 &b2,
                           const T1 &a3, const T2 &b3,
                           const T1 &a4, const T2 &b4 )
    {
      out = a1*b1 + a2*b2 + a3*b3 + a4*b4;
    }


  template <typename T1, typename T2>
  inline void MathEMAMAMAM(VariableLengthVector<T1> &out,
                           const VariableLengthVector<T1> &a1, const T2 &b1,
                           const VariableLengthVector<T1> &a2, const T2 &b2,
                           const VariableLengthVector<T1> &a3, const T2 &b3,
                           const VariableLengthVector<T1> &a4, const T2 &b4 )
    {
      const unsigned int sz  = a1.GetSize();
      if (sz != out.GetSize() )
        {
        out.SetSize(sz);
        }
      for ( unsigned int i = 0; i < sz; ++i)
        {
        out[i] = a1[i]*b1 + a2[i]*b2 + a3[i]*b3 + a4[i]*b4;
        }
    }

  template <typename T1, typename T2>
  inline void MathSMAMAMAM(T1 &out,
                           const T1 &a1, const T2 &b1,
                           const T1 &a2, const T2 &b2,
                           const T1 &a3, const T2 &b3,
                           const T1 &a4, const T2 &b4 )
    {
      out -= a1*b1 + a2*b2 + a3*b3 + a4*b4;
    }

  template <typename T1, typename T2>
  inline void MathSMAMAMAM(VariableLengthVector<T1> &out,
                           const VariableLengthVector<T1> &a1, const T2 &b1,
                           const VariableLengthVector<T1> &a2, const T2 &b2,
                           const VariableLengthVector<T1> &a3, const T2 &b3,
                           const VariableLengthVector<T1> &a4, const T2 &b4 )
    {
      const unsigned int sz  = a1.GetSize();
      if (sz != out.GetSize() )
        {
        out.SetSize(sz);
        }
      for ( unsigned int i = 0; i < sz; ++i)
        {
        out[i] -= a1[i]*b1 + a2[i]*b2 + a3[i]*b3 + a4[i]*b4;
        }
    }

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

  unsigned int m_Direction;

  ImageRegionSplitterDirection::Pointer m_ImageRegionSplitter;
};
} // end namespace itk

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

#endif