VTK-based writer for mitk::Surface. More...

#include <mitkSurfaceVtkWriter.h>

Inheritance diagram for mitk::SurfaceVtkWriter< VTKWRITER >:

[legend]

Collaboration diagram for mitk::SurfaceVtkWriter< VTKWRITER >:

[legend]

Public Types
typedef VTKWRITER	VtkWriterType

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

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

Pointer	Clone () const

virtual void	SetFileName (const char *_arg)

virtual const char *	GetFileName () const

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

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::Surface *input)

const mitk::Surface *	GetInput ()

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 DataTreenode. 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...

VtkWriterType *	GetVtkWriter ()

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

const char *	GetDefaultFilename () override

const char *	GetFileDialogPattern () override

const char *	GetDefaultExtension () override

bool	CanWriteBaseDataType (BaseData::Pointer data) override

void	DoWrite (BaseData::Pointer data) override

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
	SurfaceVtkWriter ()

	~SurfaceVtkWriter () override

void	GenerateData () override

void	ExecuteWrite (VtkWriterType *vtkWriter)

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

	~FileWriter () override

Protected Attributes
std::string	m_FileName

std::string	m_FilePrefix

std::string	m_FilePattern

std::string	m_Extension

std::string	m_MimeType

vtkSmartPointer< VtkWriterType >	m_VtkWriter

bool	m_WriterWriteHasReturnValue

Protected Attributes inherited from mitk::FileWriter
bool	m_CanWriteToMemory

bool	m_WriteToMemory

char *	m_MemoryBuffer

unsigned int	m_MemoryBufferSize

Detailed Description

template<class VTKWRITER>
class mitk::SurfaceVtkWriter< VTKWRITER >

VTK-based writer for mitk::Surface.

The mitk::Surface is written using the VTK-writer-type provided as the template argument. If the mitk::Surface contains multiple points of time, multiple files are written. The life-span (time-bounds) of each each point of time is included in the filename according to the following scheme: <filename>_S<timebounds[0]>E<timebounds[1]>_T<framenumber> (S=start, E=end, T=time). Writing of multiple files according to a given filename pattern is not yet supported.

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

Definition at line 51 of file mitkSurfaceVtkWriter.h.

Member Typedef Documentation

◆ VtkWriterType

template<class VTKWRITER >

typedef VTKWRITER mitk::SurfaceVtkWriter< VTKWRITER >::VtkWriterType

Definition at line 62 of file mitkSurfaceVtkWriter.h.

Constructor & Destructor Documentation

◆ SurfaceVtkWriter()

template<class VTKWRITER >

mitk::SurfaceVtkWriter< VTKWRITER >::SurfaceVtkWriter ( )

protected

Constructor.

◆ ~SurfaceVtkWriter()

template<class VTKWRITER >

mitk::SurfaceVtkWriter< VTKWRITER >::~SurfaceVtkWriter ( )

overrideprotected

Virtual destructor.

Member Function Documentation

◆ CanWriteBaseDataType()

template<class VTKWRITER >

bool mitk::SurfaceVtkWriter< VTKWRITER >::CanWriteBaseDataType ( BaseData::Pointer data )

overridevirtual

Implements mitk::FileWriterWithInformation.

◆ CanWriteDataType()

template<class VTKWRITER >

bool mitk::SurfaceVtkWriter< VTKWRITER >::CanWriteDataType ( DataNode * )

overridevirtual

Check if the Writer can write the Content of the DataTreenode.

Reimplemented from mitk::FileWriter.

◆ Clone()

template<class VTKWRITER >

Pointer mitk::SurfaceVtkWriter< VTKWRITER >::Clone ( ) const

◆ DoWrite()

template<class VTKWRITER >

void mitk::SurfaceVtkWriter< VTKWRITER >::DoWrite ( BaseData::Pointer data )

overridevirtual

Implements mitk::FileWriterWithInformation.

◆ ExecuteWrite()

template<class VTKWRITER >

void mitk::SurfaceVtkWriter< VTKWRITER >::ExecuteWrite ( VtkWriterType * vtkWriter )

protected

◆ GenerateData()

template<class VTKWRITER >

void mitk::SurfaceVtkWriter< VTKWRITER >::GenerateData ( )

overrideprotected

◆ GetDefaultExtension()

template<class VTKWRITER >

const char* mitk::SurfaceVtkWriter< VTKWRITER >::GetDefaultExtension ( )

overridevirtual

Implements mitk::FileWriterWithInformation.

◆ GetDefaultFilename()

template<class VTKWRITER >

const char* mitk::SurfaceVtkWriter< VTKWRITER >::GetDefaultFilename ( )

overridevirtual

Implements mitk::FileWriterWithInformation.

◆ GetExtension()

template<class VTKWRITER >

virtual const char* mitk::SurfaceVtkWriter< VTKWRITER >::GetExtension ( ) const

virtual

Get the extension to be added to the filename.

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

◆ GetFileDialogPattern()

template<class VTKWRITER >

const char* mitk::SurfaceVtkWriter< VTKWRITER >::GetFileDialogPattern ( )

overridevirtual

Implements mitk::FileWriterWithInformation.

◆ GetFileExtension()

template<class VTKWRITER >

std::string mitk::SurfaceVtkWriter< VTKWRITER >::GetFileExtension ( )

overridevirtual

Return the extension to be added to the filename.

Reimplemented from mitk::FileWriter.

◆ GetFileName()

template<class VTKWRITER >

virtual const char* mitk::SurfaceVtkWriter< VTKWRITER >::GetFileName ( ) const

virtual

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

Implements mitk::FileWriter.

◆ GetFilePattern()

template<class VTKWRITER >

virtual const char* mitk::SurfaceVtkWriter< VTKWRITER >::GetFilePattern ( ) const

virtual

Warning: multiple write not (yet) supported

Implements mitk::FileWriter.

◆ GetFilePrefix()

template<class VTKWRITER >

virtual const char* mitk::SurfaceVtkWriter< VTKWRITER >::GetFilePrefix ( ) const

virtual

Warning: multiple write not (yet) supported

Implements mitk::FileWriter.

◆ GetInput()

template<class VTKWRITER >

const mitk::Surface* mitk::SurfaceVtkWriter< VTKWRITER >::GetInput ( )

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

◆ GetPossibleFileExtensions()

template<class VTKWRITER >

std::vector<std::string> mitk::SurfaceVtkWriter< VTKWRITER >::GetPossibleFileExtensions ( )

overridevirtual

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

Implements mitk::FileWriter.

◆ GetSupportedBaseData()

template<class VTKWRITER >

std::string mitk::SurfaceVtkWriter< VTKWRITER >::GetSupportedBaseData ( ) const

inlineoverridevirtual

Implements mitk::FileWriter.

Definition at line 158 of file mitkSurfaceVtkWriter.h.

References mitk::Surface::GetStaticNameOfClass().

◆ GetVtkWriter()

template<class VTKWRITER >

VtkWriterType* mitk::SurfaceVtkWriter< VTKWRITER >::GetVtkWriter ( )

inline

Definition at line 152 of file mitkSurfaceVtkWriter.h.

◆ GetWritenMIMEType()

template<class VTKWRITER >

std::string mitk::SurfaceVtkWriter< VTKWRITER >::GetWritenMIMEType ( )

overridevirtual

Return the MimeType of the saved File.

Reimplemented from mitk::FileWriter.

◆ mitkClassMacro()

template<class VTKWRITER >

mitk::SurfaceVtkWriter< VTKWRITER >::mitkClassMacro	(	SurfaceVtkWriter< VTKWRITER >	,
		mitk::FileWriter
	)

◆ New()

template<class VTKWRITER >

static Pointer mitk::SurfaceVtkWriter< VTKWRITER >::New ( )

static

◆ SetDefaultExtension()

template<class VTKWRITER >

void mitk::SurfaceVtkWriter< VTKWRITER >::SetDefaultExtension ( )

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

Partial template specialization is used for some vtk-writer types to define the default extension.

◆ SetExtension()

template<class VTKWRITER >

virtual void mitk::SurfaceVtkWriter< VTKWRITER >::SetExtension ( const char * _arg )

virtual

Explicitly set the extension to be added to the filename.

Parameters

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

Partial template specialization is used for some vtk-writer types to set a default extension.

◆ SetFileName()

template<class VTKWRITER >

virtual void mitk::SurfaceVtkWriter< VTKWRITER >::SetFileName ( const char * _arg )

virtual

Sets the filename of the file to write.

Parameters

_arg	the name of the file to write.

Implements mitk::FileWriter.

◆ SetFilePattern()

template<class VTKWRITER >

virtual void mitk::SurfaceVtkWriter< VTKWRITER >::SetFilePattern ( const char * _arg )

virtual

Warning: multiple write not (yet) supported

Implements mitk::FileWriter.

◆ SetFilePrefix()

template<class VTKWRITER >

virtual void mitk::SurfaceVtkWriter< VTKWRITER >::SetFilePrefix ( const char * _arg )

virtual

Warning: multiple write not (yet) supported

Implements mitk::FileWriter.

◆ SetInput() [1/2]

template<class VTKWRITER >

virtual void mitk::SurfaceVtkWriter< VTKWRITER >::SetInput ( DataNode * )

virtual

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

◆ SetInput() [2/2]

template<class VTKWRITER >

void mitk::SurfaceVtkWriter< VTKWRITER >::SetInput ( mitk::Surface * input )

Sets the 0'th input object for the filter.

Parameters

input the first input for the filter.

Member Data Documentation

◆ m_Extension

template<class VTKWRITER >

std::string mitk::SurfaceVtkWriter< VTKWRITER >::m_Extension

protected

Definition at line 186 of file mitkSurfaceVtkWriter.h.

◆ m_FileName

template<class VTKWRITER >

std::string mitk::SurfaceVtkWriter< VTKWRITER >::m_FileName

protected

Definition at line 180 of file mitkSurfaceVtkWriter.h.

◆ m_FilePattern

template<class VTKWRITER >

std::string mitk::SurfaceVtkWriter< VTKWRITER >::m_FilePattern

protected

Definition at line 184 of file mitkSurfaceVtkWriter.h.

◆ m_FilePrefix

template<class VTKWRITER >

std::string mitk::SurfaceVtkWriter< VTKWRITER >::m_FilePrefix

protected

Definition at line 182 of file mitkSurfaceVtkWriter.h.

◆ m_MimeType

template<class VTKWRITER >

std::string mitk::SurfaceVtkWriter< VTKWRITER >::m_MimeType

protected

Definition at line 188 of file mitkSurfaceVtkWriter.h.

◆ m_VtkWriter

template<class VTKWRITER >

vtkSmartPointer<VtkWriterType> mitk::SurfaceVtkWriter< VTKWRITER >::m_VtkWriter

protected

Definition at line 190 of file mitkSurfaceVtkWriter.h.

◆ m_WriterWriteHasReturnValue

template<class VTKWRITER >

bool mitk::SurfaceVtkWriter< VTKWRITER >::m_WriterWriteHasReturnValue

protected

Definition at line 192 of file mitkSurfaceVtkWriter.h.

◆ mitkWriterMacro

template<class VTKWRITER >

mitk::SurfaceVtkWriter< VTKWRITER >::mitkWriterMacro

Definition at line 58 of file mitkSurfaceVtkWriter.h.

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

mitkSurfaceVtkWriter.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

template<class VTKWRITER> class mitk::SurfaceVtkWriter< VTKWRITER >

Member Typedef Documentation

◆ VtkWriterType

Constructor & Destructor Documentation

◆ SurfaceVtkWriter()

◆ ~SurfaceVtkWriter()

Member Function Documentation

◆ CanWriteBaseDataType()

◆ CanWriteDataType()

◆ Clone()

◆ DoWrite()

◆ ExecuteWrite()

◆ GenerateData()

◆ GetDefaultExtension()

◆ GetDefaultFilename()

◆ GetExtension()

◆ GetFileDialogPattern()

◆ GetFileExtension()

◆ GetFileName()

◆ GetFilePattern()

◆ GetFilePrefix()

◆ GetInput()

◆ GetPossibleFileExtensions()

◆ GetSupportedBaseData()

◆ GetVtkWriter()

◆ GetWritenMIMEType()

◆ mitkClassMacro()

◆ New()

◆ SetDefaultExtension()

◆ SetExtension()

◆ SetFileName()

◆ SetFilePattern()

◆ SetFilePrefix()

◆ SetInput() [1/2]

◆ SetInput() [2/2]

Member Data Documentation

◆ m_Extension

◆ m_FileName

◆ m_FilePattern

◆ m_FilePrefix

◆ m_MimeType

◆ m_VtkWriter

◆ m_WriterWriteHasReturnValue

◆ mitkWriterMacro

template<class VTKWRITER>
class mitk::SurfaceVtkWriter< VTKWRITER >