itkMeshFileWriter.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 itkMeshFileWriter_h
#define itkMeshFileWriter_h
 
#include "itkMeshFileWriterException.h"
#include "itkProcessObject.h"
#include "itkMeshIOBase.h"
 
namespace itk
{

template <typename TInputMesh>
class ITK_TEMPLATE_EXPORT MeshFileWriter : public ProcessObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(MeshFileWriter);

  using Self = MeshFileWriter;
  using Superclass = ProcessObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(MeshFileWriter);

  using InputMeshType = TInputMesh;
  using InputMeshPointer = typename InputMeshType::Pointer;
  using InputMeshRegionType = typename InputMeshType::RegionType;
  using InputMeshPixelType = typename InputMeshType::PixelType;
  using InputMeshCellType = typename InputMeshType::CellType;
  using SizeValueType = typename MeshIOBase::SizeValueType;

  using Superclass::SetInput;
  void
  SetInput(const InputMeshType * input);
 
  const InputMeshType *
  GetInput();
 
  const InputMeshType *
  GetInput(unsigned int idx);

  itkSetStringMacro(FileName);
  itkGetStringMacro(FileName);

  void
  SetMeshIO(MeshIOBase * io)
  {
    if (this->m_MeshIO != io)
    {
      this->Modified();
      this->m_MeshIO = io;
    }
    m_FactorySpecifiedMeshIO = false;
    m_UserSpecifiedMeshIO = true;
  }
  itkGetModifiableObjectMacro(MeshIO, MeshIOBase);
 
  void
  SetFileTypeAsASCII()
  {
    m_FileTypeIsBINARY = false;
  }
  void
  SetFileTypeAsBINARY()
  {
    m_FileTypeIsBINARY = true;
  }

  virtual void
  Write();

  void
  Update() override
  {
    this->Write();
  }

  itkSetMacro(UseCompression, bool);
  itkGetConstReferenceMacro(UseCompression, bool);
  itkBooleanMacro(UseCompression);
 
protected:
  MeshFileWriter() = default;
  ~MeshFileWriter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  template <typename Output>
  void
  CopyPointsToBuffer(Output * data);
 
  template <typename Output>
  void
  CopyCellsToBuffer(Output * data);
 
  template <typename Output>
  void
  CopyPointDataToBuffer(Output * data);
 
  template <typename Output>
  void
  CopyCellDataToBuffer(Output * data);
 
  void
  WritePoints();
 
  void
  WriteCells();
 
  void
  WritePointData();
 
  void
  WriteCellData();
 
private:
  std::string         m_FileName{};
  MeshIOBase::Pointer m_MeshIO{ nullptr };
  bool                m_UserSpecifiedMeshIO{ false };    // track whether the MeshIO is user specified
  bool                m_FactorySpecifiedMeshIO{ false }; // track whether the factory mechanism set the MeshIO
  bool                m_UseCompression{ false };
  bool                m_FileTypeIsBINARY{ false };
};
 

template <typename TMeshPointer>
ITK_TEMPLATE_EXPORT void
WriteMesh(TMeshPointer && mesh, const std::string & filename, bool compress = false)
{
  using NonReferenceMeshPointer = std::remove_reference_t<TMeshPointer>;
  static_assert(std::is_pointer_v<NonReferenceMeshPointer> || mpl::IsSmartPointer<NonReferenceMeshPointer>::Value,
                "WriteMesh requires a raw pointer or SmartPointer.");
 
  using MeshType = std::remove_const_t<std::remove_reference_t<decltype(*mesh)>>;
  auto writer = MeshFileWriter<MeshType>::New();
  writer->SetInput(mesh);
  writer->SetFileName(filename);
  writer->SetUseCompression(compress);
  writer->Update();
}
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkMeshFileWriter.hxx"
#endif
 
#if defined ITK_MESHIO_FACTORY_REGISTER_MANAGER || defined ITK_IO_FACTORY_REGISTER_MANAGER
#  include "itkMeshIOFactoryRegisterManager.h"
#endif
 
#endif // itkMeshFileWriter_h