itkUCLMultiResolutionPyramidImageFilter.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkUCLMultiResolutionPyramidImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2009-05-08 16:34:59 $
  Version:   $Revision: 1.25 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef itkUCLMultiResolutionPyramidImageFilter_h
#define itkUCLMultiResolutionPyramidImageFilter_h

#include <itkImageToImageFilter.h>
#include <itkArray2D.h>

namespace itk
{

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

  itkNewMacro(Self);

  itkTypeMacro(UCLMultiResolutionPyramidImageFilter, ImageToImageFilter);

  typedef Array2D<TScheduleElement>  ScheduleType;

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

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

  virtual void SetNumberOfLevels(unsigned int num);

  itkGetConstMacro(NumberOfLevels, unsigned int);

  virtual void SetSchedule( const ScheduleType& schedule );

  itkGetConstReferenceMacro(Schedule, ScheduleType);

  virtual void SetStartingShrinkFactors( TScheduleElement factor );
  virtual void SetStartingShrinkFactors( TScheduleElement* factors );

  const unsigned int * GetStartingShrinkFactors() const;

  static bool IsScheduleDownwardDivisible( const ScheduleType& schedule );

  virtual void GenerateOutputInformation();

  virtual void GenerateOutputRequestedRegion(DataObject *output);

  virtual void GenerateInputRequestedRegion();

  itkSetMacro(MaximumError,double);
  itkGetConstReferenceMacro(MaximumError,double);

  itkSetMacro(UseShrinkImageFilter,bool);
  itkGetConstMacro(UseShrinkImageFilter,bool);
  itkBooleanMacro(UseShrinkImageFilter);
  

#ifdef ITK_USE_CONCEPT_CHECKING

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

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

  void GenerateData();

  double          m_MaximumError; 
  unsigned int    m_NumberOfLevels;
  ScheduleType    m_Schedule;
  bool            m_UseShrinkImageFilter;

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


} // namespace itk

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

#endif