vtkImageWriter.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkImageWriter_h
#define vtkImageWriter_h
 
#include "vtkIOImageModule.h" // For export macro
#include "vtkImageAlgorithm.h"
 
VTK_ABI_NAMESPACE_BEGIN
class VTKIOIMAGE_EXPORT vtkImageWriter : public vtkImageAlgorithm
{
public:
  static vtkImageWriter* New();
  vtkTypeMacro(vtkImageWriter, vtkImageAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetFilePathMacro(FileName);
  vtkGetFilePathMacro(FileName);


  vtkSetFilePathMacro(FilePrefix);
  vtkGetFilePathMacro(FilePrefix);


  virtual void SetFilePattern(VTK_FILEPATH const char*);
  vtkGetFilePathMacro(FilePattern);


  vtkSetMacro(FileDimensionality, int);
  vtkGetMacro(FileDimensionality, int);

  vtkImageData* GetInput();

  VTK_UNBLOCKTHREADS
  virtual void Write();
 
  void DeleteFiles();
 
protected:
  vtkImageWriter();
  ~vtkImageWriter() override;
 
  int FileDimensionality;
  char* FilePrefix;
  char* FilePattern;
  char* FileName;
  int FileNumber;
  int FileLowerLeft;
  char* InternalFileName;
  size_t InternalFileNameSize;
 
  virtual void RecursiveWrite(int dim, vtkImageData* region, vtkInformation* inInfo, ostream* file);
  virtual void RecursiveWrite(
    int dim, vtkImageData* cache, vtkImageData* data, vtkInformation* inInfo, ostream* file);
  virtual void WriteFile(ostream* file, vtkImageData* data, VTK_FUTURE_CONST int extent[6],
    VTK_FUTURE_CONST int wExtent[6]);
  virtual void WriteFileHeader(ostream*, vtkImageData*, VTK_FUTURE_CONST int[6]) {}
  virtual void WriteFileTrailer(ostream*, vtkImageData*) {}
 
  // Required for subclasses that need to prevent the writer
  // from touching the file system. The getter/setter are only
  // available in these subclasses.
  vtkTypeUBool WriteToMemory;
 
  // subclasses that do write to memory can override this
  // to implement the simple case
  virtual void MemoryWrite(int, vtkImageData*, VTK_FUTURE_CONST int[6], vtkInformation*) {}
 
  // This is called by the superclass.
  // This is the method you should override.
  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
 
  int MinimumFileNumber;
  int MaximumFileNumber;
  int FilesDeleted;
 
private:
  vtkImageWriter(const vtkImageWriter&) = delete;
  void operator=(const vtkImageWriter&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif