itkSpectra1DImageFilter.h

Go to the documentation of this file.

/*============================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE 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 itkSpectra1DImageFilter_h
#define itkSpectra1DImageFilter_h

#include "itkImageToImageFilter.h"
#include "itkDefaultConvertPixelTraits.h"
#include "itkImageRegionConstIterator.h"

#include "vnl/algo/vnl_fft_base.h"
#include "vnl/algo/vnl_fft_1d.h"

#include <utility>
#include <map>

#include "itkSpectra1DSupportWindowImageFilter.h"

namespace itk
{

template< typename TInputImage, typename TSupportWindowImage, typename TOutputImage >
class Spectra1DImageFilter:
  public ImageToImageFilter< TInputImage,
                             TOutputImage >
{
public:
  itkStaticConstMacro( ImageDimension, unsigned int, TInputImage::ImageDimension );

  typedef TInputImage                              InputImageType;
  typedef TSupportWindowImage                      SupportWindowImageType;
  typedef TOutputImage                             OutputImageType;

  typedef typename DefaultConvertPixelTraits< typename OutputImageType::PixelType >::ComponentType
    ScalarType;

  typedef Spectra1DImageFilter                                  Self;
  typedef ImageToImageFilter< InputImageType, OutputImageType > Superclass;
  typedef SmartPointer< Self >                                  Pointer;
  typedef SmartPointer< const Self >                            ConstPointer;

  itkTypeMacro( Spectra1DImageFilter, ImageToImageFilter );
  itkNewMacro( Self );

  itkSetInputMacro( SupportWindowImage, SupportWindowImageType );
  itkGetInputMacro( SupportWindowImage, SupportWindowImageType );

protected:
  Spectra1DImageFilter();
  virtual ~Spectra1DImageFilter() {};

  typedef typename OutputImageType::RegionType OutputImageRegionType;

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

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

  typedef vcl_complex< ScalarType >                  ComplexType;
  typedef vnl_vector< ComplexType >                  ComplexVectorType;
  typedef vnl_vector< ScalarType >                   SpectraVectorType;
  typedef typename InputImageType::IndexType         IndexType;
  typedef std::pair< IndexType, SpectraVectorType >  SpectraLineType;
  typedef std::deque< SpectraLineType >              SpectraLinesContainerType;
  typedef typename SupportWindowImageType::PixelType SupportWindowType;
  typedef ImageRegionConstIterator< InputImageType > InputImageIteratorType;
  typedef vnl_fft_1d< ScalarType >                   FFT1DType;

  typedef Spectra1DSupportWindowImageFilter< OutputImageType >     Spectra1DSupportWindowFilterType;
  typedef typename Spectra1DSupportWindowFilterType::FFT1DSizeType FFT1DSizeType;

  typedef std::map< FFT1DSizeType, SpectraVectorType > LineWindowMapType;

  struct PerThreadData
    {
    ComplexVectorType                 ComplexVector;
    SpectraVectorType                 SpectraVector;
    typename InputImageType::SizeType LineImageRegionSize;
    LineWindowMapType                 LineWindowMap;
    };
  typedef std::vector< PerThreadData > PerThreadDataContainerType;
  PerThreadDataContainerType m_PerThreadDataContainer;

  SpectraLineType ComputeSpectra( const IndexType & lineIndex, ThreadIdType threadId );
  void AddLineWindow( FFT1DSizeType length, LineWindowMapType & lineWindowMap );
};

} // end namespace itk

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

#endif // itkSpectra1DImageFilter_h