You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

133 lines
3.9 KiB
C++

/*=========================================================================
Program: Visualization Toolkit
Module: vtkImageWriter.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkImageWriter
* @brief Writes images to files.
*
* vtkImageWriter writes images to files with any data type. The data type of
* the file is the same scalar type as the input. The dimensionality
* determines whether the data will be written in one or multiple files.
* This class is used as the superclass of most image writing classes
* such as vtkBMPWriter etc. It supports streaming.
*/
#ifndef vtkImageWriter_h
#define vtkImageWriter_h
#include "vtkIOImageModule.h" // For export macro
#include "vtkImageAlgorithm.h"
class VTKIOIMAGE_EXPORT vtkImageWriter : public vtkImageAlgorithm
{
public:
static vtkImageWriter* New();
vtkTypeMacro(vtkImageWriter, vtkImageAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent) override;
//@{
/**
* Specify file name for the image file. You should specify either
* a FileName or a FilePrefix. Use FilePrefix if the data is stored
* in multiple files.
*/
vtkSetStringMacro(FileName);
vtkGetStringMacro(FileName);
//@}
//@{
/**
* Specify file prefix for the image file(s).You should specify either
* a FileName or FilePrefix. Use FilePrefix if the data is stored
* in multiple files.
*/
vtkSetStringMacro(FilePrefix);
vtkGetStringMacro(FilePrefix);
//@}
//@{
/**
* The snprintf format used to build filename from FilePrefix and number.
*/
vtkSetStringMacro(FilePattern);
vtkGetStringMacro(FilePattern);
//@}
//@{
/**
* What dimension are the files to be written. Usually this is 2, or 3.
* If it is 2 and the input is a volume then the volume will be
* written as a series of 2d slices.
*/
vtkSetMacro(FileDimensionality, int);
vtkGetMacro(FileDimensionality, int);
//@}
/**
* Set/Get the input object from the image pipeline.
*/
vtkImageData* GetInput();
/**
* The main interface which triggers the writer to start.
*/
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, int extent[6], int wExtent[6]);
virtual void WriteFileHeader(ostream*, vtkImageData*, 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*, 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;
};
#endif