itkBinaryShapeOpeningImageFilter.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkBinaryShapeOpeningImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2009-08-07 11:28:01 $
  Version:   $Revision: 1.4 $

  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 __itkBinaryShapeOpeningImageFilter_h
#define __itkBinaryShapeOpeningImageFilter_h

#include "itkImageToImageFilter.h"
#include "itkShapeLabelObject.h"
#include "itkLabelMap.h"
#include "itkBinaryImageToLabelMapFilter.h"
#include "itkShapeLabelMapFilter.h"
#include "itkShapeOpeningLabelMapFilter.h"
#include "itkLabelMapToBinaryImageFilter.h"


namespace itk {

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

  typedef TInputImage                              InputImageType;
  typedef TInputImage                              OutputImageType;
  typedef typename InputImageType::Pointer         InputImagePointer;
  typedef typename InputImageType::ConstPointer    InputImageConstPointer;
  typedef typename InputImageType::RegionType      InputImageRegionType;
  typedef typename InputImageType::PixelType       InputImagePixelType;
  typedef typename OutputImageType::Pointer        OutputImagePointer;
  typedef typename OutputImageType::ConstPointer   OutputImageConstPointer;
  typedef typename OutputImageType::RegionType     OutputImageRegionType;
  typedef typename OutputImageType::PixelType      OutputImagePixelType;

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

  typedef ShapeLabelObject<unsigned long, itkGetStaticConstMacro(ImageDimension)>    LabelObjectType;
  typedef LabelMap< LabelObjectType >                                                LabelMapType;
  typedef BinaryImageToLabelMapFilter< InputImageType, LabelMapType >                LabelizerType;
  typedef Image< typename OutputImageType::PixelType, itkGetStaticConstMacro(OutputImageDimension)>
      ShapeLabelFilterOutput;
  typedef ShapeLabelMapFilter< LabelMapType,ShapeLabelFilterOutput >                 LabelObjectValuatorType;
  typedef typename LabelObjectType::AttributeType                                    AttributeType;
  typedef ShapeOpeningLabelMapFilter< LabelMapType >                                 OpeningType;
  typedef LabelMapToBinaryImageFilter< LabelMapType, OutputImageType >               BinarizerType;

  itkNewMacro(Self);  

  itkTypeMacro(BinaryShapeOpeningImageFilter, ImageToImageFilter );

  itkSetMacro( FullyConnected, bool );
  itkGetConstReferenceMacro( FullyConnected, bool );
  itkBooleanMacro( FullyConnected );

#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro(InputEqualityComparableCheck,
    (Concept::EqualityComparable<InputImagePixelType>));
  itkConceptMacro(IntConvertibleToInputCheck,
    (Concept::Convertible<int, InputImagePixelType>));
  itkConceptMacro(InputOStreamWritableCheck,
    (Concept::OStreamWritable<InputImagePixelType>));

#endif

  itkSetMacro( BackgroundValue, OutputImagePixelType );
  itkGetConstMacro( BackgroundValue, OutputImagePixelType );

  itkSetMacro( ForegroundValue, OutputImagePixelType );
  itkGetConstMacro( ForegroundValue, OutputImagePixelType);

  itkGetConstMacro( Lambda, double );
  itkSetMacro( Lambda, double );

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

  itkGetConstMacro( Attribute, AttributeType );
  itkSetMacro( Attribute, AttributeType );
  void SetAttribute( const std::string & s )
    {
    this->SetAttribute( LabelObjectType::GetAttributeFromName( s ) );
    }


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

  void GenerateInputRequestedRegion();

  void EnlargeOutputRequestedRegion( DataObject *itkNotUsed(output) );

  void GenerateData();


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

  bool                 m_FullyConnected;
  OutputImagePixelType m_BackgroundValue;
  OutputImagePixelType m_ForegroundValue;
  double               m_Lambda;
  bool                 m_ReverseOrdering;
  AttributeType        m_Attribute;
}; // end of class

} // end namespace itk
  
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkBinaryShapeOpeningImageFilter.txx"
#endif

#endif