itkVTKImageIO.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.
 *
 *=========================================================================*/
/*=========================================================================
 *
 *  Portions of this file are subject to the VTK Toolkit Version 3 copyright.
 *
 *  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
 *
 *  For complete copyright, license and disclaimer of warranty information
 *  please refer to the NOTICE file at the top of the ITK source tree.
 *
 *=========================================================================*/
#ifndef itkVTKImageIO_h
#define itkVTKImageIO_h
#include "ITKIOVTKExport.h"
 
 
#include <fstream>
#include "itkStreamingImageIOBase.h"
 
namespace itk
{
class ITKIOVTK_EXPORT VTKImageIO : public StreamingImageIOBase
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(VTKImageIO);

  using Self = VTKImageIO;
  using Superclass = StreamingImageIOBase;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(VTKImageIO);
 
  // see super class for documentation
  //
  // overridden to return true only when supported
  bool
  CanStreamWrite() override;
 
  // see super class for documentation
  //
  // overridden to return true only when supported
  bool
  CanStreamRead() override;
 
 
  /*-------- This part of the interface deals with reading data. ------ */

  bool
  CanReadFile(const char *) override;

  void
  ReadImageInformation() override;

  void
  Read(void * buffer) override;
 
  /*-------- This part of the interfaces deals with writing data. ----- */

  bool
  CanWriteFile(const char *) override;

  void
  WriteImageInformation() override
  {}

  void
  Write(const void * buffer) override;

  SizeType
  GetHeaderSize() const override
  {
    return this->m_HeaderSize;
  }
 
protected:
  VTKImageIO();
  ~VTKImageIO() override;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  InternalReadImageInformation(std::ifstream & file);
 
  // Internal function to get next line from a given file (*.vtk)
  int
  GetNextLine(std::ifstream & ifs, std::string & line, bool lowerCase = true, SizeValueType count = 0);
 
  void
  WriteImageInformation(const void * buffer);
 
  void
  ReadHeaderSize(std::ifstream & file);

  void
  ReadBufferAsASCII(std::istream & is, void * buffer, IOComponentEnum ctype, SizeType numComp) override;

  void
  WriteBufferAsASCII(std::ostream & os, const void * buffer, IOComponentEnum ctype, SizeType numComp) override;

  virtual void
  ReadSymmetricTensorBufferAsBinary(std::istream & is, void * buffer, StreamingImageIOBase::SizeType num);

  virtual void
  WriteSymmetricTensorBufferAsBinary(std::ostream & os, const void * buffer, StreamingImageIOBase::SizeType num);
 
private:
  void
              SetPixelTypeFromString(const std::string & pixelType);
  std::string GetComponentTypeAsString(IOComponentEnum);

  SizeType
  GetIORegionSizeInPixels() const;

  SizeType
  GetIORegionSizeInBytes() const;

  SizeType
  GetIORegionSizeInComponents() const;
 
  SizeType m_HeaderSize{};
};
} // end namespace itk
 
#endif // itkVTKImageIO_h