itkImageFileWriter.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkImageFileWriter.h,v $
  Language:  C++
  Date:      $Date: 2002/08/19 13:20:42 $
  Version:   $Revision: 1.7 $

  Copyright (c) 2002 Insight Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/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 notices for more information.

=========================================================================*/
#ifndef __itkImageFileWriter_h
#define __itkImageFileWriter_h

#include "itkProcessObject.h"
#include "itkImageIOBase.h"
#include "itkExceptionObject.h"
#include "itkSize.h"
#include "itkImageRegion.h"

namespace itk
{

class ImageFileWriterException : public ExceptionObject 
{
public:
  itkTypeMacro( ImageFileWriterException, ExceptionObject );

  ImageFileWriterException(char *file, unsigned int line, 
                           const char* message = "Error in IO") : 
    ExceptionObject(file, line)
    {
      SetDescription(message);
    }

  ImageFileWriterException(const std::string &file, unsigned int line, 
                           const char* message = "Error in IO") : 
    ExceptionObject(file, line)
    {
      SetDescription(message);
    }
};


template <class TInputImage>
class ITK_EXPORT ImageFileWriter : public ProcessObject
{
public:
  typedef ImageFileWriter              Self;
  typedef ProcessObject  Superclass;
  typedef SmartPointer<Self>  Pointer;
  typedef SmartPointer<const Self>  ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(ImageFileWriter,ProcessObject);

  typedef TInputImage InputImageType;
  typedef typename InputImageType::Pointer InputImagePointer;
  typedef typename InputImageType::RegionType InputImageRegionType; 
  typedef typename InputImageType::PixelType InputImagePixelType; 
  
  void SetInput(const InputImageType *input);
  const InputImageType * GetInput(void);
  const InputImageType * GetInput(unsigned int idx);
  
  itkSetStringMacro(FileName);
  itkGetStringMacro(FileName);
  
  itkSetStringMacro(FilePrefix);
  itkGetStringMacro(FilePrefix);
  
  itkSetStringMacro(FilePattern);
  itkGetStringMacro(FilePattern);
  
  itkSetObjectMacro(ImageIO,ImageIOBase);
  itkGetObjectMacro(ImageIO,ImageIOBase);
  
  virtual void Write();
  virtual void Write(const ImageIORegion& region);

  virtual void Update()
    {this->Write();}
  
protected:
  ImageFileWriter();
  ~ImageFileWriter();
  void PrintSelf(std::ostream& os, Indent indent) const;

  void GenerateOutputInformation(void);

  void GenerateData(void);
  
private:
  ImageFileWriter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  std::string        m_FileName;
  std::string        m_FilePrefix;
  std::string        m_FilePattern;
  
  ImageIOBase::Pointer m_ImageIO;
  bool m_UserSpecifiedImageIO; //track whether the ImageIO is user specified
  
  ImageIORegion *m_Region;
  bool m_UserSpecifiedRegion; //track whether the region is user specified
  
};

  
} // end namespace itk
  
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkImageFileWriter.txx"
#endif

#endif // __itkImageFileWriter_h
  

---