Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
mitk::NrrdTbssRoiImageWriter Class Reference

#include <mitkNrrdTbssRoiImageWriter.h>

Inheritance diagram for mitk::NrrdTbssRoiImageWriter:
Collaboration diagram for mitk::NrrdTbssRoiImageWriter:

Public Types

typedef itk::Image< unsigned char, 3 > ImageType
 
typedef mitk::TbssRoiImage InputType
 
- Public Types inherited from mitk::FileWriterWithInformation
typedef FileWriterWithInformation Self
 
typedef FileWriter Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Public Types inherited from mitk::FileWriter
typedef FileWriter Self
 
typedef itk::ProcessObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 

Public Member Functions

 mitkClassMacro (NrrdTbssRoiImageWriter, mitk::FileWriterWithInformation) mitkWriterMacro static Pointer New()
 
Pointer Clone () const
 
virtual void SetFileName (const char *_arg)
 
virtual const char * GetFileName () const
 
virtual void SetFilePrefix (const char *_arg)
 
virtual const char * GetFilePrefix () const
 
virtual void SetFilePattern (const char *_arg)
 
virtual const char * GetFilePattern () const
 
void SetInput (InputType *input)
 
InputTypeGetInput ()
 
virtual bool GetSuccess ()
 
virtual std::vector< std::string > GetPossibleFileExtensions () override
 
std::string GetSupportedBaseData () const override
 
virtual const char * GetDefaultFilename () override
 
virtual const char * GetFileDialogPattern () override
 
virtual const char * GetDefaultExtension () override
 
virtual bool CanWriteBaseDataType (BaseData::Pointer data) override
 
virtual 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
virtual std::string GetFileExtension ()
 Return the extension to be added to the filename. More...
 
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...
 
virtual bool CanWriteDataType (DataNode *)
 Check if the Writer can write this type of data of the DataTreenode. More...
 
virtual std::string GetWritenMIMEType ()
 Return the MimeType of the saved File. 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...
 

Protected Member Functions

 NrrdTbssRoiImageWriter ()
 
virtual ~NrrdTbssRoiImageWriter ()
 
virtual void GenerateData () override
 
- Protected Member Functions inherited from mitk::FileWriter
 FileWriter ()
 
virtual ~FileWriter ()
 

Protected Attributes

std::string m_FileName
 
std::string m_FilePrefix
 
std::string m_FilePattern
 
bool m_Success
 
- Protected Attributes inherited from mitk::FileWriter
bool m_CanWriteToMemory
 
bool m_WriteToMemory
 
char * m_MemoryBuffer
 
unsigned int m_MemoryBufferSize
 

Additional Inherited Members

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

Detailed Description

Writes diffusion volumes to a file

Definition at line 33 of file mitkNrrdTbssRoiImageWriter.h.

Member Typedef Documentation

Definition at line 37 of file mitkNrrdTbssRoiImageWriter.h.

Constructor & Destructor Documentation

mitk::NrrdTbssRoiImageWriter::NrrdTbssRoiImageWriter ( )
protected

Definition at line 32 of file mitkNrrdTbssRoiImageWriter.cpp.

mitk::NrrdTbssRoiImageWriter::~NrrdTbssRoiImageWriter ( )
protectedvirtual

Definition at line 39 of file mitkNrrdTbssRoiImageWriter.cpp.

Member Function Documentation

virtual bool mitk::NrrdTbssRoiImageWriter::CanWriteBaseDataType ( BaseData::Pointer  data)
inlineoverridevirtual

Implements mitk::FileWriterWithInformation.

Definition at line 107 of file mitkNrrdTbssRoiImageWriter.h.

Pointer mitk::NrrdTbssRoiImageWriter::Clone ( ) const
virtual void mitk::NrrdTbssRoiImageWriter::DoWrite ( BaseData::Pointer  data)
inlineoverridevirtual

Implements mitk::FileWriterWithInformation.

Definition at line 113 of file mitkNrrdTbssRoiImageWriter.h.

References Update().

void mitk::NrrdTbssRoiImageWriter::GenerateData ( )
overrideprotectedvirtual
virtual const char* mitk::NrrdTbssRoiImageWriter::GetDefaultExtension ( )
inlineoverridevirtual

Implements mitk::FileWriterWithInformation.

Definition at line 106 of file mitkNrrdTbssRoiImageWriter.h.

virtual const char* mitk::NrrdTbssRoiImageWriter::GetDefaultFilename ( )
inlineoverridevirtual

Implements mitk::FileWriterWithInformation.

Definition at line 104 of file mitkNrrdTbssRoiImageWriter.h.

virtual const char* mitk::NrrdTbssRoiImageWriter::GetFileDialogPattern ( )
inlineoverridevirtual

Implements mitk::FileWriterWithInformation.

Definition at line 105 of file mitkNrrdTbssRoiImageWriter.h.

virtual const char* mitk::NrrdTbssRoiImageWriter::GetFileName ( ) const
virtual
Returns
the name of the file to be written to disk.

Implements mitk::FileWriter.

virtual const char* mitk::NrrdTbssRoiImageWriter::GetFilePattern ( ) const
virtual
Warning
multiple write not (yet) supported

Implements mitk::FileWriter.

virtual const char* mitk::NrrdTbssRoiImageWriter::GetFilePrefix ( ) const
virtual
Warning
multiple write not (yet) supported

Implements mitk::FileWriter.

mitk::TbssRoiImage * mitk::NrrdTbssRoiImageWriter::GetInput ( void  )
Returns
the 0'th input object of the filter.

Definition at line 122 of file mitkNrrdTbssRoiImageWriter.cpp.

std::vector< std::string > mitk::NrrdTbssRoiImageWriter::GetPossibleFileExtensions ( )
overridevirtual
Returns
possible file extensions for the data type associated with the writer

Implements mitk::FileWriter.

Definition at line 135 of file mitkNrrdTbssRoiImageWriter.cpp.

virtual bool mitk::NrrdTbssRoiImageWriter::GetSuccess ( )
virtual

Returns false if an error happened during writing

std::string mitk::NrrdTbssRoiImageWriter::GetSupportedBaseData ( ) const
overridevirtual

Implements mitk::FileWriter.

Definition at line 142 of file mitkNrrdTbssRoiImageWriter.cpp.

References mitk::Image::GetStaticNameOfClass().

mitk::NrrdTbssRoiImageWriter::mitkClassMacro ( NrrdTbssRoiImageWriter  ,
mitk::FileWriterWithInformation   
)
virtual void mitk::NrrdTbssRoiImageWriter::SetFileName ( const char *  _arg)
virtual

Sets the filename of the file to write.

Parameters
FileNamethe nameInputType of the file to write.

Implements mitk::FileWriter.

virtual void mitk::NrrdTbssRoiImageWriter::SetFilePattern ( const char *  _arg)
virtual
Warning
multiple write not (yet) supported

Implements mitk::FileWriter.

virtual void mitk::NrrdTbssRoiImageWriter::SetFilePrefix ( const char *  _arg)
virtual
Warning
multiple write not (yet) supported

Implements mitk::FileWriter.

void mitk::NrrdTbssRoiImageWriter::SetInput ( InputType input)

Definition at line 116 of file mitkNrrdTbssRoiImageWriter.cpp.

Member Data Documentation

std::string mitk::NrrdTbssRoiImageWriter::m_FileName
protected

Definition at line 128 of file mitkNrrdTbssRoiImageWriter.h.

std::string mitk::NrrdTbssRoiImageWriter::m_FilePattern
protected

Definition at line 132 of file mitkNrrdTbssRoiImageWriter.h.

std::string mitk::NrrdTbssRoiImageWriter::m_FilePrefix
protected

Definition at line 130 of file mitkNrrdTbssRoiImageWriter.h.

bool mitk::NrrdTbssRoiImageWriter::m_Success
protected

Definition at line 134 of file mitkNrrdTbssRoiImageWriter.h.


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