itkRelabelComponentImageFilter.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkRelabelComponentImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2009-04-27 22:58:48 $
  Version:   $Revision: 1.17 $

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

#include "itkInPlaceImageFilter.h"
#include "itkImage.h"
#include <vector>

namespace itk
{

template <class TInputImage, class TOutputImage>
class ITK_EXPORT RelabelComponentImageFilter : 
    public InPlaceImageFilter< TInputImage, TOutputImage > 
{
public:
  typedef RelabelComponentImageFilter                     Self;
  typedef InPlaceImageFilter< TInputImage, TOutputImage > Superclass;

  typedef typename Superclass::InputImagePointer InputImagePointer;

  typedef typename TOutputImage::PixelType         OutputPixelType;
  typedef typename TOutputImage::InternalPixelType OutputInternalPixelType;
  typedef typename TInputImage::PixelType          InputPixelType;
  typedef typename TInputImage::InternalPixelType  InputInternalPixelType;
  itkStaticConstMacro(ImageDimension, unsigned int,
                      TOutputImage::ImageDimension); 
  itkStaticConstMacro(InputImageDimension, unsigned int,
                      TInputImage::ImageDimension);
 
  typedef TInputImage                             InputImageType;
  typedef TOutputImage                            OutputImageType;
  typedef   typename TInputImage::IndexType       IndexType;
  typedef   typename TInputImage::SizeType        SizeType;
  typedef   typename TOutputImage::RegionType     RegionType;

  typedef SmartPointer<Self>        Pointer;
  typedef SmartPointer<const Self>  ConstPointer;
  
  itkTypeMacro(RelabelComponentImageFilter, ImageToImageFilter);
  
  itkNewMacro(Self);

  typedef unsigned long int    LabelType;

  typedef unsigned long int    ObjectSizeType;

  itkGetConstMacro(NumberOfObjects, LabelType);
  
  itkGetConstMacro(OriginalNumberOfObjects, LabelType);

  itkSetMacro(NumberOfObjectsToPrint, LabelType);
  itkGetConstReferenceMacro(NumberOfObjectsToPrint, LabelType);

  itkSetMacro(MinimumObjectSize, ObjectSizeType);

  itkGetConstMacro(MinimumObjectSize, ObjectSizeType);
   
  const std::vector<ObjectSizeType>& GetSizeOfObjectsInPixels() const
    { return m_SizeOfObjectsInPixels; }

  const std::vector<float>& GetSizeOfObjectsInPhysicalUnits() const
    { return m_SizeOfObjectsInPhysicalUnits; }

  ObjectSizeType GetSizeOfObjectInPixels( LabelType obj ) const
    {
    if (obj > 0 && obj <= m_NumberOfObjects)
      {
      return m_SizeOfObjectsInPixels[obj-1];
      }
    else
      {
      return 0;
      }
    }
  
  float GetSizeOfObjectInPhysicalUnits( LabelType obj ) const
    { 
    if (obj > 0 && obj <= m_NumberOfObjects)
      {
      return m_SizeOfObjectsInPhysicalUnits[obj-1];
      }
    else
      {
      return 0;
      }
    }

#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro(InputEqualityComparableCheck,
    (Concept::EqualityComparable<InputPixelType>));
  itkConceptMacro(UnsignedLongConvertibleToInputCheck,
    (Concept::Convertible<LabelType, InputPixelType>));
  itkConceptMacro(OutputLongConvertibleToUnsignedLongCheck,
    (Concept::Convertible<OutputPixelType, LabelType>));
  itkConceptMacro(InputConvertibleToOutputCheck,
    (Concept::Convertible<InputPixelType, OutputPixelType>));
  itkConceptMacro(SameDimensionCheck,
    (Concept::SameDimension<InputImageDimension, ImageDimension>));
#endif

protected:

  RelabelComponentImageFilter()
    : m_NumberOfObjects(0), m_NumberOfObjectsToPrint(10),
    m_OriginalNumberOfObjects(0), m_MinimumObjectSize(0)
    { this->InPlaceOff(); }
  virtual ~RelabelComponentImageFilter() {}
  RelabelComponentImageFilter(const Self&) {}

  void GenerateData();

  void GenerateInputRequestedRegion();

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

  struct RelabelComponentObjectType
    {
    LabelType       m_ObjectNumber;
    ObjectSizeType  m_SizeInPixels;
    float           m_SizeInPhysicalUnits;
    };

  // put the function objects here for sorting in descending order
  class RelabelComponentSizeInPixelsComparator
    {
    public:
      bool operator()(const RelabelComponentObjectType&a, 
                      const RelabelComponentObjectType &b)
      {
      if (a.m_SizeInPixels > b.m_SizeInPixels)
        {
        return true;
        }
      else if (a.m_SizeInPixels < b.m_SizeInPixels)
        {
        return false;
        }
      // size in pixels and physical units are the same, sort based on
      // original object number
      else if (a.m_ObjectNumber < b.m_ObjectNumber)
        {
        return true;
        }
      else
        {
        return false;
        }
      }
  };
  

private:

  LabelType       m_NumberOfObjects;
  LabelType       m_NumberOfObjectsToPrint;
  LabelType       m_OriginalNumberOfObjects;
  ObjectSizeType  m_MinimumObjectSize;

  std::vector<ObjectSizeType> m_SizeOfObjectsInPixels;
  std::vector<float>          m_SizeOfObjectsInPhysicalUnits;

};
  
} // end namespace itk

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

#endif