VTK  9.2.20220807
vtkImageWriter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkImageWriter.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
78 #ifndef vtkImageWriter_h
79 #define vtkImageWriter_h
80 
81 #include "vtkIOImageModule.h" // For export macro
82 #include "vtkImageAlgorithm.h"
83 
84 class VTKIOIMAGE_EXPORT vtkImageWriter : public vtkImageAlgorithm
85 {
86 public:
87  static vtkImageWriter* New();
89  void PrintSelf(ostream& os, vtkIndent indent) override;
90 
92 
100 
102 
107  vtkSetFilePathMacro(FilePrefix);
108  vtkGetFilePathMacro(FilePrefix);
110 
112 
115  vtkSetFilePathMacro(FilePattern);
116  vtkGetFilePathMacro(FilePattern);
118 
120 
125  vtkSetMacro(FileDimensionality, int);
126  vtkGetMacro(FileDimensionality, int);
128 
133 
137  virtual void Write();
138 
139  void DeleteFiles();
140 
141 protected:
143  ~vtkImageWriter() override;
144 
146  char* FilePrefix;
147  char* FilePattern;
148  char* FileName;
153 
154  virtual void RecursiveWrite(int dim, vtkImageData* region, vtkInformation* inInfo, ostream* file);
155  virtual void RecursiveWrite(
156  int dim, vtkImageData* cache, vtkImageData* data, vtkInformation* inInfo, ostream* file);
157  virtual void WriteFile(ostream* file, vtkImageData* data, int extent[6], int wExtent[6]);
158  virtual void WriteFileHeader(ostream*, vtkImageData*, int[6]) {}
159  virtual void WriteFileTrailer(ostream*, vtkImageData*) {}
160 
161  // Required for subclasses that need to prevent the writer
162  // from touching the file system. The getter/setter are only
163  // available in these subclasses.
165 
166  // subclasses that do write to memory can override this
167  // to implement the simple case
168  virtual void MemoryWrite(int, vtkImageData*, int[6], vtkInformation*) {}
169 
170  // This is called by the superclass.
171  // This is the method you should override.
172  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
173  vtkInformationVector* outputVector) override;
174 
178 
179 private:
180  vtkImageWriter(const vtkImageWriter&) = delete;
181  void operator=(const vtkImageWriter&) = delete;
182 };
183 
184 #endif
Generic algorithm superclass for image algs.
topologically and geometrically regular array of data
Definition: vtkImageData.h:163
Writes images to files.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
char * InternalFileName
vtkGetFilePathMacro(FilePrefix)
Specify file prefix for the image file(s).You should specify either a FileName or FilePrefix.
vtkGetFilePathMacro(FilePattern)
The snprintf format used to build filename from FilePrefix and number.
static vtkImageWriter * New()
size_t InternalFileNameSize
virtual void MemoryWrite(int, vtkImageData *, int[6], vtkInformation *)
virtual void RecursiveWrite(int dim, vtkImageData *region, vtkInformation *inInfo, ostream *file)
vtkGetFilePathMacro(FileName)
Specify file name for the image file.
virtual void WriteFileHeader(ostream *, vtkImageData *, int[6])
int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
This is called in response to a REQUEST_DATA request from the executive.
virtual void Write()
The main interface which triggers the writer to start.
vtkSetFilePathMacro(FilePrefix)
Specify file prefix for the image file(s).You should specify either a FileName or FilePrefix.
vtkTypeUBool WriteToMemory
void DeleteFiles()
vtkSetFilePathMacro(FilePattern)
The snprintf format used to build filename from FilePrefix and number.
~vtkImageWriter() override
virtual void RecursiveWrite(int dim, vtkImageData *cache, vtkImageData *data, vtkInformation *inInfo, ostream *file)
virtual void WriteFileTrailer(ostream *, vtkImageData *)
vtkImageData * GetInput()
Set/Get the input object from the image pipeline.
vtkSetFilePathMacro(FileName)
Specify file name for the image file.
virtual void WriteFile(ostream *file, vtkImageData *data, int extent[6], int wExtent[6])
a simple class to control print indentation
Definition: vtkIndent.h:119
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
@ extent
Definition: vtkX3D.h:351
@ data
Definition: vtkX3D.h:321
unsigned int vtkTypeUBool
Definition: vtkABI.h:70