itkUCLN4BiasFieldCorrectionFilter.h

Go to the documentation of this file.

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

  NifTK: A software platform for medical image computing.

  Copyright (c) University College London (UCL). All rights reserved.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.

  See LICENSE.txt in the top level directory for details.

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

#ifndef itkUCLN4BiasFieldCorrectionFilter_h
#define itkUCLN4BiasFieldCorrectionFilter_h

#include <itkImageToImageFilter.h>
#include <itkMacro.h>
#include <itkArray.h>


namespace itk {
  
template < class TInputImage, class TOutputImage >
class ITK_EXPORT UCLN4BiasFieldCorrectionFilter : 
    public ImageToImageFilter< TInputImage, TOutputImage >
{
public:
  typedef UCLN4BiasFieldCorrectionFilter                   Self;
  typedef ImageToImageFilter<TInputImage,TOutputImage>  Superclass;
  typedef SmartPointer<Self>                            Pointer;
  typedef SmartPointer<const Self>                      ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(UCLN4BiasFieldCorrectionFilter, ImageToImageFilter);

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

  typedef typename Superclass::InputImageConstPointer InputImageConstPointer;
  typedef typename Superclass::InputImagePointer      InputImagePointer;
  typedef typename Superclass::InputImageType         InputImageType;

  typedef typename Superclass::OutputImagePointer     OutputImagePointer;
  typedef typename Superclass::OutputImageType        OutputImageType;

  typedef unsigned char MaskPixelType;
  typedef typename itk::Image<MaskPixelType, ImageDimension> MaskImageType;
  typedef typename MaskImageType::Pointer                    MaskImagePointer;


#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro(SameDimensionCheck,
    (Concept::SameDimension<ImageDimension, OutputImageDimension>));
  itkConceptMacro(OutputHasNumericTraitsCheck,
    (Concept::HasNumericTraits<typename TOutputImage::PixelType>));
#endif

  itkSetMacro( Subsampling, float );
  itkSetMacro( SplineOrder, float );
  itkSetMacro( NumberOfHistogramBins, float );
  itkSetMacro( WeinerFilterNoise, float );
  itkSetMacro( BiasFieldFullWidthAtHalfMaximum, float );
  itkSetMacro( MaximumNumberOfIterations, float );
  itkSetMacro( ConvergenceThreshold, float );
  itkSetMacro( NumberOfFittingLevels, float );
  itkSetMacro( NumberOfControlPoints, float );

  itkSetObjectMacro( Mask, MaskImageType );
  itkGetObjectMacro( Mask, MaskImageType );

  itkGetObjectMacro( BiasField, InputImageType );

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

  float m_Subsampling;
  float m_SplineOrder;
  float m_NumberOfHistogramBins;
  float m_WeinerFilterNoise;
  float m_BiasFieldFullWidthAtHalfMaximum;
  float m_MaximumNumberOfIterations;
  float m_ConvergenceThreshold;
  float m_NumberOfFittingLevels;
  float m_NumberOfControlPoints;

  MaskImagePointer m_Mask;
  InputImagePointer m_BiasField;

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

  void GenerateData();


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


} // namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkUCLN4BiasFieldCorrectionFilter.txx"
#endif

#endif