itkRawImageIO.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 itkRawImageIO_h
#define itkRawImageIO_h
 
#include "itkImageIOBase.h"
#include "itkImageRegion.h"
#include "itkPixelTraits.h"
#include "itkByteSwapper.h"
#include "itkVersion.h"
#include <string>
#include <fstream>
 
namespace itk
{
 
template <typename TPixel, unsigned int VImageDimension = 2>
class ITK_TEMPLATE_EXPORT RawImageIO : public ImageIOBase
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(RawImageIO);

  using Self = RawImageIO;
  using Superclass = ImageIOBase;
  using Pointer = SmartPointer<Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(RawImageIO);

  using PixelType = TPixel;

  using SizeValueType = Superclass::SizeValueType;

  using ComponentType = typename PixelTraits<PixelType>::ValueType;

  using ByteSwapperType = ByteSwapper<ComponentType>;

  void
  SetHeaderSize(SizeValueType size);
 
  SizeValueType
  GetHeaderSize();

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

  bool
  SupportsDimension(unsigned long dim) override
  {
    return (dim == m_FileDimensionality);
  }
 
  /*-------- This part of the interface deals with reading data. ------ */

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

  void
  ReadImageInformation() override
  {
    return;
  }

  void
  Read(void * buffer) override;

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


  virtual void
  ReadHeader(const std::string = std::string())
  {}
 
  /*-------- This part of the interfaces deals with writing data. ----- */

  bool
  CanWriteFile(const char *) override;

  void
  WriteImageInformation() override
  {
    return;
  }

  void
  Write(const void * buffer) override;
 
protected:
  RawImageIO();
  ~RawImageIO() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  // void ComputeInternalFileName(unsigned long slice);
 
private:
  std::string m_InternalFileName{};
 
  unsigned long  m_FileDimensionality{};
  bool           m_ManualHeaderSize{};
  SizeValueType  m_HeaderSize{};
  unsigned short m_ImageMask{};
};
 
template <typename TPixel, unsigned int VImageDimension>
class ITK_TEMPLATE_EXPORT RawImageIOFactory : public ObjectFactoryBase
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(RawImageIOFactory);

  using Self = RawImageIOFactory<TPixel, VImageDimension>;
  using Superclass = ObjectFactoryBase;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

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

  itkFactorylessNewMacro(Self);

  itkOverrideGetNameOfClassMacro(RawImageIOFactory);

  static void
  RegisterOneFactory()
  {
    ObjectFactoryBase::RegisterFactory(Self::New());
  }
 
protected:
  RawImageIOFactory() = default;
  ~RawImageIOFactory() override = default;
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkRawImageIO.hxx"
#endif
 
#endif