LegacyIO/mitkRawImageFileReader.h

Go to the documentation of this file.

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

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

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

#ifndef RawImageFileReader_H_HEADER_INCLUDED
#define RawImageFileReader_H_HEADER_INCLUDED
#include "itkVector.h"
#include "mitkFileReader.h"
#include "mitkImageSource.h"
#include <MitkLegacyIOExports.h>

namespace mitk
{
  //##Documentation
  //## @brief Reader to read raw image files
  //## @ingroup MitkLegacyIOModule
  //## @deprecatedSince{2014_10} Use mitk::IOUtils or mitk::FileReaderRegistry instead.
  class DEPRECATED() MITKLEGACYIO_EXPORT RawImageFileReader : public ImageSource, public FileReader
  {
  public:
    mitkClassMacro(RawImageFileReader, FileReader);

    itkFactorylessNewMacro(Self);
    itkCloneMacro(Self);
    itkSetMacro(FileName, std::string);
    itkSetStringMacro(FileName);
    itkGetMacro(FileName, std::string);
    itkGetStringMacro(FileName);

    itkSetMacro(FilePrefix, std::string);
    itkSetStringMacro(FilePrefix);
    itkGetMacro(FilePrefix, std::string);
    itkGetStringMacro(FilePrefix);

    itkSetMacro(FilePattern, std::string);
    itkSetStringMacro(FilePattern);
    itkGetMacro(FilePattern, std::string);
    itkGetStringMacro(FilePattern);

    typedef enum { UCHAR, SCHAR, USHORT, SSHORT, UINT, SINT, FLOAT, DOUBLE } IOPixelType;
    itkSetMacro(PixelType, IOPixelType);

    typedef enum { LITTLE, BIG } EndianityType;
    itkSetMacro(Endianity, EndianityType);

    itkSetMacro(Dimensionality, int);
    itkGetMacro(Dimensionality, int);

    void SetDimensions(unsigned int i, unsigned int dim);

    unsigned int GetDimensions(unsigned int i) const;

    static bool CanReadFile(const std::string filename, const std::string filePrefix, const std::string filePattern);

  protected:
    RawImageFileReader();

    ~RawImageFileReader() override;

    void GenerateData() override;

    template <typename TPixel, unsigned int VImageDimensions>
    void TypedGenerateData();

    std::string m_FileName;

    std::string m_FilePrefix;

    std::string m_FilePattern;

    IOPixelType m_PixelType;

    int m_Dimensionality;

    EndianityType m_Endianity;

    itk::Vector<int, 3> m_Dimensions;
  };

} // namespace mitk

#endif /* RawImageFileReader_H_HEADER_INCLUDED */