itkMesh.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 itkMesh_h
#define itkMesh_h
 
 
#include "itkPointSet.h"
 
#include "itkBoundingBox.h"
#include "itkCellInterface.h"
#include "itkMapContainer.h"
#include "itkCommonEnums.h"
#include "ITKMeshExport.h"
#include <vector>
#include <set>
#include "itkVectorContainer.h"
#include "itkVertexCell.h"
#include "itkLineCell.h"
#include "itkPolyLineCell.h"
#include "itkTriangleCell.h"
#include "itkQuadrilateralCell.h"
#include "itkPolygonCell.h"
#include "itkTetrahedronCell.h"
#include "itkHexahedronCell.h"
#include "itkQuadraticEdgeCell.h"
#include "itkQuadraticTriangleCell.h"
 
 
namespace itk
{
 
template <typename TPixelType,
          unsigned int VDimension = 3,
          typename TMeshTraits = DefaultStaticMeshTraits<TPixelType, VDimension, VDimension>>
class ITK_TEMPLATE_EXPORT Mesh : public PointSet<TPixelType, VDimension, TMeshTraits>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(Mesh);
 
  using Self = Mesh;
  using Superclass = PointSet<TPixelType, VDimension, TMeshTraits>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using typename Superclass::RegionType;
 
  itkNewMacro(Self);
 
  itkOverrideGetNameOfClassMacro(Mesh);
 
  using MeshTraits = TMeshTraits;
  using PixelType = typename MeshTraits::PixelType;
  using CellPixelType = typename MeshTraits::CellPixelType;
  using MeshClassCellsAllocationMethodEnum = MeshEnums::MeshClassCellsAllocationMethod;
 
  static constexpr unsigned int PointDimension = TMeshTraits::PointDimension;
  static constexpr unsigned int MaxTopologicalDimension = TMeshTraits::MaxTopologicalDimension;
 
#if !defined(ITK_LEGACY_REMOVE)
  using CellsAllocationMethodType = MeshClassCellsAllocationMethodEnum;
  // We need to expose the enum values at the class level
  // for backwards compatibility
  static constexpr CellsAllocationMethodType CellsAllocationMethodUndefined =
    MeshClassCellsAllocationMethodEnum::CellsAllocationMethodUndefined;
  static constexpr CellsAllocationMethodType CellsAllocatedAsStaticArray =
    MeshEnums::MeshClassCellsAllocationMethod::CellsAllocatedAsStaticArray;
  static constexpr CellsAllocationMethodType CellsAllocatedAsADynamicArray =
    MeshEnums::MeshClassCellsAllocationMethod::CellsAllocatedAsADynamicArray;
  static constexpr CellsAllocationMethodType CellsAllocatedDynamicallyCellByCell =
    MeshEnums::MeshClassCellsAllocationMethod::CellsAllocatedDynamicallyCellByCell;
#endif
 
  using CoordinateType = typename MeshTraits::CoordinateType;
#ifndef ITK_FUTURE_LEGACY_REMOVE
  using CoordRepType ITK_FUTURE_DEPRECATED(
    "ITK 6 discourages using `CoordRepType`. Please use `CoordinateType` instead!") = CoordinateType;
#endif
  using InterpolationWeightType = typename MeshTraits::InterpolationWeightType;
  using PointIdentifier = typename MeshTraits::PointIdentifier;
  using CellIdentifier = typename MeshTraits::CellIdentifier;
  using CellFeatureIdentifier = typename MeshTraits::CellFeatureIdentifier;
  using PointHashType = typename MeshTraits::PointHashType;
  using PointType = typename MeshTraits::PointType;
  using PointsContainer = typename MeshTraits::PointsContainer;
  using CellTraits = typename MeshTraits::CellTraits;
  using CellsContainer = typename MeshTraits::CellsContainer;
  using PointCellLinksContainer = typename MeshTraits::PointCellLinksContainer;
  using CellLinksContainer = typename MeshTraits::CellLinksContainer;
  using PointDataContainer = typename MeshTraits::PointDataContainer;
  using CellDataContainer = typename MeshTraits::CellDataContainer;
 
  using CellsVectorContainer = typename itk::VectorContainer<IdentifierType>;
  using CellsVectorContainerPointer = typename CellsVectorContainer::Pointer;
 
  using BoundingBoxType = BoundingBox<PointIdentifier, Self::PointDimension, CoordinateType, PointsContainer>;
 
  using PointsContainerPointer = typename PointsContainer::Pointer;
  using CellsContainerPointer = typename CellsContainer::Pointer;
  using CellsContainerConstPointer = typename CellsContainer::ConstPointer;
  using CellLinksContainerPointer = typename CellLinksContainer::Pointer;
  using PointDataContainerPointer = typename PointDataContainer::Pointer;
  using CellDataContainerPointer = typename CellDataContainer::Pointer;
  using CellDataContainerConstPointer = typename CellDataContainer::ConstPointer;
  using BoundingBoxPointer = typename BoundingBoxType::Pointer;
  using CellLinksContainerConstPointer = typename CellLinksContainer::ConstPointer;
 
  using PointsContainerConstIterator = typename PointsContainer::ConstIterator;
  using PointsContainerIterator = typename PointsContainer::Iterator;
  using CellsContainerConstIterator = typename CellsContainer::ConstIterator;
  using CellsContainerIterator = typename CellsContainer::Iterator;
  using CellLinksContainerIterator = typename CellLinksContainer::ConstIterator;
  using PointDataContainerIterator = typename PointDataContainer::ConstIterator;
  using CellDataContainerIterator = typename CellDataContainer::ConstIterator;
  using PointCellLinksContainerIterator = typename PointCellLinksContainer::const_iterator;
 
  using CellFeatureCount = CellFeatureIdentifier;
 
  using CellType = CellInterface<CellPixelType, CellTraits>;
  using OutputVertexCellType = itk::VertexCell<CellType>;
  using OutputLineCellType = itk::LineCell<CellType>;
  using OutputPolyLineCellType = itk::PolyLineCell<CellType>;
  using OutputTriangleCellType = itk::TriangleCell<CellType>;
  using OutputQuadrilateralCellType = itk::QuadrilateralCell<CellType>;
  using OutputPolygonCellType = itk::PolygonCell<CellType>;
  using OutputTetrahedronCellType = itk::TetrahedronCell<CellType>;
  using OutputHexahedronCellType = itk::HexahedronCell<CellType>;
  using OutputQuadraticEdgeCellType = itk::QuadraticEdgeCell<CellType>;
  using OutputQuadraticTriangleCellType = itk::QuadraticTriangleCell<CellType>;
  using CellAutoPointer = typename CellType::CellAutoPointer;
 
  using CellMultiVisitorType = typename CellType::MultiVisitor;
 
  class BoundaryAssignmentIdentifier
  {
  public:
    using Self = BoundaryAssignmentIdentifier;
 
    BoundaryAssignmentIdentifier() = default;
    BoundaryAssignmentIdentifier(CellIdentifier cellId, CellFeatureIdentifier featureId)
      : m_CellId(cellId)
      , m_FeatureId(featureId)
    {}
 
    CellIdentifier m_CellId;
 
    CellFeatureIdentifier m_FeatureId;
 
    bool
    operator<(const Self & r) const
    {
      return ((m_CellId < r.m_CellId) || ((m_CellId == r.m_CellId) && (m_FeatureId < r.m_FeatureId)));
    }
 
    bool
    operator==(const Self & r) const
    {
      return ((m_CellId == r.m_CellId) && (m_FeatureId == r.m_FeatureId));
    }
  }; // End Class: Mesh::BoundaryAssignmentIdentifier
  using BoundaryAssignmentsContainer = MapContainer<BoundaryAssignmentIdentifier, CellIdentifier>;
  using BoundaryAssignmentsContainerPointer = typename BoundaryAssignmentsContainer::Pointer;
  using BoundaryAssignmentsContainerVector = std::vector<BoundaryAssignmentsContainerPointer>;
 
protected:
  CellsContainerPointer m_CellsContainer{};
 
  CellsVectorContainerPointer cellOutputVectorContainer;
  CellDataContainerPointer m_CellDataContainer{};
 
  mutable CellLinksContainerPointer m_CellLinksContainer{};
 
  BoundaryAssignmentsContainerVector m_BoundaryAssignmentsContainers{};
 
public:
  CellIdentifier
  GetNumberOfCells() const;
 
  void
  PassStructure(Self * inputMesh);
 
  void
  Initialize() override;
 
  void
  CopyInformation(const DataObject * data) override;
 
  void
  Graft(const DataObject * data) override;
 
  const BoundingBoxType *
  GetBoundingBox() const;
 
  void
  SetCellLinks(CellLinksContainer *);
 
  CellLinksContainer *
  GetCellLinks();
 
  const CellLinksContainer *
  GetCellLinks() const;
 
  void
  SetCells(CellsContainer *);
 
  virtual void
  SetCellsArray(CellsVectorContainer *);
 
  virtual void
  SetCellsArray(CellsVectorContainer *, int cellType);
 
  virtual CellsVectorContainer *
  GetCellsArray();
 
  CellsContainer *
  GetCells();
 
  const CellsContainer *
  GetCells() const;
 
  void
  SetCellData(CellDataContainer *);
 
  CellDataContainer *
  GetCellData();
 
  const CellDataContainer *
  GetCellData() const;
 
  void
  DeleteUnusedCellData();
 
#if !defined(ITK_WRAPPING_PARSER)
  void
  SetBoundaryAssignments(int dimension, BoundaryAssignmentsContainer *);
 
  BoundaryAssignmentsContainerPointer
  GetBoundaryAssignments(int dimension);
 
  const BoundaryAssignmentsContainerPointer
  GetBoundaryAssignments(int dimension) const;
#endif
 
  void
  SetCell(CellIdentifier, CellAutoPointer &);
 
  bool
  GetCell(CellIdentifier, CellAutoPointer &) const;
 
  void SetCellData(CellIdentifier, CellPixelType);
 
  bool
  GetCellData(CellIdentifier, CellPixelType *) const;
 
  void
  SetBoundaryAssignment(int                   dimension,
                        CellIdentifier        cellId,
                        CellFeatureIdentifier featureId,
                        CellIdentifier        boundaryId);
 
  bool
  GetBoundaryAssignment(int                   dimension,
                        CellIdentifier        cellId,
                        CellFeatureIdentifier featureId,
                        CellIdentifier *      boundaryId) const;
 
  bool
  RemoveBoundaryAssignment(int dimension, CellIdentifier cellId, CellFeatureIdentifier featureId);
 
  CellFeatureCount
  GetNumberOfCellBoundaryFeatures(int dimension, CellIdentifier) const;
 
  bool
  GetCellBoundaryFeature(int dimension, CellIdentifier, CellFeatureIdentifier, CellAutoPointer &) const;
 
  CellIdentifier
  GetCellBoundaryFeatureNeighbors(int dimension,
                                  CellIdentifier,
                                  CellFeatureIdentifier,
                                  std::set<CellIdentifier> * cellSet);
 
  CellIdentifier
  GetCellNeighbors(CellIdentifier cellId, std::set<CellIdentifier> * cellSet);
 
  bool
  GetAssignedCellBoundaryIfOneExists(int dimension, CellIdentifier, CellFeatureIdentifier, CellAutoPointer &) const;
 
  void
  BuildCellLinks() const;
 
  virtual void
  Accept(CellMultiVisitorType * mv) const;
 
  itkSetMacro(CellsAllocationMethod, MeshClassCellsAllocationMethodEnum);
  itkGetConstReferenceMacro(CellsAllocationMethod, MeshClassCellsAllocationMethodEnum);
protected:
  Mesh();
  ~Mesh() override;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
  void
  ReleaseCellsMemory();
 
  BoundingBoxPointer m_BoundingBox{};
 
private:
  MeshClassCellsAllocationMethodEnum m_CellsAllocationMethod{};
 
  void
  CreateCell(int cellType, CellAutoPointer &);
}; // End Class: Mesh
 
extern ITKMesh_EXPORT std::ostream &
                      operator<<(std::ostream & out, const MeshEnums::MeshClassCellsAllocationMethod value);
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  ifndef ITK_WRAPPING_PARSER
#    include "itkMesh.hxx"
#  endif
#endif
 
#endif