sitkImageFileWriter.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
 *
 *         http://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 sitkImageFileWriter_h
#define sitkImageFileWriter_h
 
#include "sitkMacro.h"
#include "sitkPathType.h"
#include "sitkImage.h"
#include "sitkMemberFunctionFactory.h"
#include "sitkIO.h"
#include "sitkProcessObject.h"
 
#include <memory>
 
namespace itk
{
 
// Forward declaration for pointer
class ImageIOBase;
 
template <class T>
class SmartPointer;
 
namespace simple
{

class SITKIO_EXPORT ImageFileWriter : public ProcessObject
{
public:
  using Self = ImageFileWriter;
 
  // list of pixel types supported
  using PixelIDTypeList = NonLabelPixelIDTypeList;
 
  ~ImageFileWriter() override;
 
  ImageFileWriter();

  std::string
  ToString() const override;

  std::string
  GetName() const override
  {
    return std::string("ImageFileWriter");
  }

  virtual std::vector<std::string>
  GetRegisteredImageIOs() const;
 

  SITK_RETURN_SELF_TYPE_HEADER
  SetUseCompression(bool UseCompression);
  bool
  GetUseCompression() const;
 
  SITK_RETURN_SELF_TYPE_HEADER
  UseCompressionOn() { return this->SetUseCompression(true); }
  SITK_RETURN_SELF_TYPE_HEADER
  UseCompressionOff() { return this->SetUseCompression(false); }
 

  SITK_RETURN_SELF_TYPE_HEADER
  SetCompressionLevel(int);
  int
  GetCompressionLevel() const;

  SITK_RETURN_SELF_TYPE_HEADER
  SetCompressor(const std::string &);
  std::string
  GetCompressor();

  virtual SITK_RETURN_SELF_TYPE_HEADER
  SetImageIO(const std::string & imageio);
  virtual std::string
  GetImageIO() const;
  /* @} */
 

  SITK_RETURN_SELF_TYPE_HEADER
  SetKeepOriginalImageUID(bool KeepOriginalImageUID);
  bool
  GetKeepOriginalImageUID() const;
 
  SITK_RETURN_SELF_TYPE_HEADER
  KeepOriginalImageUIDOn() { return this->SetKeepOriginalImageUID(true); }
  SITK_RETURN_SELF_TYPE_HEADER
  KeepOriginalImageUIDOff() { return this->SetKeepOriginalImageUID(false); }
 
  SITK_RETURN_SELF_TYPE_HEADER
  SetFileName(const PathType & fileName);
  PathType
  GetFileName() const;
 
  SITK_RETURN_SELF_TYPE_HEADER
  Execute(const Image &);
  SITK_RETURN_SELF_TYPE_HEADER
  Execute(const Image &, const PathType & inFileName, bool useCompression, int compressionLevel);
 
private:
  itk::SmartPointer<ImageIOBase>
  GetImageIOBase(const PathType & fileName);
 
  template <class T>
  Self &
  ExecuteInternal(const Image &);
 
  bool        m_UseCompression;
  int         m_CompressionLevel;
  std::string m_Compressor;
 
  PathType    m_FileName;
  bool        m_KeepOriginalImageUID;
  std::string m_ImageIOName;
 
  // function pointer type
  typedef Self & (Self::*MemberFunctionType)(const Image &);
 
  // friend to get access to executeInternal member
  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
 
  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType>> m_MemberFactory;
};

SITKIO_EXPORT void
WriteImage(const Image & image, const PathType & fileName, bool useCompression = false, int compressionLevel = -1);
} // namespace simple
} // namespace itk
 
#endif