Writer of markups nodes. Markups can be written in json (.mrk.json) or fiducial CSV (.fcsv) format. More...

#include <Modules/Loadable/Markups/Logic/vtkSlicerMarkupsWriter.h>

Inheritance diagram for vtkSlicerMarkupsWriter:

[legend]

Collaboration diagram for vtkSlicerMarkupsWriter:

[legend]

Public Types
typedef vtkMRMLNodeWriter	Superclass

Public Types inherited from vtkMRMLNodeWriter
typedef vtkMRMLFileWriter	Superclass

Public Types inherited from vtkMRMLFileWriter
typedef vtkMRMLFileIOHandler	Superclass

Public Types inherited from vtkMRMLFileIOHandler
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

std::vector< std::string >	GetNameFiltersForObject (vtkObject *object) override
	Supported formats of json and fcsv storage nodes.

virtual int	IsA (const char *type)

bool	Write (vtkMRMLIOProperties *properties) override
	Write the node using the storage node that matches the file extension.

Public Member Functions inherited from vtkMRMLNodeWriter
bool	CanWriteObject (vtkObject *object) override
	Return true if the object is a storable node of any of the node class names.

virtual vtkMRMLNode *	GetNodeByID (const std::string &id)
	Get node from the scene by node ID.

void	GetOptionsDescription (vtkMRMLIOOptionsDescription *description) override

virtual bool	GetSupportUseCompression ()
	Some storage nodes don't support the compression option.

void	PrintSelf (ostream &os, vtkIndent indent) override

virtual void	SetSupportUseCompression (bool)

virtual void	SupportUseCompressionOff ()

virtual void	SupportUseCompressionOn ()

bool	WriteNode (vtkMRMLStorableNode node, vtkMRMLIOProperties properties)

Public Member Functions inherited from vtkMRMLFileWriter
void	AddNodeClassName (const std::string &className)

void	AddWrittenNodeID (const std::string &nodeID)

virtual double	CanWriteObjectConfidence (vtkObject *object)

void	ClearWrittenNodeIDs ()

virtual double	GetConfidenceForMatchingClass ()
	What a writer that only knows its node class answers for a node of that class.

std::string	GetNodeClassName () const

const std::vector< std::string > &	GetNodeClassNames () const

const std::vector< std::string > &	GetWrittenNodeIDs () const
	The nodes the last Write wrote, by node ID.

bool	IsWriter () const override
	Whether this writes rather than reads.

void	PrintSelf (ostream &os, vtkIndent indent) override

virtual void	SetConfidenceForMatchingClass (double)

void	SetNodeClassName (const std::string &className)

void	SetNodeClassNames (const std::vector< std::string > &classNames)
	The classes of nodes this writer is for.

void	SetWrittenNodeIDs (const std::vector< std::string > &nodeIDs)

Public Member Functions inherited from vtkMRMLFileIOHandler
void	FillOptionsDescription (vtkMRMLIOProperties properties, vtkMRMLIOOptionsDescription description)

virtual std::string	GetDescription ()
	What to call this in a file dialog ("Volume", "Mimics project").

const std::vector< std::string > &	GetExtensions () const

vtkMRMLFileIOManager *	GetFileIOManager () const

virtual std::string	GetFileType ()

virtual std::string	GetMatchedExtension (const std::string &filePath) const
	The longest matching extension of filePath, or an empty string.

const std::vector< std::string > &	GetNameFilters () const

vtkMRMLIOProperties *	GetOptionDefaults ()

std::string	GetOptionsDescriptionJSON (vtkMRMLIOProperties *properties)

void	GetOptionValues (vtkMRMLIOProperties properties, vtkMRMLIOProperties values)

vtkMRMLScene *	GetScene () const

vtkMRMLMessageCollection *	GetUserMessages () const

virtual bool	MatchesExtension (const std::string &filePath) const

void	PrintSelf (ostream &os, vtkIndent indent) override

virtual void	SetDescription (std::string)

void	SetFileIOManager (vtkMRMLFileIOManager *manager)

virtual void	SetFileType (std::string)

void	SetNameFilters (const std::vector< std::string > &filters)
	The name filters, as Slicer writes them: "Mimics project (.mcs .mcs.gz)".

virtual void	SetScene (vtkMRMLScene *scene)
	Where the nodes go, and where messages for the user are collected.

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkSlicerMarkupsWriter *	New ()

static vtkSlicerMarkupsWriter *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLNodeWriter
static vtkSmartPointer< vtkMRMLNodeWriter >	CreateNodeWriter (const std::string &description, const std::string &fileType, const std::vector< std::string > &nodeClassNames, bool supportUseCompression=true)

static int	IsTypeOf (const char *type)

static vtkMRMLNodeWriter *	New ()

static vtkMRMLNodeWriter *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLFileWriter
static int	IsTypeOf (const char *type)

static vtkMRMLFileWriter *	New ()

static vtkMRMLFileWriter *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLFileIOHandler
static std::vector< std::string >	ExtensionsFromNameFilter (const std::string &nameFilter)
	The extensions named by a filter such as "Mimics project (.mcs .mcs.gz)".

static std::vector< std::string >	GetMatchingNameFilters (const std::string &filePath, const std::vector< std::string > &nameFilters, bool requireReadableFile, int *longestExtensionMatch=nullptr)

static int	IsTypeOf (const char *type)

static std::string	LongestMatchingExtension (const std::string &filePath, const std::vector< std::string > &extensions)

static std::vector< std::string >	NameFilterToWildcards (const std::string &nameFilter)

static vtkMRMLFileIOHandler *	New ()

static vtkMRMLFileIOHandler *	SafeDownCast (vtkObject *o)

static bool	WildcardMatch (const std::string &pattern, const std::string &text)
	Case-insensitive wildcard matching of the whole text. Supported wildcards: '*', '?', and character sets ("[abc]", "[!abc]").

Protected Member Functions
void	SetStorageNodeClass (vtkMRMLStorableNode *storableNode, const std::string &storageNodeClassName)
	Make sure the storable node uses a storage node of the specified class.

	vtkSlicerMarkupsWriter ()

	~vtkSlicerMarkupsWriter () override

Protected Member Functions inherited from vtkMRMLNodeWriter
	vtkMRMLNodeWriter ()

	~vtkMRMLNodeWriter () override

Protected Member Functions inherited from vtkMRMLFileWriter
	vtkMRMLFileWriter ()

	~vtkMRMLFileWriter () override

Protected Member Functions inherited from vtkMRMLFileIOHandler
	vtkMRMLFileIOHandler ()

	~vtkMRMLFileIOHandler () override

Additional Inherited Members
Protected Attributes inherited from vtkMRMLNodeWriter
bool	SupportUseCompression { true }

Protected Attributes inherited from vtkMRMLFileWriter
double	ConfidenceForMatchingClass { 0.5 }

std::vector< std::string >	NodeClassNames

std::vector< std::string >	WrittenNodeIDs

Protected Attributes inherited from vtkMRMLFileIOHandler
std::string	Description

std::vector< std::string >	Extensions

vtkWeakPointer< vtkMRMLFileIOManager >	FileIOManager

std::string	FileType

std::vector< std::string >	NameFilters

vtkNew< vtkMRMLIOProperties >	OptionDefaults

vtkWeakPointer< vtkMRMLScene >	Scene

vtkNew< vtkMRMLMessageCollection >	UserMessages

Detailed Description

Writer of markups nodes. Markups can be written in json (.mrk.json) or fiducial CSV (.fcsv) format.

Definition at line 29 of file vtkSlicerMarkupsWriter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMRMLNodeWriter vtkSlicerMarkupsWriter::Superclass

Definition at line 33 of file vtkSlicerMarkupsWriter.h.

Constructor & Destructor Documentation

◆ vtkSlicerMarkupsWriter()

vtkSlicerMarkupsWriter::vtkSlicerMarkupsWriter ( )

protected

◆ ~vtkSlicerMarkupsWriter()

vtkSlicerMarkupsWriter::~vtkSlicerMarkupsWriter ( )

overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char * vtkSlicerMarkupsWriter::GetClassName ( )

virtual

Reimplemented from vtkMRMLNodeWriter.

◆ GetNameFiltersForObject()

std::vector< std::string > vtkSlicerMarkupsWriter::GetNameFiltersForObject ( vtkObject * object )

overridevirtual

Supported formats of json and fcsv storage nodes.

Reimplemented from vtkMRMLNodeWriter.

◆ IsA()

virtual int vtkSlicerMarkupsWriter::IsA ( const char * type )

virtual

Reimplemented from vtkMRMLNodeWriter.

◆ IsTypeOf()

static int vtkSlicerMarkupsWriter::IsTypeOf ( const char * type )

static

◆ New()

static vtkSlicerMarkupsWriter * vtkSlicerMarkupsWriter::New ( )

static

◆ SafeDownCast()

static vtkSlicerMarkupsWriter * vtkSlicerMarkupsWriter::SafeDownCast ( vtkObject * o )

static

◆ SetStorageNodeClass()

void vtkSlicerMarkupsWriter::SetStorageNodeClass	(	vtkMRMLStorableNode *	storableNode,
		const std::string &	storageNodeClassName )

protected

Make sure the storable node uses a storage node of the specified class.

◆ Write()

bool vtkSlicerMarkupsWriter::Write ( vtkMRMLIOProperties * properties )

overridevirtual

Write the node using the storage node that matches the file extension.

Reimplemented from vtkMRMLNodeWriter.

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

Modules/Loadable/Markups/Logic/vtkSlicerMarkupsWriter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSlicerMarkupsWriter()

◆ ~vtkSlicerMarkupsWriter()

Member Function Documentation

◆ GetClassName()

◆ GetNameFiltersForObject()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ SafeDownCast()

◆ SetStorageNodeClass()

◆ Write()