#include <mitkImageWriter.h>

Inheritance diagram for mitk::ImageWriter:

[legend]

Collaboration diagram for mitk::ImageWriter:

[legend]

Public Member Functions
	mitkClassMacro (ImageWriter, mitk::FileWriter)

Pointer	Clone () const

void	SetFileName (const char *fileName) override

virtual void	SetFileName (const std::string &fileName)

virtual const char *	GetFileName () const

virtual void	SetExtension (const char *extension)
	Explicitly set the extension to be added to the filename. More...

virtual void	SetExtension (const std::string &extension)

virtual const char *	GetExtension () const
	Get the extension to be added to the filename. More...

void	SetDefaultExtension ()
	Set the extension to be added to the filename to the default. More...

virtual void	SetFilePrefix (const char *_arg)

virtual const char *	GetFilePrefix () const

virtual void	SetFilePattern (const char *_arg)

virtual const char *	GetFilePattern () const

void	SetInput (mitk::Image *input)

std::vector< std::string >	GetPossibleFileExtensions () override
	Return the possible file extensions for the data type associated with the writer. More...

std::string	GetSupportedBaseData () const override

std::string	GetFileExtension () override
	Return the extension to be added to the filename. More...

bool	CanWriteDataType (DataNode *) override
	Check if the Writer can write the Content of the. More...

std::string	GetWritenMIMEType () override
	Return the MimeType of the saved File. More...

virtual void	SetInput (DataNode *)
	Set the DataTreenode as Input. Important: The Writer always have a SetInput-Function. More...

const mitk::Image *	GetInput ()

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)

Public Member Functions inherited from mitk::FileWriterWithInformation
virtual std::vector< std::string >	GetClassHierarchy () const override

virtual const char *	GetClassName () const

Public Member Functions inherited from mitk::FileWriter
bool	IsExtensionValid (std::string extension)
	Checks if given extension is valid for file writer. More...

virtual std::string	GetPossibleFileExtensionsAsString ()
	possible file extensions for the data type associated with the writer as string More...

void	SetInput (BaseData *data)

virtual void	Write ()=0

virtual bool	CanWriteToMemory ()
	Specifies, whether the file writer also can write a file to a memory buffer. More...

virtual void	SetWriteToMemory (bool write)
	Set/Get functions to advise the file writer to use tis internal memory array as file writing destination. More...

virtual bool	GetWriteToMemory ()

virtual const char *	GetMemoryPointer ()
	To be used along with a call of SetWriteToMemory(true). This returns the memory buffer where the file was written. More...

virtual unsigned int	GetMemorySize ()
	To be used along with a call of SetWriteToMemory(true). This returns the size of the memory buffer where the file was written. More...

virtual void	ReleaseMemory ()
	CAUTION: It's up to the user to call this function to release the memory buffer after use in case the file writer has written to its memory array. More...

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from mitk::FileWriterWithInformation
static const char *	GetStaticNameOfClass ()

Static Public Member Functions inherited from mitk::FileWriter
static const char *	GetStaticNameOfClass ()

Public Attributes
	mitkWriterMacro

Protected Member Functions
	ImageWriter ()

	~ImageWriter () override

void	GenerateData () override

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

Protected Member Functions inherited from mitk::FileWriter
	FileWriter ()

	~FileWriter () override

Protected Attributes
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

Protected Attributes inherited from mitk::FileWriter
bool	m_CanWriteToMemory

bool	m_WriteToMemory

char *	m_MemoryBuffer

unsigned int	m_MemoryBufferSize

Additional Inherited Members
Public Types inherited from mitk::FileWriterWithInformation
typedef FileWriterWithInformation	Self

typedef FileWriter	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

Public Types inherited from mitk::FileWriter
typedef FileWriter	Self

typedef itk::ProcessObject	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

Detailed Description

Writer for mitk::Image.

Uses the given extension (SetExtension) to decide the format to write (.mhd is default, .tif, .png, .jpg supported yet).

Deprecated:: (as of 2014_10) Use mitk::IOUtils or mitk::FileWriterRegistry instead.

Definition at line 30 of file mitkImageWriter.h.

Constructor & Destructor Documentation

◆ ImageWriter()

mitk::ImageWriter::ImageWriter ( )

protected

Constructor.

◆ ~ImageWriter()

mitk::ImageWriter::~ImageWriter ( )

overrideprotected

Virtual destructor.

Member Function Documentation

◆ CanWriteBaseDataType()

bool mitk::ImageWriter::CanWriteBaseDataType ( BaseData::Pointer data )

overridevirtual

Implements mitk::FileWriterWithInformation.

◆ CanWriteDataType()

bool mitk::ImageWriter::CanWriteDataType ( DataNode * )

overridevirtual

Check if the Writer can write the Content of the.

Reimplemented from mitk::FileWriter.

◆ Clone()

Pointer mitk::ImageWriter::Clone ( ) const

◆ DoWrite()

void mitk::ImageWriter::DoWrite ( BaseData::Pointer data )

overridevirtual

Implements mitk::FileWriterWithInformation.

◆ GenerateData()

void mitk::ImageWriter::GenerateData ( )

overrideprotected

◆ GetDefaultExtension()

const char* mitk::ImageWriter::GetDefaultExtension ( )

overridevirtual

Implements mitk::FileWriterWithInformation.

◆ GetDefaultFilename()

const char* mitk::ImageWriter::GetDefaultFilename ( )

overridevirtual

Implements mitk::FileWriterWithInformation.

◆ GetExtension()

virtual const char* mitk::ImageWriter::GetExtension ( ) const

virtual

Get the extension to be added to the filename.

Returns: the extension to be added to the filename (e.g., ".mhd").

◆ GetFileDialogPattern()

const char* mitk::ImageWriter::GetFileDialogPattern ( )

overridevirtual

Implements mitk::FileWriterWithInformation.

◆ GetFileExtension()

std::string mitk::ImageWriter::GetFileExtension ( )

overridevirtual

Return the extension to be added to the filename.

Reimplemented from mitk::FileWriter.

◆ GetFileName()

virtual const char* mitk::ImageWriter::GetFileName ( ) const

virtual

Returns: the name of the file to be written to disk.

Implements mitk::FileWriter.

◆ GetFilePattern()

virtual const char* mitk::ImageWriter::GetFilePattern ( ) const

virtual

Warning: multiple write not (yet) supported

Implements mitk::FileWriter.

◆ GetFilePrefix()

virtual const char* mitk::ImageWriter::GetFilePrefix ( ) const

virtual

Warning: multiple write not (yet) supported

Implements mitk::FileWriter.

◆ GetInput()

const mitk::Image* mitk::ImageWriter::GetInput ( )

Returns: the 0'th input object of the filter.

◆ GetPossibleFileExtensions()

std::vector<std::string> mitk::ImageWriter::GetPossibleFileExtensions ( )

overridevirtual

Return the possible file extensions for the data type associated with the writer.

Implements mitk::FileWriter.

◆ GetSupportedBaseData()

std::string mitk::ImageWriter::GetSupportedBaseData ( ) const

overridevirtual

Implements mitk::FileWriter.

◆ GetWritenMIMEType()

std::string mitk::ImageWriter::GetWritenMIMEType ( )

overridevirtual

Return the MimeType of the saved File.

Reimplemented from mitk::FileWriter.

◆ mitkClassMacro()

mitk::ImageWriter::mitkClassMacro	(	ImageWriter	,
		mitk::FileWriter
	)

◆ New()

static Pointer mitk::ImageWriter::New ( )

static

◆ SetDefaultExtension()

void mitk::ImageWriter::SetDefaultExtension ( )

Set the extension to be added to the filename to the default.

◆ SetExtension() [1/2]

virtual void mitk::ImageWriter::SetExtension ( const char * extension )

virtual

Explicitly set the extension to be added to the filename.

Parameters

extension Extension to be added to the filename, including a "." (e.g., ".mhd").

◆ SetExtension() [2/2]

virtual void mitk::ImageWriter::SetExtension ( const std::string & extension )

virtual

◆ SetFileName() [1/2]

void mitk::ImageWriter::SetFileName ( const char * fileName )

overridevirtual

Sets the filename of the file to write.

Parameters

fileName the name of the file to write.

Implements mitk::FileWriter.

◆ SetFileName() [2/2]

virtual void mitk::ImageWriter::SetFileName ( const std::string & fileName )

virtual

◆ SetFilePattern()

virtual void mitk::ImageWriter::SetFilePattern ( const char * _arg )

virtual

Warning: multiple write not (yet) supported

Implements mitk::FileWriter.

◆ SetFilePrefix()

virtual void mitk::ImageWriter::SetFilePrefix ( const char * _arg )

virtual

Warning: multiple write not (yet) supported

Implements mitk::FileWriter.

◆ SetInput() [1/2]

virtual void mitk::ImageWriter::SetInput ( DataNode * )

virtual

Set the DataTreenode as Input. Important: The Writer always have a SetInput-Function.

◆ SetInput() [2/2]

void mitk::ImageWriter::SetInput ( mitk::Image * input )

Sets the 0'th input object for the filter.

Parameters

input the first input for the filter.

◆ SetUseCompression()

void mitk::ImageWriter::SetUseCompression ( bool useCompression )

◆ WriteByITK()

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

protectedvirtual

Member Data Documentation

◆ m_Extension

std::string mitk::ImageWriter::m_Extension

protected

Definition at line 163 of file mitkImageWriter.h.

◆ m_FileName

std::string mitk::ImageWriter::m_FileName

protected

Definition at line 155 of file mitkImageWriter.h.

◆ m_FileNameWithoutExtension

std::string mitk::ImageWriter::m_FileNameWithoutExtension

protected

Definition at line 157 of file mitkImageWriter.h.

◆ m_FilePattern

std::string mitk::ImageWriter::m_FilePattern

protected

Definition at line 161 of file mitkImageWriter.h.

◆ m_FilePrefix

std::string mitk::ImageWriter::m_FilePrefix

protected

Definition at line 159 of file mitkImageWriter.h.

◆ m_MimeType

std::string mitk::ImageWriter::m_MimeType

protected

Definition at line 165 of file mitkImageWriter.h.

◆ m_UseCompression

bool mitk::ImageWriter::m_UseCompression

protected

Definition at line 167 of file mitkImageWriter.h.

◆ mitkWriterMacro

mitk::ImageWriter::mitkWriterMacro

Definition at line 37 of file mitkImageWriter.h.

The documentation for this class was generated from the following file:

mitkImageWriter.h

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ImageWriter()

◆ ~ImageWriter()

Member Function Documentation

◆ CanWriteBaseDataType()

◆ CanWriteDataType()

◆ Clone()

◆ DoWrite()

◆ GenerateData()

◆ GetDefaultExtension()

◆ GetDefaultFilename()

◆ GetExtension()

◆ GetFileDialogPattern()

◆ GetFileExtension()

◆ GetFileName()

◆ GetFilePattern()

◆ GetFilePrefix()

◆ GetInput()

◆ GetPossibleFileExtensions()

◆ GetSupportedBaseData()

◆ GetWritenMIMEType()

◆ mitkClassMacro()

◆ New()

◆ SetDefaultExtension()

◆ SetExtension() [1/2]

◆ SetExtension() [2/2]

◆ SetFileName() [1/2]

◆ SetFileName() [2/2]

◆ SetFilePattern()

◆ SetFilePrefix()

◆ SetInput() [1/2]

◆ SetInput() [2/2]

◆ SetUseCompression()

◆ WriteByITK()

Member Data Documentation

◆ m_Extension

◆ m_FileName

◆ m_FileNameWithoutExtension

◆ m_FilePattern

◆ m_FilePrefix

◆ m_MimeType

◆ m_UseCompression

◆ mitkWriterMacro