itkCastImageFileWriter.h

Go to the documentation of this file.

/*=========================================================================
 
 Program:   Cast Image File Writer
 
 Copyright (c) Pew-Thian Yap. All rights reserved.
 See http://www.unc.edu/~ptyap/ 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 __itkCastImageFileWriter_h
#define __itkCastImageFileWriter_h

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

namespace itk
{

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

  itkNewMacro(Self);

  itkTypeMacro(CastImageFileWriter,ProcessObject);

  typedef TInputImage                            InputImageType;
  typedef typename InputImageType::Pointer       InputImagePointer;
  typedef typename InputImageType::RegionType    InputImageRegionType; 
  typedef typename InputImageType::PixelType     InputImagePixelType;
  
  typedef typename ImageIOBase::IOComponentType  IOComponentType;
  
  using Superclass::SetInput;
  virtual void SetInput(const InputImageType *input);
  const InputImageType * GetInput(void);
  const InputImageType * GetInput(unsigned int idx);
  
  itkSetStringMacro(FileName);
  itkGetStringMacro(FileName);
  
  void SetImageIO (ImageIOBase* io)
    {
    if (this->m_ImageIO != io)
      {
      this->Modified();
      this->m_ImageIO = io;
      }
    m_FactorySpecifiedImageIO = false;
    }
  itkGetObjectMacro(ImageIO,ImageIOBase);
  
  virtual void Write(void);

  void SetIORegion(const ImageIORegion & region);
  const ImageIORegion &GetIORegion(void) const 
    {
    return m_PasteIORegion;
    }


  itkSetMacro(NumberOfStreamDivisions,unsigned int);
  itkGetConstReferenceMacro(NumberOfStreamDivisions,unsigned int);


  virtual void Update() ITK_OVERRIDE
    {
    this->Write();
    }

  itkSetMacro(UseCompression,bool);
  itkGetConstReferenceMacro(UseCompression,bool);
  itkBooleanMacro(UseCompression);

  itkSetMacro(UseInputMetaDataDictionary,bool);
  itkGetConstReferenceMacro(UseInputMetaDataDictionary,bool);
  itkBooleanMacro(UseInputMetaDataDictionary);

  itkSetEnumMacro(ComponentType, IOComponentType);
  itkGetEnumMacro(ComponentType, IOComponentType);
  
protected:
  CastImageFileWriter();
  ~CastImageFileWriter();
  void PrintSelf(std::ostream& os, Indent indent) const ITK_OVERRIDE;

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

  std::string        m_FileName;
  
  ImageIOBase::Pointer m_ImageIO;
  bool                 m_UserSpecifiedImageIO; // track whether the ImageIO
                                                // is user specified
  
  ImageIORegion m_PasteIORegion;
  unsigned int  m_NumberOfStreamDivisions;
  bool          m_UserSpecifiedIORegion;    // track whether the region
                                            // is user specified
  bool          m_FactorySpecifiedImageIO;  //track whether the factory
                                            //  mechanism set the ImageIO
  bool m_UseCompression;
  bool m_UseInputMetaDataDictionary;        // whether to use the
                                            // MetaDataDictionary from the
                                            // input or not.
                                            
  IOComponentType m_ComponentType;
};

  
} // end namespace itk
  
#if !defined(ITK_MANUAL_INSTANTIATION) && !defined(__itkCastImageFileWriter_hxx)
#include "itkCastImageFileWriter.hxx"
#endif

#endif // __itkCastImageFileWriter_h