itkImageIOBase.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkImageIOBase.h,v $
  Language:  C++
  Date:      $Date: 2009-02-22 05:53:41 $
  Version:   $Revision: 1.51 $

  Copyright (c) Insight Software 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 __itkImageIOBase_h
#define __itkImageIOBase_h

#include "itkLightProcessObject.h"
#include "itkObjectFactory.h"
#include "itkIndent.h"
#include "itkImageIORegion.h"
#include "vnl/vnl_vector.h"

#include <string>

namespace itk
{

class ITK_EXPORT ImageIOBase : public LightProcessObject
{
public:
  typedef ImageIOBase        Self;
  typedef LightProcessObject Superclass;
  typedef SmartPointer<Self> Pointer;

  itkTypeMacro(ImageIOBase, Superclass);

  itkSetStringMacro(FileName);
  itkGetStringMacro(FileName);

  class UnknownType {};

  typedef  enum {UNKNOWNPIXELTYPE,SCALAR,RGB,RGBA,OFFSET,VECTOR,
                 POINT,COVARIANTVECTOR,SYMMETRICSECONDRANKTENSOR,
                 DIFFUSIONTENSOR3D,COMPLEX,FIXEDARRAY,MATRIX}  IOPixelType;

  typedef  enum {UNKNOWNCOMPONENTTYPE,UCHAR,CHAR,USHORT,SHORT,UINT,INT,
                 ULONG,LONG, FLOAT,DOUBLE} IOComponentType;

  void SetNumberOfDimensions(unsigned int);
  itkGetConstMacro(NumberOfDimensions, unsigned int);

  virtual void SetDimensions(unsigned int i, unsigned int dim);
  virtual unsigned int GetDimensions(unsigned int i) const
  { return m_Dimensions[i]; }

  virtual void SetOrigin(unsigned int i, double origin);
  virtual double GetOrigin(unsigned int i) const
    {
    return m_Origin[i];
    }

  virtual void SetSpacing(unsigned int i, double spacing);
  virtual double GetSpacing(unsigned int i) const
    {
    return m_Spacing[i];
    }

  virtual void SetDirection(unsigned int i, std::vector<double> &direction);
  virtual void SetDirection(unsigned int i, vnl_vector<double> &direction);
  virtual std::vector<double> GetDirection(unsigned int i) const
    {
    return m_Direction[i];
    }

  virtual std::vector<double> GetDefaultDirection(unsigned int i) const;

  itkSetMacro(IORegion, ImageIORegion);
  itkGetConstReferenceMacro(IORegion, ImageIORegion);

  itkSetEnumMacro(PixelType, IOPixelType);
  itkGetEnumMacro(PixelType, IOPixelType);

  virtual bool SetPixelTypeInfo(const std::type_info& ptype);

  itkSetEnumMacro(ComponentType,IOComponentType);
  itkGetEnumMacro(ComponentType,IOComponentType);
  virtual const std::type_info& GetComponentTypeInfo() const;

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

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

  itkSetMacro(UseStreamedReading,bool);
  itkGetMacro(UseStreamedReading,bool);
  itkBooleanMacro(UseStreamedReading);

  itkSetMacro(UseStreamedWriting,bool);
  itkGetMacro(UseStreamedWriting,bool);
  itkBooleanMacro(UseStreamedWriting);


  std::string GetComponentTypeAsString(IOComponentType) const;

  std::string GetPixelTypeAsString(IOPixelType) const;

  typedef  enum {ASCII,Binary,TypeNotApplicable} FileType;

  typedef  enum {BigEndian,LittleEndian,OrderNotApplicable} ByteOrder;

  itkSetEnumMacro(FileType,FileType);
  itkGetEnumMacro(FileType,FileType);
  void SetFileTypeToASCII()
    {
    this->SetFileType(ASCII);
    }
  void SetFileTypeToBinary()
    {
    this->SetFileType(Binary);
    }

  itkSetEnumMacro(ByteOrder,ByteOrder);
  itkGetEnumMacro(ByteOrder,ByteOrder);
  void SetByteOrderToBigEndian()
    {
    this->SetByteOrder(BigEndian);
    }
  void SetByteOrderToLittleEndian()
    {
    this->SetByteOrder(LittleEndian);
    }

  std::string GetFileTypeAsString(FileType) const;

  std::string GetByteOrderAsString(ByteOrder) const;

  typedef std::streamoff SizeType;

  virtual SizeType GetPixelStride () const;

  SizeType GetImageSizeInPixels() const;

  SizeType GetImageSizeInBytes() const;

  SizeType GetImageSizeInComponents() const;

  /*-------- This part of the interfaces deals with reading data ----- */

  virtual bool CanReadFile(const char*) = 0;

  virtual bool CanStreamRead()
    {
    return false;
    }

  virtual void ReadImageInformation() = 0;

  virtual void Read(void* buffer) = 0;


  /*-------- This part of the interfaces deals with writing data ----- */

  virtual bool CanWriteFile(const char*)  = 0;

  virtual bool CanStreamWrite()
    {
    return false;
    }

  virtual void WriteImageInformation() = 0;

  virtual void Write( const void* buffer) = 0;

  /* --- Support reading and writing data as a series of files. --- */

  virtual bool SupportsDimension(unsigned long dim)
    {
    return (dim == 2);
    }

  virtual ImageIORegion 
  GenerateStreamableReadRegionFromRequestedRegion( const ImageIORegion & requested ) const;

  
  
  virtual unsigned int GetActualNumberOfSplitsForWriting(unsigned int numberOfRequestedSplits,
                                                         const ImageIORegion &pasteRegion,
                                                         const ImageIORegion &largestPossibleRegion);

  virtual ImageIORegion GetSplitRegionForWriting(unsigned int ithPiece, 
                                                 unsigned int numberOfActualSplits,
                                                 const ImageIORegion &pasteRegion,
                                                 const ImageIORegion &largestPossibleRegion);

  typedef  std::vector< std::string >    ArrayOfExtensionsType;

  const ArrayOfExtensionsType & GetSupportedReadExtensions() const;

  const ArrayOfExtensionsType & GetSupportedWriteExtensions() const;


protected:
  ImageIOBase();
  ~ImageIOBase();
  void PrintSelf(std::ostream& os, Indent indent) const;

  IOPixelType m_PixelType;

  IOComponentType m_ComponentType;

  ByteOrder      m_ByteOrder;
  FileType       m_FileType;

  bool m_Initialized;

  std::string m_FileName;

  unsigned int m_NumberOfComponents;

  unsigned int m_NumberOfDimensions;

  bool m_UseCompression;

  bool m_UseStreamedReading;

  bool m_UseStreamedWriting;

  ImageIORegion m_IORegion;

  std::vector<unsigned int> m_Dimensions;

  std::vector<double> m_Spacing;

  std::vector<double> m_Origin;

  std::vector<std::vector<double> > m_Direction;

  std::vector< SizeType > m_Strides;

  virtual void Reset(const bool freeDynamic = true);

  void Resize(const unsigned int numDimensions, 
              const unsigned int* dimensions);

  void ComputeStrides();

  virtual unsigned int GetPixelSize() const;

  virtual unsigned int GetComponentSize() const;

  SizeType GetComponentStride() const;

  SizeType GetRowStride () const;

  SizeType GetSliceStride () const;

  void WriteBufferAsASCII(std::ostream& os, const void *buffer,
                          IOComponentType ctype,
                          SizeType numberOfBytesToWrite);

  void ReadBufferAsASCII(std::istream& os, void *buffer,
                         IOComponentType ctype,
                         SizeType numberOfBytesToBeRead);

  bool ReadBufferAsBinary(std::istream& os, void *buffer, SizeType numberOfBytesToBeRead);

  
  void AddSupportedReadExtension( const char * extension );

  void AddSupportedWriteExtension( const char * extension );

  virtual unsigned int GetActualNumberOfSplitsForWritingCanStreamWrite(unsigned int numberOfRequestedSplits,
                                                                       const ImageIORegion &pasteRegion) const;

  virtual ImageIORegion GetSplitRegionForWritingCanStreamWrite(unsigned int ithPiece, 
                                                               unsigned int numberOfActualSplits,
                                                               const ImageIORegion &pasteRegion) const;

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

  ArrayOfExtensionsType    m_SupportedReadExtensions;
  ArrayOfExtensionsType    m_SupportedWriteExtensions;

};

} // end namespace itk

#endif // __itkImageIOBase_h