itkShapeRelabelLabelMapFilter.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkShapeRelabelLabelMapFilter.h,v $
  Language:  C++
  Date:      $Date: 2009-08-09 17:53:01 $
  Version:   $Revision: 1.7 $

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

#include "itkInPlaceLabelMapFilter.h"
#include "itkLabelObject.h"
#include "itkLabelObjectAccessors.h"
#include "itkShapeLabelObjectAccessors.h"

namespace itk {
template<class TImage >
class ITK_EXPORT ShapeRelabelLabelMapFilter : 
    public InPlaceLabelMapFilter<TImage>
{
public:
  typedef ShapeRelabelLabelMapFilter    Self;
  typedef InPlaceLabelMapFilter<TImage> Superclass;
  typedef SmartPointer<Self>            Pointer;
  typedef SmartPointer<const Self>      ConstPointer;

  typedef TImage                                   ImageType;
  typedef typename ImageType::Pointer              ImagePointer;
  typedef typename ImageType::ConstPointer         ImageConstPointer;
  typedef typename ImageType::PixelType            PixelType;
  typedef typename ImageType::IndexType            IndexType;
  typedef typename ImageType::LabelObjectType      LabelObjectType;

  typedef typename LabelObjectType::AttributeType AttributeType;
  
  itkStaticConstMacro( ImageDimension, unsigned int, TImage::ImageDimension );

  itkNewMacro( Self );

  itkTypeMacro( ShapeRelabelLabelMapFilter, InPlaceLabelMapFilter );

#ifdef ITK_USE_CONCEPT_CHECKING

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

#endif

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

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


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

  void GenerateData();

  typedef typename Superclass::LabelObjectContainerType LabelObjectContainerType;

  template <class TAttributeAccessor> 
  void TemplatedGenerateData( const TAttributeAccessor & )
    {
    // Allocate the output
    this->AllocateOutputs();

    ImageType * output = this->GetOutput();

    const LabelObjectContainerType & labelObjectContainer = output->GetLabelObjectContainer();
    typedef typename LabelObjectType::Pointer     LabelObjectPointer;
    typedef std::vector< LabelObjectPointer >     VectorType;

    ProgressReporter progress( this, 0, 2 * labelObjectContainer.size() );

    // Get the label objects in a vector, so they can be sorted
    VectorType labelObjects;
    labelObjects.reserve( labelObjectContainer.size() );
    for( typename LabelObjectContainerType::const_iterator it = labelObjectContainer.begin();
      it != labelObjectContainer.end();
      it++ )
      {
      labelObjects.push_back( it->second );
      progress.CompletedPixel();
      }

    // Instantiate the comparator and sort the vector
    if( m_ReverseOrdering )
      {
      std::sort( labelObjects.begin(), labelObjects.end(),
        Functor::LabelObjectReverseComparator< LabelObjectType, TAttributeAccessor >() );
      }
    else
      {
      std::sort( labelObjects.begin(), labelObjects.end(),
        Functor::LabelObjectComparator< LabelObjectType, TAttributeAccessor >() );
      }
    //   progress.CompletedPixel();
    
    // and put back the objects in the map
    output->ClearLabels();
    unsigned int label = 0;
    typename VectorType::const_iterator it2 = labelObjects.begin();
    while( it2 != labelObjects.end() )
      {
      // Avoid the background label if it is used
      if( label == output->GetBackgroundValue() )
        {
        label++;
        }
      ( *it2 )->SetLabel( label );
      output->AddLabelObject( *it2 );
      
      // Go to the next label
      label++;
      progress.CompletedPixel();

      it2++;
      }
    }

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

  bool          m_ReverseOrdering;
  AttributeType m_Attribute;

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

}; // end of class

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

#endif