Medical Imaging Interaction Toolkit
2024.06.99-caca2dd0
Medical Imaging Interaction Toolkit
|
VTK-based writer for mitk::Surface. More...
#include <mitkSurfaceVtkWriter.h>
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 |
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.
Definition at line 51 of file mitkSurfaceVtkWriter.h.
typedef VTKWRITER mitk::SurfaceVtkWriter< VTKWRITER >::VtkWriterType |
Definition at line 62 of file mitkSurfaceVtkWriter.h.
|
protected |
Constructor.
|
overrideprotected |
Virtual destructor.
|
overridevirtual |
Implements mitk::FileWriterWithInformation.
|
overridevirtual |
Check if the Writer can write the Content of the DataTreenode.
Reimplemented from mitk::FileWriter.
Pointer mitk::SurfaceVtkWriter< VTKWRITER >::Clone | ( | ) | const |
|
overridevirtual |
Implements mitk::FileWriterWithInformation.
|
protected |
|
overrideprotected |
|
overridevirtual |
Implements mitk::FileWriterWithInformation.
|
overridevirtual |
Implements mitk::FileWriterWithInformation.
|
virtual |
Get the extension to be added to the filename.
|
overridevirtual |
Implements mitk::FileWriterWithInformation.
|
overridevirtual |
Return the extension to be added to the filename.
Reimplemented from mitk::FileWriter.
|
virtual |
Implements mitk::FileWriter.
|
virtual |
Implements mitk::FileWriter.
|
virtual |
Implements mitk::FileWriter.
const mitk::Surface* mitk::SurfaceVtkWriter< VTKWRITER >::GetInput | ( | ) |
|
overridevirtual |
Return the possible file extensions for the data type associated with the writer.
Implements mitk::FileWriter.
|
inlineoverridevirtual |
Implements mitk::FileWriter.
Definition at line 158 of file mitkSurfaceVtkWriter.h.
References mitk::Surface::GetStaticNameOfClass().
|
inline |
Definition at line 152 of file mitkSurfaceVtkWriter.h.
|
overridevirtual |
Return the MimeType of the saved File.
Reimplemented from mitk::FileWriter.
mitk::SurfaceVtkWriter< VTKWRITER >::mitkClassMacro | ( | SurfaceVtkWriter< VTKWRITER > | , |
mitk::FileWriter | |||
) |
|
static |
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.
|
virtual |
Explicitly set the extension to be added to the filename.
_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.
|
virtual |
Sets the filename of the file to write.
_arg | the name of the file to write. |
Implements mitk::FileWriter.
|
virtual |
Implements mitk::FileWriter.
|
virtual |
Implements mitk::FileWriter.
|
virtual |
Set the DataTreenode as Input. Important: The Writer always have a SetInput-Function.
void mitk::SurfaceVtkWriter< VTKWRITER >::SetInput | ( | mitk::Surface * | input | ) |
Sets the 0'th input object for the filter.
input | the first input for the filter. |
|
protected |
Definition at line 186 of file mitkSurfaceVtkWriter.h.
|
protected |
Definition at line 180 of file mitkSurfaceVtkWriter.h.
|
protected |
Definition at line 184 of file mitkSurfaceVtkWriter.h.
|
protected |
Definition at line 182 of file mitkSurfaceVtkWriter.h.
|
protected |
Definition at line 188 of file mitkSurfaceVtkWriter.h.
|
protected |
Definition at line 190 of file mitkSurfaceVtkWriter.h.
|
protected |
Definition at line 192 of file mitkSurfaceVtkWriter.h.
mitk::SurfaceVtkWriter< VTKWRITER >::mitkWriterMacro |
Definition at line 58 of file mitkSurfaceVtkWriter.h.