itkMetaImageIO.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 itkMetaImageIO_h
#define itkMetaImageIO_h
#include "ITKIOMetaExport.h"
 
 
#include <fstream>
#include "itkImageIOBase.h"
#include "itkSingletonMacro.h"
#include "itkMetaDataObject.h"
#include "metaObject.h"
#include "metaImage.h"
 
namespace itk
{
class ITKIOMeta_EXPORT MetaImageIO : public ImageIOBase
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(MetaImageIO);

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

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(MetaImageIO);

  bool
  SupportsDimension(unsigned long) override
  {
    return true;
  }
 
  /*-------- This part of the interfaces deals with reading data. ----- */

  bool
  CanReadFile(const char *) override;

  void
  ReadImageInformation() override;

  void
  Read(void * buffer) override;
 
  MetaImage *
  GetMetaImagePointer();
 
  /*-------- This part of the interfaces deals with writing data. ----- */

  bool
  CanWriteFile(const char *) override;

  void
  WriteImageInformation() override;

  void
  Write(const void * buffer) override;

  virtual void
  SetDataFileName(const char * filename);

  void
  SetDoublePrecision(unsigned int precision)
  {
    m_MetaImage.SetDoublePrecision(precision);
  }

  ImageIORegion
  GenerateStreamableReadRegionFromRequestedRegion(const ImageIORegion & requestedRegion) const override;
 
  unsigned int
  GetActualNumberOfSplitsForWriting(unsigned int          numberOfRequestedSplits,
                                    const ImageIORegion & pasteRegion,
                                    const ImageIORegion & largestPossibleRegion) override;
 
  ImageIORegion
  GetSplitRegionForWriting(unsigned int          ithPiece,
                           unsigned int          numberOfActualSplits,
                           const ImageIORegion & pasteRegion,
                           const ImageIORegion & largestPossibleRegion) override;

  bool
  CanStreamRead() override
  {
    if (m_MetaImage.CompressedData())
    {
      return false;
    }
    return true;
  }


  bool
  CanStreamWrite() override
  {
    if (this->GetUseCompression())
    {
      return false;
    }
    return true;
  }


  itkSetMacro(SubSamplingFactor, unsigned int);
  itkGetConstMacro(SubSamplingFactor, unsigned int);

  static void
  SetDefaultDoublePrecision(unsigned int precision);
  static unsigned int
  GetDefaultDoublePrecision();
 
protected:
  MetaImageIO();
  ~MetaImageIO() override;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
  template <unsigned int VNRows, unsigned int VNColumns = VNRows>
  bool
  WriteMatrixInMetaData(std::ostringstream &       strs,
                        const MetaDataDictionary & metaDict,
                        const std::string &        metaString) const;
 
private:
  itkGetGlobalDeclarationMacro(unsigned int, DefaultDoublePrecision);
 
  MetaImage m_MetaImage{};
 
  unsigned int m_SubSamplingFactor{};
 
  static unsigned int * m_DefaultDoublePrecision;
};
 
template <unsigned int VNRows, unsigned int VNColumns>
bool
MetaImageIO::WriteMatrixInMetaData(std::ostringstream &       strs,
                                   const MetaDataDictionary & metaDict,
                                   const std::string &        metaString) const
{
  itk::Matrix<double, VNRows, VNColumns> mval;
  if (ExposeMetaData<itk::Matrix<double, VNRows, VNColumns>>(metaDict, metaString, mval))
  {
    for (unsigned int i = 0; i < VNRows; ++i)
    {
      for (unsigned int j = 0; j < VNColumns; ++j)
      {
        strs << mval[i][j];
        if (i != VNRows - 1 || j != VNColumns - 1)
        {
          strs << ' ';
        }
      }
    }
    return true;
  }
  return false;
}
 
} // end namespace itk
 
#endif // itkMetaImageIO_h