itkIPLCommonImageIO.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 "ITKIOIPLExport.h"
 
#include "itkImageIOBase.h"
#include "itkIPLFileNameList.h"
#include "itkGEImageHeader.h"
 
namespace itk
{
class ITKIOIPL_EXPORT IPLCommonImageIO : public ImageIOBase
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(IPLCommonImageIO);

  using Self = IPLCommonImageIO;
  using Superclass = ImageIOBase;
  using Pointer = SmartPointer<Self>;
 
  using U8 = unsigned char;
  using S8 = signed char;
  using U16 = unsigned short;
  using S16 = short;
  using U32 = unsigned int;
  using S32 = int;
  using U64 = uint64_t;
  using S64 = int64_t;
  using F32 = float;
  using F64 = double;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(IPLCommonImageIO);
 
  /*-------- This part of the interfaces deals with reading data. ----- */

  bool
  CanReadFile(const char * FileNameToRead) override;

  void
  ReadImageInformation() override;

  virtual void
  ModifyImageInformation()
  {}

  void
  Read(void * buffer) override;

  unsigned int
  GetComponentSize() const override;
 
  /*-------- This part of the interfaces deals with writing data. ----- */

  bool
  CanWriteFile(const char * FileNameToWrite) override;

  void
  WriteImageInformation() override;

  void
  Write(const void * buffer) override;

  virtual void
  SortImageListByNameAscend();

  virtual void
  SortImageListByNameDescend();
 
protected:
  IPLCommonImageIO();
  ~IPLCommonImageIO() override;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  int
  AddElementToList(const char * 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{};
  IOByteOrderEnum   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);
};
} // end namespace itk
#define RAISE_EXCEPTION()                            \
  {                                                  \
    ExceptionObject exception(__FILE__, __LINE__);   \
    exception.SetDescription("File cannot be read"); \
    throw exception;                                 \
  }                                                  \
  ITK_MACROEND_NOOP_STATEMENT
 
#define IOCHECK()      \
  if (f.fail())        \
  {                    \
    if (f.is_open())   \
    {                  \
      f.close();       \
    }                  \
    RAISE_EXCEPTION(); \
  }                    \
  ITK_MACROEND_NOOP_STATEMENT
 
#endif // itkIPLCommonImageIO_h