VTK  9.2.5
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=========================================================================*/
29#ifndef vtkImageWriter_h
30#define vtkImageWriter_h
31
32#include "vtkIOImageModule.h" // For export macro
33#include "vtkImageAlgorithm.h"
34
35class VTKIOIMAGE_EXPORT vtkImageWriter : public vtkImageAlgorithm
36{
37public:
40 void PrintSelf(ostream& os, vtkIndent indent) override;
41
43
51
53
61
63
66 vtkSetFilePathMacro(FilePattern);
67 vtkGetFilePathMacro(FilePattern);
69
71
76 vtkSetMacro(FileDimensionality, int);
77 vtkGetMacro(FileDimensionality, int);
79
84
88 virtual void Write();
89
91
92protected:
94 ~vtkImageWriter() override;
95
99 char* FileName;
104
105 virtual void RecursiveWrite(int dim, vtkImageData* region, vtkInformation* inInfo, ostream* file);
106 virtual void RecursiveWrite(
107 int dim, vtkImageData* cache, vtkImageData* data, vtkInformation* inInfo, ostream* file);
108 virtual void WriteFile(ostream* file, vtkImageData* data, int extent[6], int wExtent[6]);
109 virtual void WriteFileHeader(ostream*, vtkImageData*, int[6]) {}
110 virtual void WriteFileTrailer(ostream*, vtkImageData*) {}
111
112 // Required for subclasses that need to prevent the writer
113 // from touching the file system. The getter/setter are only
114 // available in these subclasses.
116
117 // subclasses that do write to memory can override this
118 // to implement the simple case
119 virtual void MemoryWrite(int, vtkImageData*, int[6], vtkInformation*) {}
120
121 // This is called by the superclass.
122 // This is the method you should override.
124 vtkInformationVector* outputVector) override;
125
129
130private:
131 vtkImageWriter(const vtkImageWriter&) = delete;
132 void operator=(const vtkImageWriter&) = delete;
133};
134
135#endif
Generic algorithm superclass for image algs.
topologically and geometrically regular array of data
Definition: vtkImageData.h:54
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.
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.
vtkImageData * GetInput()
Set/Get the input object from the image pipeline.
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 *)
static vtkImageWriter * New()
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:40
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
unsigned int vtkTypeUBool
Definition: vtkABI.h:70