itkNrrdImageIO.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 itkNrrdImageIO_h
#define itkNrrdImageIO_h
#include "ITKIONRRDExport.h"
 
 
#include "itkImageIOBase.h"
#include <fstream>
 
struct NrrdEncoding_t;
 
namespace itk
{
class NrrdImageIOEnums
{
public:
  enum class AxesReorder : uint8_t
  {
    UseAnyRangeAxisAsPixel = 0,
    UseNonListRangeAxisAsPixel = 1,
    UseScalarPixel = 2
  };
};
// Define how to print enumeration
extern ITKIONRRD_EXPORT std::ostream &
                        operator<<(std::ostream & out, const NrrdImageIOEnums::AxesReorder value);
 
using AxesReorderEnum = NrrdImageIOEnums::AxesReorder;

class ITKIONRRD_EXPORT NrrdImageIO : public ImageIOBase
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(NrrdImageIO);

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

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(NrrdImageIO);

  bool
  SupportsDimension(unsigned long) override;

  bool
  CanReadFile(const char *) override;

  void
  ReadImageInformation() override;

  void
  Read(void * buffer) override;

  bool
  CanWriteFile(const char *) override;

  void
  WriteImageInformation() override;

  void
  Write(const void * buffer) override;

  itkSetMacro(AxesReorder, AxesReorderEnum);
  itkGetConstMacro(AxesReorder, AxesReorderEnum);

  void
  SetAxesReorderToUseAnyRangeAxisAsPixel()
  {
    this->SetAxesReorder(AxesReorderEnum::UseAnyRangeAxisAsPixel);
  }

  void
  SetAxesReorderToUseNonListRangeAxisAsPixel()
  {
    this->SetAxesReorder(AxesReorderEnum::UseNonListRangeAxisAsPixel);
  }

  void
  SetAxesReorderToUseScalarPixel()
  {
    this->SetAxesReorder(AxesReorderEnum::UseScalarPixel);
  }
 
protected:
  NrrdImageIO();
  ~NrrdImageIO() override;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  InternalSetCompressor(const std::string & _compressor) override;

  int
  ITKToNrrdComponentType(const IOComponentEnum) const;
 
  IOComponentEnum
  NrrdToITKComponentType(const int) const;
 
  const NrrdEncoding_t * m_NrrdCompressionEncoding{ nullptr };
 
  AxesReorderEnum m_AxesReorder{ AxesReorderEnum::UseAnyRangeAxisAsPixel };
};
} // end namespace itk
 
#endif // itkNrrdImageIO_h