imaging/vtkImageWriter.h Source File

00001 /*=========================================================================
00002 
00003   Program:   Visualization Toolkit
00004   Module:    $RCSfile: vtkImageWriter.h,v $
00005   Language:  C++
00006 
00007 
00008 Copyright (c) 1993-2001 Ken Martin, Will Schroeder, Bill Lorensen 
00009 All rights reserved.
00010 
00011 Redistribution and use in source and binary forms, with or without
00012 modification, are permitted provided that the following conditions are met:
00013 
00014  * Redistributions of source code must retain the above copyright notice,
00015    this list of conditions and the following disclaimer.
00016 
00017  * Redistributions in binary form must reproduce the above copyright notice,
00018    this list of conditions and the following disclaimer in the documentation
00019    and/or other materials provided with the distribution.
00020 
00021  * Neither name of Ken Martin, Will Schroeder, or Bill Lorensen nor the names
00022    of any contributors may be used to endorse or promote products derived
00023    from this software without specific prior written permission.
00024 
00025  * Modified source versions must be plainly marked as such, and must not be
00026    misrepresented as being the original software.
00027 
00028 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
00029 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00030 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00031 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
00032 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00033 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00034 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00035 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00036 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00037 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00038 
00039 =========================================================================*/
00058 #ifndef __vtkImageWriter_h
00059 #define __vtkImageWriter_h
00060 
00061 #include "vtkProcessObject.h"
00062 #include "vtkImageData.h"
00063 
00064 class VTK_EXPORT vtkImageWriter : public vtkProcessObject
00065 {
00066 public:
00067   static vtkImageWriter *New();
00068   vtkTypeMacro(vtkImageWriter,vtkProcessObject);
00069   void PrintSelf(ostream& os, vtkIndent indent);
00070   
00074   void SetFileName(const char *);
00075   vtkGetStringMacro(FileName);
00076 
00080   void SetFilePrefix(char *filePrefix);
00081   vtkGetStringMacro(FilePrefix);
00082 
00084   void SetFilePattern(const char *filePattern);
00085   vtkGetStringMacro(FilePattern);
00086 
00090   vtkSetMacro(FileDimensionality, int);
00091   vtkGetMacro(FileDimensionality, int);
00092   
00094   virtual void SetInput(vtkImageData *input);
00095   vtkImageData *GetInput();
00096 
00098   virtual void Write();
00099 
00102   vtkSetMacro(MemoryLimit, unsigned long);
00103   vtkGetMacro(MemoryLimit, unsigned long);
00104 
00105 protected:
00106   vtkImageWriter();
00107   ~vtkImageWriter();
00108   vtkImageWriter(const vtkImageWriter&) {};
00109   void operator=(const vtkImageWriter&) {};
00110 
00111   int FileDimensionality;
00112   char *FilePrefix;
00113   char *FilePattern;
00114   char *FileName;
00115   int FileNumber;
00116   int FileLowerLeft;
00117   char *InternalFileName;
00118 
00119   unsigned long MemoryLimit;
00120   
00121   void RecursiveWrite(int dim, vtkImageData *region, ofstream *file);
00122   void RecursiveWrite(int dim, vtkImageData *cache, 
00123             vtkImageData *data, ofstream *file);
00124   virtual void WriteFile(ofstream *file, vtkImageData *data, int extent[6]);
00125   virtual void WriteFileHeader(ofstream *, vtkImageData *) {};
00126   virtual void WriteFileTrailer(ofstream *, vtkImageData *) {};
00127 };
00128 
00129 #endif
00130 
00131