itkParabolicOpenCloseImageFilter.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 itkParabolicOpenCloseImageFilter_h
#define itkParabolicOpenCloseImageFilter_h

#include "itkImageToImageFilter.h"
#include "itkNumericTraits.h"
#include "itkProgressReporter.h"

namespace itk
{
template< typename TInputImage,
          bool doOpen,
          typename TOutputImage = TInputImage >
class ITK_EXPORT ParabolicOpenCloseImageFilter:
  public ImageToImageFilter< TInputImage, TOutputImage >
{
public:

  typedef ParabolicOpenCloseImageFilter                   Self;
  typedef ImageToImageFilter< TInputImage, TOutputImage > Superclass;
  typedef SmartPointer< Self >                            Pointer;
  typedef SmartPointer< const Self >                      ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(ParabolicOpenCloseImageFilter, ImageToImageFilter);

  typedef TInputImage                                         InputImageType;
  typedef TOutputImage                                        OutputImageType;
  typedef typename TInputImage::PixelType                     PixelType;
  typedef typename NumericTraits< PixelType >::RealType       RealType;
  typedef typename NumericTraits< PixelType >::ScalarRealType ScalarRealType;
  typedef typename TOutputImage::PixelType                    OutputPixelType;
  typedef typename OutputImageType::RegionType                OutputImageRegionType;
  typedef typename TInputImage::SizeType                      InputSizeType;
  typedef typename TOutputImage::SizeType                     OutputSizeType;

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

  typedef typename OutputImageType::IndexType OutputIndexType;

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

  typedef typename itk::FixedArray< ScalarRealType, TInputImage::ImageDimension > RadiusType;

  typedef typename NumericTraits< PixelType >::FloatType InternalRealType;
  //typedef typename Image<InternalRealType,
  // itkGetStaticConstMacro(ImageDimension) >   RealImageType;

  // set all of the scales the same
  void SetScale(ScalarRealType scale);

  itkSetMacro(Scale, RadiusType);
  itkGetConstReferenceMacro(Scale, RadiusType);
  itkSetMacro(UseImageSpacing, bool);
  itkGetConstReferenceMacro(UseImageSpacing, bool);
  itkBooleanMacro(UseImageSpacing);

  enum ParabolicAlgorithm {
    NOCHOICE = 0,     // decices based on scale - experimental
    CONTACTPOINT = 1, // sometimes faster at low scale
    INTERSECTION = 2  // default
    };
  itkSetMacro(ParabolicAlgorithm, int);
  itkGetConstReferenceMacro(ParabolicAlgorithm, int);

#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro( SameDimension,
                   ( Concept::SameDimension< itkGetStaticConstMacro(InputImageDimension),
                                             itkGetStaticConstMacro(OutputImageDimension) > ) );

  itkConceptMacro( Comparable,
                   ( Concept::Comparable< PixelType > ) );

#endif
protected:
  ParabolicOpenCloseImageFilter();
  virtual ~ParabolicOpenCloseImageFilter() {}
  void PrintSelf(std::ostream & os, Indent indent) const;

  void GenerateData(void);

  unsigned int SplitRequestedRegion(unsigned int i, unsigned int num,
                                    OutputImageRegionType & splitRegion);

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

  virtual void GenerateInputRequestedRegion() throw( InvalidRequestedRegionError );

  // Override since the filter produces the entire dataset.
  void EnlargeOutputRequestedRegion(DataObject *output);

  int m_ParabolicAlgorithm;
private:
  ParabolicOpenCloseImageFilter(const Self &); //purposely not implemented
  void operator=(const Self &);                //purposely not implemented

  RadiusType m_Scale;

  typename TInputImage::PixelType m_Extreme;
  typename TInputImage::PixelType m_Extreme1;
  typename TInputImage::PixelType m_Extreme2;

  int  m_MagnitudeSign;
  int  m_MagnitudeSign1;
  int  m_MagnitudeSign2;
  int  m_CurrentDimension;
  int  m_Stage;
  bool m_UseImageSpacing;
};
} // end namespace itk

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

#endif