itkConformalFlatteningMeshFilter.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 itkConformalFlatteningMeshFilter_h
#define itkConformalFlatteningMeshFilter_h
 
#include "itkMesh.h"
#include "itkMeshToMeshFilter.h"
 
// vnl headers
#include "itkMath.h"
#include "vnl/vnl_sparse_matrix.h"
 
 
namespace itk
{
 
template <typename TInputMesh, typename TOutputMesh>
class ITK_TEMPLATE_EXPORT ConformalFlatteningMeshFilter : public MeshToMeshFilter<TInputMesh, TOutputMesh>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ConformalFlatteningMeshFilter);

  using Self = ConformalFlatteningMeshFilter;
 
  using InputMeshType = TInputMesh;
  using OutputMeshType = TOutputMesh;
 
  using Superclass = MeshToMeshFilter<TInputMesh, TOutputMesh>;
 
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using InputMeshConstPointer = typename InputMeshType::ConstPointer;
  using OutputMeshPointer = typename OutputMeshType::Pointer;
  using InputPointType = typename InputMeshType::PointType;
  using OutputPointType = typename OutputMeshType::PointType;

  // using CoordinateType = typename TInputMesh::CoordinateType;
  using CoordinateType = double;
#ifndef ITK_FUTURE_LEGACY_REMOVE
  using CoordRepType ITK_FUTURE_DEPRECATED(
    "ITK 6 discourages using `CoordRepType`. Please use `CoordinateType` instead!") = CoordinateType;
#endif

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ConformalFlatteningMeshFilter);

  static constexpr unsigned int InputPointDimension = TInputMesh::PointDimension;
  static constexpr unsigned int OutputPointDimension = TOutputMesh::PointDimension;
 
  using PointsContainer = typename InputMeshType::PointsContainer;
  using CellsContainer = typename InputMeshType::CellsContainer;
  using PointIdentifier = typename InputMeshType::PointIdentifier;
  using CellIdentifier = typename InputMeshType::CellIdentifier;
  using PointIterator = typename PointsContainer::ConstIterator;
  using CellIterator = typename CellsContainer::ConstIterator;
  using CellType = typename InputMeshType::CellType;
  using PointIdIterator = typename CellType::PointIdIterator;
  using CellAutoPointer = typename CellType::CellAutoPointer;

  void
  SetPolarCellIdentifier(CellIdentifier cellId);

  void
  SetScale(double);

  void
  MapToSphere();

  void
  MapToPlane();
 
protected:
  ConformalFlatteningMeshFilter();
  ~ConformalFlatteningMeshFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  GenerateData() override;
 
private:
  using VectorCoordType = vnl_vector<CoordinateType>;
  using SparseMatrixCoordType = vnl_sparse_matrix<CoordinateType>;

  unsigned int m_PolarCellIdentifier{};

  bool m_MapToSphere{};

  double m_MapScale{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkConformalFlatteningMeshFilter.hxx"
#endif
 
#endif