itkRawImageIO.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkRawImageIO.h,v $
  Language:  C++
  Date:      $Date: 2007-03-22 14:28:52 $
  Version:   $Revision: 1.33 $

  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 __itkRawImageIO_h
#define __itkRawImageIO_h

#include <fstream>
#include "itkImageIOBase.h"
#include "itkIndex.h"
#include "itkImageRegion.h"
#include "itkPixelTraits.h"
#include "itkByteSwapper.h"
#include "itkVersion.h"
#include <string>


namespace itk
{

template <class TPixel, unsigned int VImageDimension=2>
class ITK_EXPORT RawImageIO : public ImageIOBase
{
public:
  typedef RawImageIO         Self;
  typedef ImageIOBase        Superclass;
  typedef SmartPointer<Self> Pointer;

  itkNewMacro(Self);

  itkTypeMacro(RawImageIO, ImageIOBase);

  typedef TPixel PixelType;

  typedef typename PixelTraits<PixelType>::ValueType       ComponentType;

  typedef ByteSwapper<ComponentType>               ByteSwapperType;


  void SetHeaderSize(unsigned long size);
  unsigned long GetHeaderSize();

  itkSetMacro(FileDimensionality, unsigned long);
  itkGetMacro(FileDimensionality, unsigned long);

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

  /*-------- This part of the interface deals with reading data. ------ */

  virtual bool CanReadFile(const char*) {return false;}

  virtual void ReadImageInformation() {return;}

  virtual void Read(void* buffer);

  itkGetConstReferenceMacro(ImageMask,unsigned short);
  void SetImageMask(unsigned long val) 
    {
    if (val == m_ImageMask) { return; }
    m_ImageMask = ((unsigned short)(val)); 
    this->Modified();
    }

  virtual void ReadHeader (const std::string = std::string()) {}

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

  virtual bool CanWriteFile(const char*);

  virtual void WriteImageInformation(void) {return;}


  virtual void Write(const void* buffer);

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

  //void ComputeInternalFileName(unsigned long slice);
  void OpenFileForReading(std::ifstream& is);
  void OpenFileForWriting(std::ofstream& os);
  
private:
  RawImageIO(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  std::string   m_InternalFileName;

  unsigned long  m_FileDimensionality;
  bool           m_ManualHeaderSize;
  unsigned long  m_HeaderSize;
  unsigned short m_ImageMask;
};

template <class TPixel, unsigned int VImageDimension>
class ITK_EXPORT RawImageIOFactory : public ObjectFactoryBase
{
public:
  typedef RawImageIOFactory<TPixel,VImageDimension> Self;
  typedef ObjectFactoryBase                         Superclass;
  typedef SmartPointer<Self>                        Pointer;
  typedef SmartPointer<const Self>                  ConstPointer;

  const char* GetITKSourceVersion(void) const
    {
    return ITK_SOURCE_VERSION;
    }

  const char* GetDescription(void) const
    {
    return "Raw ImageIO Factory, allows the loading of Raw images into insight";
    }

  itkFactorylessNewMacro(Self);

  itkTypeMacro(RawImageIOFactory, ObjectFactoryBase);

  static void RegisterOneFactory(void)
    {
    ObjectFactoryBase::RegisterFactory( Self::New() );
    }

protected:
  RawImageIOFactory() {};
  ~RawImageIOFactory() {};
  typedef RawImageIO<TPixel,VImageDimension> myProductType;
  const myProductType* m_MyProduct;

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

};

} // namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkRawImageIO.txx"
#endif

#endif