itkConnectedRegionsMeshFilter.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.
 *
 *=========================================================================*/
/*=========================================================================
 *
 *  Portions of this file are subject to the VTK Toolkit Version 3 copyright.
 *
 *  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
 *
 *  For complete copyright, license and disclaimer of warranty information
 *  please refer to the NOTICE file at the top of the ITK source tree.
 *
 *=========================================================================*/
#ifndef itkConnectedRegionsMeshFilter_h
#define itkConnectedRegionsMeshFilter_h

#include "itkIntTypes.h"
#include "itkMeshToMeshFilter.h"

namespace itk
{
template< typename TInputMesh, typename TOutputMesh >
class ConnectedRegionsMeshFilter:
  public MeshToMeshFilter< TInputMesh, TOutputMesh >
{
public:
  typedef ConnectedRegionsMeshFilter Self;

  typedef MeshToMeshFilter< TInputMesh, TOutputMesh > Superclass;

  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  itkNewMacro(Self);

  typedef TInputMesh                        InputMeshType;
  typedef TOutputMesh                       OutputMeshType;
  typedef typename TInputMesh::ConstPointer InputMeshConstPointer;
  typedef typename TOutputMesh::Pointer     OutputMeshPointer;

  itkStaticConstMacro(PointDimension, unsigned int,
                      TInputMesh::PointDimension);

  typedef typename TInputMesh::PointType                           InputMeshPointType;
  typedef typename TInputMesh::PointIdentifier                     InputMeshPointIdentifier;
  typedef typename TInputMesh::PointsContainerConstPointer         InputMeshPointsContainerConstPointer;
  typedef typename TInputMesh::CellsContainer                      InputMeshCellsContainer;
  typedef typename TInputMesh::CellsContainerPointer               InputMeshCellsContainerPointer;
  typedef typename TInputMesh::CellsContainerConstPointer          InputMeshCellsContainerConstPointer;
  typedef typename TInputMesh::CellDataContainer                   InputMeshCellDataContainer;
  typedef typename TInputMesh::CellDataContainerPointer            InputMeshCellDataContainerPointer;
  typedef typename TInputMesh::CellDataContainerConstPointer       InputMeshCellDataContainerConstPointer;
  typedef typename InputMeshType::PointsContainer::ConstIterator   PointsContainerConstIterator;
  typedef typename InputMeshType::CellsContainer::ConstIterator    CellsContainerConstIterator;
  typedef typename InputMeshType::CellDataContainer::ConstIterator CellDataContainerConstIterator;
  typedef typename TInputMesh::CellAutoPointer                     InputMeshCellPointer;
  typedef typename TInputMesh::CellTraits::PointIdConstIterator    InputMeshPointIdConstIterator;
  typedef typename TInputMesh::CellLinksContainerConstPointer      InputMeshCellLinksContainerConstPointer;
  typedef typename TInputMesh::PointCellLinksContainer             InputMeshCellLinksContainer;
  typedef typename TInputMesh::CellIdentifier                      InputMeshCellIdentifier;

  enum { PointSeededRegions = 0,
         CellSeededRegions = 1,
         SpecifiedRegions = 2,
         LargestRegion = 3,
         AllRegions = 4,
         ClosestPointRegion = 5 };

  itkSetMacro(ExtractionMode, int);
  itkGetConstMacro(ExtractionMode, int);

  void SetExtractionModeToPointSeededRegions(void)
  {
    this->SetExtractionMode(Self::PointSeededRegions);
  }

  void SetExtractionModeToCellSeededRegions(void)
  {
    this->SetExtractionMode(Self::CellSeededRegions);
  }

  void SetExtractionModeToSpecifiedRegions(void)
  {
    this->SetExtractionMode(Self::SpecifiedRegions);
  }

  void SetExtractionModeToLargestRegion(void)
  {
    this->SetExtractionMode(Self::LargestRegion);
  }

  void SetExtractionModeToAllRegions(void)
  {
    this->SetExtractionMode(Self::AllRegions);
  }

  void SetExtractionModeToClosestPointRegion(void)
  {
    this->SetExtractionMode(Self::ClosestPointRegion);
  }

  void InitializeSeedList(void)
  {
    this->Modified();
    m_SeedList.clear();
  }

  void AddSeed(IdentifierType id)
  {
    this->Modified();
    m_SeedList.push_back(id);
  }

  void DeleteSeed(IdentifierType id);

  void InitializeSpecifiedRegionList(void)
  {
    this->Modified();
    m_RegionList.clear();
  }

  void AddSpecifiedRegion(IdentifierType id)
  {
    this->Modified();
    m_RegionList.push_back(id);
  }

  void DeleteSpecifiedRegion(IdentifierType id);

  void SetClosestPoint(InputMeshPointType & p)
  {
    if ( m_ClosestPoint != p )
      {
      m_ClosestPoint = p;
      this->Modified();
      }
  }

  InputMeshPointType & GetClosestPoint(InputMeshPointType &)
  {
    return m_ClosestPoint;
  }

  SizeValueType GetNumberOfExtractedRegions()
  {
    return m_RegionList.size();
  }

protected:

  ConnectedRegionsMeshFilter();
  virtual ~ConnectedRegionsMeshFilter(void) {}

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

  virtual void GenerateData() ITK_OVERRIDE;

  void PropagateConnectedWave();

private:

  ConnectedRegionsMeshFilter(const Self &); //purposely not implemented
  void operator=(const Self &);             //purposely not implemented

  int                            m_ExtractionMode;
  InputMeshPointType             m_ClosestPoint;
  std::vector< IdentifierType >  m_SeedList;
  std::vector< IdentifierType >  m_RegionList;
  std::vector< SizeValueType >   m_RegionSizes;

  std::vector< OffsetValueType > m_Visited;
  SizeValueType                  m_NumberOfCellsInRegion;
  IdentifierType                 m_RegionNumber;
  std::vector< IdentifierType > *m_Wave;
  std::vector< IdentifierType > *m_Wave2;
}; // class declaration
} // end namespace itk

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

#endif