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 "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
{
class ITK_ABI_EXPORT MeshFileReaderException:public ExceptionObject
{
public:
  itkTypeMacro(MeshFileReaderException, ExceptionObject);

  MeshFileReaderException(const char *file, unsigned int line,
                          const char *message = "Error in IO",
                          const char *loc = "Unknown"):
    ExceptionObject(file, line, message, loc)
  {}

  MeshFileReaderException(const std::string & file, unsigned int line,
                          const char *message = "Error in IO",
                          const char *loc = "Unknown"):
    ExceptionObject(file, line, message, loc)
  {}
};

template< class TOutputMesh,
          class ConvertPointPixelTraits = MeshConvertPixelTraits< typename TOutputMesh::PixelType >,
          class ConvertCellPixelTraits = MeshConvertPixelTraits< typename TOutputMesh::CellPixelType > >
class ITK_EXPORT MeshFileReader:public MeshSource< TOutputMesh >
{
public:
  typedef MeshFileReader             Self;
  typedef MeshSource< TOutputMesh >  Superclass;
  typedef SmartPointer< const Self > ConstPointer;
  typedef SmartPointer< Self >       Pointer;

  itkNewMacro(Self);

  itkTypeMacro(MeshFileReader, MeshSource);

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

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

  itkStaticConstMacro(OutputPointDimension, unsigned int, OutputMeshType::PointDimension);

  itkSetStringMacro(FileName);
  itkGetStringMacro(FileName);

  void  SetMeshIO(MeshIOBase *meshIO);

  itkGetObjectMacro(MeshIO, MeshIOBase);

  virtual void GenerateOutputInformation();

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

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

  void ReadPointData();

  void ReadCellData();

protected:
  MeshFileReader();
  ~MeshFileReader(){}
  void PrintSelf(std::ostream & os, Indent indent) const;

  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();

  virtual void GenerateData();

  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:
  MeshFileReader(const Self &); // purposely not implemented
  void operator=(const Self &); // purposely not implemented

  std::string m_ExceptionMessage;
};
} // namespace ITK

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

#endif