mitkUSDiPhASBModeImageFilter.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 itkPhotoacousticBModeImageFilter_h
#define itkPhotoacousticBModeImageFilter_h

#include "itkComplexToModulusImageFilter.h"
#include "itkConstantPadImageFilter.h"
#include "itkImageToImageFilter.h"
#include "itkImage.h"

#include "ITKUltrasound/itkRegionFromReferenceImageFilter.h"
#include "ITKUltrasound/itkAnalyticSignalImageFilter.h"

namespace itk
{

  template < typename TInputImage, typename TOutputImage = TInputImage, typename TComplexImage = Image< std::complex< typename TInputImage::PixelType >, TInputImage::ImageDimension > >
  class PhotoacousticBModeImageFilter :
    public ImageToImageFilter< TInputImage, TOutputImage >
  {
  public:
    typedef PhotoacousticBModeImageFilter                                Self;
    typedef ImageToImageFilter< TInputImage, TOutputImage > Superclass;
    typedef SmartPointer< Self >                            Pointer;
    typedef SmartPointer< const Self >                      ConstPointer;

    typedef TInputImage InputImageType;

    itkStaticConstMacro(ImageDimension, unsigned int,
      TInputImage::ImageDimension);

    typedef typename InputImageType::PixelType InputPixelType;

    typedef TOutputImage OutputImageType;

    typedef typename OutputImageType::PixelType OutputPixelType;

    typedef TComplexImage ComplexImageType;

    typedef typename InputImageType::RegionType InputRegionType;
    typedef typename InputImageType::SizeType   InputSizeType;
    typedef typename InputImageType::IndexType  InputIndexType;

    itkTypeMacro(PhotoacousticBModeImageFilter, ImageToImageFilter);

    itkNewMacro(Self);

    virtual void SetDirection(unsigned int direction)
    {
      this->m_AnalyticFilter->SetDirection(direction);
      this->Modified();
    }

    virtual unsigned int GetDirection() const
    {
      return m_AnalyticFilter->GetDirection();
    }

  protected:
    PhotoacousticBModeImageFilter();
    ~PhotoacousticBModeImageFilter() {}

    virtual void PrintSelf(std::ostream& os, Indent indent) const ITK_OVERRIDE;

    virtual void GenerateData() ITK_OVERRIDE;

    // These behave like their analogs in FFT1DRealToComplexConjugateImageFilter.
    virtual void GenerateInputRequestedRegion() ITK_OVERRIDE;
    virtual void EnlargeOutputRequestedRegion(DataObject *output) ITK_OVERRIDE;

    typedef AnalyticSignalImageFilter< InputImageType, ComplexImageType >                          AnalyticType;
    typedef ComplexToModulusImageFilter< typename AnalyticType::OutputImageType, OutputImageType > ComplexToModulusType;
    typedef ConstantPadImageFilter< InputImageType, InputImageType >                               PadType;
    typedef RegionFromReferenceImageFilter< OutputImageType, OutputImageType >                     ROIType;

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

    typename AnalyticType::Pointer         m_AnalyticFilter;
    typename ComplexToModulusType::Pointer m_ComplexToModulusFilter;
    typename PadType::Pointer              m_PadFilter;
    typename ROIType::Pointer              m_ROIFilter;
  };

} // end namespace itk

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

#endif // itkPhotoacousticBModeImageFilter_h