itkMeshFileReader.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.
 *
 *=========================================================================*/
#ifndef itkMeshFileReader_h
#define itkMeshFileReader_h

#include "itkMeshFileReaderException.h"
#include "itkMacro.h"
#include "itkHexahedronCell.h"
#include "itkLineCell.h"
#include "itkMeshIOBase.h"
#include "itkMeshSource.h"
#include "itkPolygonCell.h"
#include "itkQuadrilateralCell.h"
#include "itkQuadraticEdgeCell.h"
#include "itkQuadraticTriangleCell.h"
#include "itkTetrahedronCell.h"
#include "itkTriangleCell.h"
#include "itkVertexCell.h"

#include "itkDefaultConvertPixelTraits.h"
#include "itkMeshConvertPixelTraits.h"

namespace itk
{

template< typename TOutputMesh,
          typename ConvertPointPixelTraits = MeshConvertPixelTraits< typename TOutputMesh::PixelType >,
          class ConvertCellPixelTraits = MeshConvertPixelTraits< typename TOutputMesh::CellPixelType > >
class ITK_TEMPLATE_EXPORT MeshFileReader:public MeshSource< TOutputMesh >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(MeshFileReader);

  using Self = MeshFileReader;
  using Superclass = MeshSource< TOutputMesh >;
  using ConstPointer = SmartPointer< const Self >;
  using Pointer = SmartPointer< Self >;

  itkNewMacro(Self);

  itkTypeMacro(MeshFileReader, MeshSource);

  using OutputMeshType = TOutputMesh;
  using OutputCoordRepType = typename OutputMeshType::CoordRepType;
  using OutputPointPixelType = typename OutputMeshType::PixelType;
  using OutputCellPixelType = typename OutputMeshType::CellPixelType;
  using OutputPointType = typename OutputMeshType::PointType;
  using OutputPointIdentifier = typename OutputMeshType::PointIdentifier;
  using OutputCellIdentifier = typename OutputMeshType::CellIdentifier;
  using OutputCellAutoPointer = typename OutputMeshType::CellAutoPointer;
  using OutputCellType = typename OutputMeshType::CellType;
  using SizeValueType = typename MeshIOBase::SizeValueType;

  using OutputVertexCellType = VertexCell< OutputCellType >;
  using OutputLineCellType = LineCell< OutputCellType >;
  using OutputTriangleCellType = TriangleCell< OutputCellType >;
  using OutputPolygonCellType = PolygonCell< OutputCellType >;
  using OutputTetrahedronCellType = TetrahedronCell< OutputCellType >;
  using OutputHexahedronCellType = HexahedronCell< OutputCellType >;
  using OutputQuadrilateralCellType = QuadrilateralCell< OutputCellType >;
  using OutputQuadraticEdgeCellType = QuadraticEdgeCell< OutputCellType >;
  using OutputQuadraticTriangleCellType = QuadraticTriangleCell< OutputCellType >;

  static constexpr unsigned int OutputPointDimension = OutputMeshType::PointDimension;

  itkSetStringMacro(FileName);
  itkGetStringMacro(FileName);

  void  SetMeshIO(MeshIOBase *meshIO);
  itkGetModifiableObjectMacro(MeshIO, MeshIOBase);

  void GenerateOutputInformation() override;

  template< typename T >
  void ReadPoints(T *buffer);

  template< typename T >
  void ReadCells(T *buffer);

  void ReadPointData();

  void ReadCellData();

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

  template< typename T >
  void ConvertPointPixelBuffer(void *inputData, T *outputData, size_t numberOfPixels);

  template< typename T >
  void ConvertCellPixelBuffer(void *inputData, T *outputData, size_t numberOfPixels);

  void TestFileExistanceAndReadability();

  void GenerateData() override;

  MeshIOBase::Pointer m_MeshIO;
  bool                m_UserSpecifiedMeshIO; // keep track whether the MeshIO is
                                             // user specified
  std::string m_FileName;                    // The file to be read

private:
  std::string m_ExceptionMessage;
};
} // end namespace itk

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

#ifdef ITK_IO_FACTORY_REGISTER_MANAGER
#include "itkMeshIOFactoryRegisterManager.h"
#endif

#endif