mitk::ImageWriter Class Reference

Writer for mitk::Image. More...

#include <mitkImageWriter.h>

Inheritance diagram for mitk::ImageWriter:

Collaboration diagram for mitk::ImageWriter:

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, .pic, .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.

Definition at line 25 of file mitkImageWriter.cpp.

References m_MimeType, and SetDefaultExtension().

~ImageWriter()

mitk::ImageWriter::~ImageWriter ( )

overrideprotected

Virtual destructor.

Definition at line 32 of file mitkImageWriter.cpp.

Member Function Documentation

CanWriteBaseDataType()

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

overridevirtual

Implements mitk::FileWriterWithInformation.

Definition at line 459 of file mitkImageWriter.cpp.

Referenced by CanWriteDataType(), and DoWrite().

CanWriteDataType()

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

overridevirtual

Check if the Writer can write the Content of the.

Reimplemented from mitk::FileWriter.

Definition at line 357 of file mitkImageWriter.cpp.

References CanWriteBaseDataType(), and mitk::DataNode::GetData().

Referenced by SetInput().

Clone()

Pointer mitk::ImageWriter::Clone

(

)

const

DoWrite()

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

overridevirtual

Implements mitk::FileWriterWithInformation.

Definition at line 464 of file mitkImageWriter.cpp.

References CanWriteBaseDataType(), SetInput(), and Update().

GenerateData()

void mitk::ImageWriter::GenerateData ( )

overrideprotected

Definition at line 234 of file mitkImageWriter.cpp.

References mitk::Image::Clone(), GetInput(), image, m_Extension, m_FileName, m_FileNameWithoutExtension, m_MimeType, MITK_WARN, mitk::ImageTimeSelector::New(), WriteByITK(), and writeVti().

GetDefaultExtension()

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

overridevirtual

Implements mitk::FileWriterWithInformation.

Definition at line 454 of file mitkImageWriter.cpp.

GetDefaultFilename()

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

overridevirtual

Implements mitk::FileWriterWithInformation.

Definition at line 436 of file mitkImageWriter.cpp.

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.

Definition at line 441 of file mitkImageWriter.cpp.

GetFileExtension()

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

overridevirtual

Return the extension to be added to the filename.

Reimplemented from mitk::FileWriter.

Definition at line 414 of file mitkImageWriter.cpp.

References m_Extension.

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

(

void

)

Returns

the 0'th input object of the filter.

Definition at line 424 of file mitkImageWriter.cpp.

Referenced by GenerateData().

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.

Definition at line 377 of file mitkImageWriter.cpp.

GetSupportedBaseData()

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

overridevirtual

Implements mitk::FileWriter.

Definition at line 409 of file mitkImageWriter.cpp.

References mitk::Image::GetStaticNameOfClass().

GetWritenMIMEType()

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

overridevirtual

Return the MimeType of the saved File.

Reimplemented from mitk::FileWriter.

Definition at line 372 of file mitkImageWriter.cpp.

References m_MimeType.

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.

Definition at line 96 of file mitkImageWriter.cpp.

References m_Extension, m_FileName, and m_FileNameWithoutExtension.

Referenced by ImageWriter().

SetExtension() [1/2]

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

virtual

Explicitly set the extension to be added to the filename.

Parameters

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

Definition at line 72 of file mitkImageWriter.cpp.

References m_Extension, m_FileName, and m_FileNameWithoutExtension.

SetExtension() [2/2]

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

virtual

Definition at line 91 of file mitkImageWriter.cpp.

References SetFileName().

SetFileName() [1/2]

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

overridevirtual

Sets the filename of the file to write.

Parameters

_arg	the name of the file to write.

Implements mitk::FileWriter.

Definition at line 36 of file mitkImageWriter.cpp.

References m_Extension, m_FileName, and m_FileNameWithoutExtension.

Referenced by SetExtension(), and SetFileName().

SetFileName() [2/2]

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

virtual

Definition at line 67 of file mitkImageWriter.cpp.

References SetFileName().

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]

void mitk::ImageWriter::SetInput

(

mitk::Image *

input

)

Sets the 0'th input object for the filter.

Parameters

input

the first input for the filter.

Definition at line 419 of file mitkImageWriter.cpp.

Referenced by DoWrite().

SetInput() [2/2]

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

virtual

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

Definition at line 366 of file mitkImageWriter.cpp.

References CanWriteDataType(), and mitk::DataNode::GetData().

SetUseCompression()

void mitk::ImageWriter::SetUseCompression

(

bool

useCompression

)

Definition at line 473 of file mitkImageWriter.cpp.

References m_UseCompression.

WriteByITK()

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

protectedvirtual

Definition at line 117 of file mitkImageWriter.cpp.

References _mitkItkPictureWrite(), _mitkItkPictureWriteComposite(), AccessByItk_1, AccessFixedPixelTypeByItk_1, mitk::PixelType::GetComponentType(), mitk::ImageAccessorBase::GetData(), mitk::Image::GetDimension(), mitk::Image::GetDimensions(), mitk::BaseData::GetGeometry(), mitk::BaseGeometry::GetIndexToWorldTransform(), mitk::SlicedData::GetLargestPossibleRegion(), mitk::PixelType::GetNumberOfComponents(), mitk::BaseGeometry::GetOrigin(), mitk::PixelType::GetPixelType(), mitk::Image::GetPixelType(), mitk::BaseGeometry::GetSpacing(), m_UseCompression, MITK_ACCESSBYITK_COMPOSITE_PIXEL_TYPES_SEQ, MITK_ACCESSBYITK_PIXEL_TYPES_SEQ, MITK_INFO, and mitk::PixelComponentUserType.

Referenced by GenerateData().

Member Data Documentation

m_Extension

std::string mitk::ImageWriter::m_Extension

protected

Definition at line 163 of file mitkImageWriter.h.

Referenced by GenerateData(), GetFileExtension(), SetDefaultExtension(), SetExtension(), and SetFileName().

m_FileName

std::string mitk::ImageWriter::m_FileName

protected

Definition at line 155 of file mitkImageWriter.h.

Referenced by GenerateData(), SetDefaultExtension(), SetExtension(), and SetFileName().

m_FileNameWithoutExtension

std::string mitk::ImageWriter::m_FileNameWithoutExtension

protected

Definition at line 157 of file mitkImageWriter.h.

Referenced by GenerateData(), SetDefaultExtension(), SetExtension(), and SetFileName().

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.

Referenced by GenerateData(), GetWritenMIMEType(), and ImageWriter().

m_UseCompression

bool mitk::ImageWriter::m_UseCompression

protected

Definition at line 167 of file mitkImageWriter.h.

Referenced by SetUseCompression(), and WriteByITK().

mitkWriterMacro

mitk::ImageWriter::mitkWriterMacro

Definition at line 37 of file mitkImageWriter.h.

---

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

• mitkImageWriter.h
• mitkImageWriter.cpp