itkSimplexMesh.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.
 *
 *=========================================================================*/
#ifndef itkSimplexMesh_h
#define itkSimplexMesh_h
 
#include "itkMesh.h"
#include "itkSimplexMeshGeometry.h"
#include "itkVertexCell.h"
#include "itkTriangleCell.h"
#include "itkFixedArray.h"
#include <vector>
#include <algorithm>
#include <set>
 
namespace itk
{
template <typename TPixelType,
          unsigned int VDimension = 3,
          typename TMeshTraits =
            DefaultStaticMeshTraits<TPixelType, VDimension, VDimension, TPixelType, TPixelType, TPixelType>>
class ITK_TEMPLATE_EXPORT SimplexMesh : public Mesh<TPixelType, VDimension, TMeshTraits>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(SimplexMesh);

  using Self = SimplexMesh;

  using Superclass = Mesh<TPixelType, VDimension, TMeshTraits>;

  using Pointer = SmartPointer<Self>;

  using ConstPointer = SmartPointer<const Self>;

  using IndexArray = typename SimplexMeshGeometry::IndexArray;

  using NeighborSetType = std::set<SizeValueType>;

  using NeighborSetIterator = typename NeighborSetType::iterator;

  using NeighborListType = std::vector<SizeValueType>;

  using PointType = typename TMeshTraits::PointType;

  using PointIdentifier = typename TMeshTraits::PointIdentifier;

  using VectorType = typename PointType::VectorType;

  using CovariantVectorType = CovariantVector<typename VectorType::ValueType, 3>;

  using typename Superclass::CellType;

  using CellAutoPointer = typename CellType::CellAutoPointer;

  using LineType = itk::LineCell<CellType>;

  using GeometryMapType = itk::MapContainer<SizeValueType, SimplexMeshGeometry *>;

  using GeometryMapPointer = typename GeometryMapType::Pointer;

  using GeometryMapIterator = typename GeometryMapType::Iterator;
  using GeometryMapConstIterator = typename GeometryMapType::ConstIterator;
 
  // Backward compatibility to expose enum from class.
  using MeshClassCellsAllocationMethodEnum = itk::MeshEnums::MeshClassCellsAllocationMethod;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(SimplexMesh);

  using MeshTraits = TMeshTraits;
  using PixelType = typename MeshTraits::PixelType;
  using PointsContainer = typename MeshTraits::PointsContainer;
  using typename Superclass::PointsContainerPointer;
  using PointsContainerIterator = typename Superclass::PointsContainer::Iterator;
  using typename Superclass::PointsContainerConstIterator;
  using typename Superclass::CellsContainerPointer;
  using typename Superclass::CellsContainerConstPointer;
  using typename Superclass::CellsContainerIterator;
  using typename Superclass::CellsContainerConstIterator;
  using typename Superclass::CellIdentifier;

  itkSetMacro(GeometryData, GeometryMapPointer);

  itkGetConstReferenceMacro(GeometryData, GeometryMapPointer);

  itkSetMacro(LastCellId, CellIdentifier);

  itkGetConstMacro(LastCellId, CellIdentifier);

  void
  CopyInformation(const DataObject * data) override;

  CellIdentifier
  AddEdge(PointIdentifier startPointId, PointIdentifier endPointId);

  CellIdentifier
  AddFace(CellAutoPointer & cellPointer);

  CellIdentifier
  ReplaceFace(CellIdentifier replaceIndex, CellAutoPointer & cellPointer);

  IndexArray
  GetNeighbors(PointIdentifier idx) const;

  NeighborListType *
  GetNeighbors(PointIdentifier idx, unsigned int radius, NeighborListType * list = nullptr) const;

  void
  AddNeighbor(PointIdentifier pointIdx, PointIdentifier neighborIdx);

  void
  ReplaceNeighbor(PointIdentifier pointIdx, PointIdentifier oldIdx, PointIdentifier newIdx);

  void
  SwapNeighbors(PointIdentifier pointIdx, PointIdentifier firstIdx, PointIdentifier secondIdx);

  void
  SetGeometryData(PointIdentifier pointId, SimplexMeshGeometry *);

  void
  SetBarycentricCoordinates(PointIdentifier idx, PointType value);

  PointType
  GetBarycentricCoordinates(PointIdentifier idx) const;

  void
  SetReferenceMetrics(PointIdentifier idx, PointType value);

  PointType
  GetReferenceMetrics(PointIdentifier idx) const;

  void
  SetPhi(PointIdentifier idx, double value);

  double
  GetPhi(PointIdentifier idx) const;

  void
  SetMeanCurvature(PointIdentifier idx, double value);

  double
  GetMeanCurvature(PointIdentifier idx) const;

  void
  SetRadius(PointIdentifier idx, double value);

  double
  GetRadius(PointIdentifier idx) const;

  void
  SetDistance(PointIdentifier idx, double value);

  double
  GetDistance(PointIdentifier idx) const;

  CovariantVectorType
  ComputeNormal(PointIdentifier idx) const;
 
protected:
  SimplexMesh();
  ~SimplexMesh() override;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  GeometryMapPointer m_GeometryData{};

  CellIdentifier m_LastCellId{};
}; // End Class:  SimplexMesh
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkSimplexMesh.hxx"
#endif
 
#endif