itkIPLCommonImageIO.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef __itkIPLCommonImageIO_h
#define __itkIPLCommonImageIO_h

#include "itkImageIOBase.h"
#include "itkIPLFileNameList.h"
#include "itkGEImageHeader.h"

namespace itk
{
class ITK_EXPORT IPLCommonImageIO:public ImageIOBase
{
public:
  typedef IPLCommonImageIO     Self;
  typedef ImageIOBase          Superclass;
  typedef SmartPointer< Self > Pointer;

  typedef unsigned char  U8;
  typedef signed char    S8;
  typedef unsigned short U16;
  typedef signed short   S16;
  typedef unsigned int   U32;
  typedef signed int     S32;
  typedef uint64_t       U64;
  typedef int64_t        S64;
  typedef float          F32;
  typedef double         F64;

  itkNewMacro(Self);

  itkTypeMacro(IPLCommonImageIO, Superclass);

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

  virtual bool CanReadFile(const char *FileNameToRead);

  virtual void ReadImageInformation();

  virtual void ModifyImageInformation() {}

  virtual void Read(void *buffer);

  virtual unsigned int GetComponentSize() const;

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

  virtual bool CanWriteFile(const char *FileNameToWrite);

  virtual void WriteImageInformation();

  virtual void Write(const void *buffer);

  virtual void SortImageListByNameAscend();

  virtual void SortImageListByNameDescend();

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

  int AddElementToList(char const *const filename,
                       const float sliceLocation,
                       const int offset,
                       const int XDim,
                       const int YDim,
                       const float XRes,
                       const float YRes,
                       const int Key1,
                       const int Key2);

  void sortImageListAscend();

  void sortImageListDescend();

  int statTimeToAscii(void *clock, char *timeString, int len);

  virtual GEImageHeader * ReadHeader(const char *FileNameToRead);

  //
  // data members
  GEImageHeader         *m_ImageHeader;
  ImageIOBase::ByteOrder m_SystemByteOrder;
  IPLFileNameList       *m_FilenameList;
  //
  // return 0 on success, -1 on failure
  int GetStringAt(std::ifstream & f, std::streamoff Offset, char *buf,
                  size_t amount, bool throw_exception = true);

  int GetIntAt(std::ifstream & f, std::streamoff Offset, int *ip,
               bool throw_exception = true);

  int GetShortAt(std::ifstream & f, std::streamoff Offset, short *ip,
                 bool throw_exception = true);

  int GetFloatAt(std::ifstream & f, std::streamoff Offset, float *ip,
                 bool throw_exception = true);

  int GetDoubleAt(std::ifstream & f, std::streamoff Offset, double *ip,
                  bool throw_exception = true);

  short hdr2Short(char *hdr);

  int hdr2Int(char *hdr);

  float hdr2Float(char *hdr);

  double hdr2Double(char *hdr);

private:
  IPLCommonImageIO(const Self &); //purposely not implemented
  void operator=(const Self &);   //purposely not implemented
};
} // end namespace itk
#define RAISE_EXCEPTION()                                    \
            { ExceptionObject exception(__FILE__, __LINE__); \
            exception.SetDescription("File cannot be read"); \
            throw exception; }

#define IOCHECK()      \
  if ( f.fail() )      \
    {                  \
    if ( f.is_open() ) \
      {                \
      f.close();       \
      }                \
    RAISE_EXCEPTION(); \
    }

#endif // __itkAnalyzeImageIO_h