mitkImageWriter.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 _MITK_IMAGE_WRITER__H_
#define _MITK_IMAGE_WRITER__H_

#include <MitkLegacyIOExports.h>
#include <mitkFileWriterWithInformation.h>

namespace mitk
{
  class Image;
  class MITKLEGACYIO_EXPORT ImageWriter : public mitk::FileWriterWithInformation
  {
  public:
    mitkClassMacro(ImageWriter, mitk::FileWriter);

    itkFactorylessNewMacro(Self);

    itkCloneMacro(Self);

      mitkWriterMacro;

    void SetFileName(const char *fileName) override;
    virtual void SetFileName(const std::string &fileName);

    itkGetStringMacro(FileName);

    virtual void SetExtension(const char *extension);
    virtual void SetExtension(const std::string &extension);

    itkGetStringMacro(Extension);

    void SetDefaultExtension();

    itkSetStringMacro(FilePrefix);

    itkGetStringMacro(FilePrefix);

    itkSetStringMacro(FilePattern);

    itkGetStringMacro(FilePattern);

    void SetInput(mitk::Image *input);

    //##Documentation
    //## @brief Return the possible file extensions for the data type associated with the writer
    std::vector<std::string> GetPossibleFileExtensions() override;

    std::string GetSupportedBaseData() const override;

    std::string GetFileExtension() override;

    bool CanWriteDataType(DataNode *) override;

    std::string GetWritenMIMEType() override;

    using Superclass::SetInput;
    virtual void SetInput(DataNode *);

    const mitk::Image *GetInput();

    // FileWriterWithInformation methods
    const char *GetDefaultFilename() override;
    const char *GetFileDialogPattern() override;
    const char *GetDefaultExtension() override;
    bool CanWriteBaseDataType(BaseData::Pointer data) override;
    void DoWrite(BaseData::Pointer data) override;

    void SetUseCompression(bool useCompression);

  protected:
    ImageWriter();

    ~ImageWriter() override;

    void GenerateData() override;

    virtual void WriteByITK(mitk::Image *image, const std::string &fileName);

    std::string m_FileName;

    std::string m_FileNameWithoutExtension;

    std::string m_FilePrefix;

    std::string m_FilePattern;

    std::string m_Extension;

    std::string m_MimeType;

    bool m_UseCompression;
  };
}

#endif //_MITK_IMAGE_WRITER__H_