vtkMRMLVolumeSequenceStorageNode Class Reference

Store a sequence of volumes in a NRRD file. More...

#include <Libs/MRML/Core/vtkMRMLVolumeSequenceStorageNode.h>

Inheritance diagram for vtkMRMLVolumeSequenceStorageNode:

Collaboration diagram for vtkMRMLVolumeSequenceStorageNode:

Public Types
typedef vtkMRMLStorageNode	Superclass
Public Types inherited from vtkMRMLStorageNode
enum	{   Idle , Pending , Scheduled , Transferring ,   TransferDone , Cancelled , SkippedNoData }
enum	{   CoordinateSystemRAS = 0 , RAS = 0 , CoordinateSystemLPS = 1 , LPS = 1 ,   CoordinateSystemType_Last }
typedef vtkMRMLNode	Superclass
Public Types inherited from vtkMRMLNode
enum	{   HierarchyModifiedEvent = 16000 , IDChangedEvent = 16001 , ReferenceAddedEvent , ReferenceModifiedEvent ,   ReferenceRemovedEvent , ReferencedNodeModifiedEvent }
enum	ContentModifiedObserveType { ContentModifiedObserveUndefined = -1 , ContentModifiedObserveDisabled = 0 , ContentModifiedObserveEnabled = 1 }
typedef std::map< std::string, std::string >	ReferencePropertiesType
	Get the node reference properties for a specific referenceRole.
typedef vtkObject	Superclass

Public Member Functions
bool	CanReadInReferenceNode (vtkMRMLNode *refNode) override
	Return true if this class can read the node.
bool	CanWriteFromReferenceNode (vtkMRMLNode *refNode) override
	Return true if this class can write the node.
vtkMRMLNode *	CreateNodeInstance () override
	Create instance of the default node. Like New only virtual.
virtual const char *	GetClassName ()
const char *	GetDefaultWriteFileExtension () override
	Return a default file extension for writing.
const char *	GetNodeTagName () override
	Get node XML tag name (like Storage, Model)
std::string	GetTypeDisplayName () override
	Get node type to be displayed to the user.
virtual int	IsA (const char *type)
int	WriteDataInternal (vtkMRMLNode *refNode) override
Public Member Functions inherited from vtkMRMLStorageNode
unsigned int	AddFileName (const char *fileName)
	Add in another file name to the list of file names.
unsigned int	AddURI (const char *uri)
	Add in another URI to the list of URI's.
virtual void	ConfigureForDataExchange ()
void	Copy (vtkMRMLNode *node) override
	Copy the node's attributes to this object.
int	FileNameIsInList (const char *fileName)
void	FixFileName ()
const char *	GetAbsoluteFilePath (const char *inputPath)
virtual std::string	GetCompressionParameter ()
virtual std::string	GetCompressionParameterFromDisplayName (const std::string &name)
	Returns a string representing the specified preset.
virtual std::vector< std::string >	GetCompressionPresetDisplayNames ()
	Returns a list of displayable names of the supported compression presets.
virtual const std::vector< CompressionPreset >	GetCompressionPresets ()
	Get a list of all supported compression presets.
virtual std::string	GetDisplayNameFromCompressionParameter (const std::string &preset)
	Returns the name of the specified preset.
virtual void	GetFileExtensionsFromFileTypes (vtkStringArray *inputFileTypes, vtkStringArray *outputFileExtensions)
virtual char *	GetFileName ()
std::string	GetFileNameWithoutExtension (const char *fileName=nullptr)
std::string	GetFullNameFromFileName ()
std::string	GetFullNameFromNthFileName (int n)
const char *	GetNthFileName (int n) const
	return the nth file name, null if doesn't exist
const char *	GetNthURI (int n)
	Get the nth URI from the list of URI's.
virtual int	GetNumberOfCompressionPresets ()
	Get the number of compression presets.
int	GetNumberOfFileNames () const
	See how many file names were generated during ExecuteInformation.
int	GetNumberOfURIs ()
	Return how many URI names this storage node holds in it's list.
virtual int	GetReadState ()
	Get/Set the state of reading.
const char *	GetReadStateAsString ()
const char *	GetStateAsString (int state)
virtual vtkMRMLStorableNode *	GetStorableNode ()
vtkTimeStamp	GetStoredTime ()
virtual std::string	GetSupportedFileExtension (const char *fileName=nullptr, bool includeReadable=true, bool includeWriteable=true)
virtual vtkStringArray *	GetSupportedReadFileTypes ()
virtual vtkStringArray *	GetSupportedWriteFileTypes ()
virtual char *	GetTempFileName ()
virtual char *	GetURI ()
virtual vtkURIHandler *	GetURIHandler ()
virtual int	GetUseCompression ()
vtkMRMLMessageCollection *	GetUserMessages ()
const vtkMRMLMessageCollection *	GetUserMessages () const
virtual char *	GetWriteFileFormat ()
virtual int	GetWriteState ()
const char *	GetWriteStateAsString ()
void	InvalidateFile ()
int	IsFilePathRelative (const char *filepath)
void	PrintSelf (ostream &os, vtkIndent indent) override
void	ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData) override
	Propagate Progress Event generated in ReadData.
virtual int	ReadData (vtkMRMLNode *refNode, bool temporaryFile=false)
void	ReadXMLAttributes (const char **atts) override
	Read node attributes from XML file.
void	ResetFileNameList ()
	Clear the array of file names.
void	ResetNthFileName (int n, const char *fileName)
	Set the nth file in FileNameList, checks that it is already defined.
void	ResetNthURI (int n, const char *uri)
	Set the nth URI in URIList, checks that it is already defined.
void	ResetURIList ()
	Clear the array of URIs.
virtual void	SetCompressionParameter (std::string)
	Compression parameter that is used to save the node.
void	SetDataDirectory (const char *dataDirName)
	Set a new data directory for all files.
virtual void	SetDefaultWriteFileExtension (const char *ext)
virtual void	SetFileName (const char *)
virtual void	SetReadState (int)
void	SetReadStateCancelled ()
void	SetReadStateIdle ()
void	SetReadStatePending ()
void	SetReadStateScheduled ()
void	SetReadStateSkippedNoData ()
void	SetReadStateTransferDone ()
void	SetReadStateTransferring ()
virtual void	SetTempFileName (const char *)
	A temporary file name used to calculate absolute paths.
virtual void	SetURI (const char *)
	Location of the remote copy of this file.
virtual void	SetURIHandler (vtkURIHandler *uriHandler)
void	SetURIPrefix (const char *uriPrefix)
	Set a new URI base for all URI's.
virtual void	SetUseCompression (int)
virtual void	SetWriteFileFormat (const char *writeFileFormat)
void	SetWriteState (int writeState)
void	SetWriteStateCancelled ()
void	SetWriteStateIdle ()
void	SetWriteStatePending ()
void	SetWriteStateScheduled ()
void	SetWriteStateSkippedNoData ()
void	SetWriteStateTransferDone ()
void	SetWriteStateTransferring ()
virtual int	SupportedFileType (const char *fileName)
virtual void	UseCompressionOff ()
virtual void	UseCompressionOn ()
	Use compression on write.
virtual int	WriteData (vtkMRMLNode *refNode)
void	WriteXML (ostream &of, int indent) override
	Write this node's information to a MRML file in XML format.
Public Member Functions inherited from vtkMRMLNode
vtkMRMLNode *	AddAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr, ContentModifiedObserveType observeContentModifiedEvents=ContentModifiedObserveUndefined)
	Add and observe a reference node from this node for a specific referenceRole.
vtkMRMLNode *	AddNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
	Convenience method that adds a referencedNodeID at the end of the list.
void	AddNodeReferenceRole (const char *referenceRole, const char *mrmlAttributeName=nullptr, vtkIntArray *events=nullptr, bool observeContentModifiedEvents=false)
	Add a referenceRole.
virtual void	AddToSceneOff ()
virtual void	AddToSceneOn ()
void	ClearNodeReferenceProperties (const std::string &referenceRole)
	Remove all node reference properties for a specific referenceRole.
void	ClearNthNodeReferenceProperties (const std::string &referenceRole, int n)
virtual void	CopyContent (vtkMRMLNode *node, bool deepCopy=true)
	Copy node contents from another node of the same type. Does not copy node ID, Scene, Name, SingletonTag, HideFromEditors, AddToScene, UndoEnabled, and node references. If deepCopy is set to false then a shallow copy of bulk data (such as image or mesh data) could be made; copying may be faster but the node may share some data with the source node instead of creating an independent copy.
virtual void	CopyReferences (vtkMRMLNode *node)
	Copy the references of the node into this.
void	CopyWithScene (vtkMRMLNode *node)
	Copy everything (including Scene and ID) from another node of the same type.
void	DisableModifiedEventOff ()
void	DisableModifiedEventOn ()
virtual int	EndModify (int previousDisableModifiedEventState)
	End modifying the node.
virtual int	GetAddToScene ()
	node added to MRML scene.
const char *	GetAttribute (const char *name)
	Get value of a name value pair attribute.
std::vector< std::string >	GetAttributeNames ()
	Get all attribute names.
void	GetAttributeNames (vtkStringArray *attributeNames)
	Get all attribute names. Python-wrappable version.
virtual vtkIntArray *	GetContentModifiedEvents ()
int	GetCustomModifiedEventPending (int eventId)
virtual std::string	GetDefaultNodeNamePrefix ()
virtual char *	GetDescription ()
virtual int	GetDisableModifiedEvent ()
	Turn on/off generating InvokeEvent for set macros.
virtual int	GetHideFromEditors ()
	Describes if the node is hidden.
virtual char *	GetID ()
	ID use by other nodes to reference this node in XML.
virtual int	GetInMRMLCallbackFlag ()
	Flags to avoid event loops.
virtual int	GetModifiedEventPending ()
virtual char *	GetName ()
vtkMRMLNode *	GetNodeReference (const char *referenceRole)
const char *	GetNodeReferenceID (const char *referenceRole)
	Utility function that returns the first node id for a specific referenceRole.
void	GetNodeReferenceIDs (const char *referenceRole, std::vector< const char * > &referencedNodeIDs)
	Return a list of the referenced node IDs.
const ReferencePropertiesType *	GetNodeReferenceProperties (const char *referenceRole)
std::string	GetNodeReferenceProperty (const std::string &referenceRole, const std::string &propertyName)
	Get the node reference property for a specific referenceRole.
std::string	GetNodeReferencePropertyName (const std::string &referenceRole, int propertyIndex)
	Get the name of the Nth node reference property for a specific referenceRole.
std::vector< std::string >	GetNodeReferencePropertyNames (const std::string &referenceRole)
	Get the names of all node reference properties for a specific referenceRole.
void	GetNodeReferenceRoles (std::vector< std::string > &roles)
void	GetNodeReferences (const char *referenceRole, std::vector< vtkMRMLNode * > &nodes)
	Return a list of the referenced nodes.
vtkMRMLNode *	GetNthNodeReference (const char *referenceRole, int n)
	Get referenced MRML node for a specific referenceRole.
const char *	GetNthNodeReferenceID (const char *referenceRole, int n)
	Return the string of the Nth node ID for a specific reference role.
const ReferencePropertiesType *	GetNthNodeReferenceProperties (const char *referenceRole, int n)
std::string	GetNthNodeReferenceProperty (const std::string &referenceRole, int n, const std::string &propertyName)
std::string	GetNthNodeReferencePropertyName (const std::string &referenceRole, int referenceIndex, int propertyIndex)
std::vector< std::string >	GetNthNodeReferencePropertyNames (const std::string &referenceRole, int n)
const char *	GetNthNodeReferenceRole (int n)
int	GetNumberOfNodeReferenceProperties (const std::string &referenceRole)
	Get the number of node reference properties for a specific referenceRole.
int	GetNumberOfNodeReferenceRoles ()
int	GetNumberOfNodeReferences (const char *referenceRole)
	Return the number of node IDs for a specific reference role (and nodes as they always have the same size).
int	GetNumberOfNthNodeReferenceProperties (const std::string &referenceRole, int n)
virtual int	GetSaveWithScene ()
	Save node with MRML scene.
virtual vtkMRMLScene *	GetScene ()
	Get the scene this node has been added to.
virtual int	GetSelectable ()
	Describes if the node is selectable.
virtual int	GetSelected ()
	Get/Set for Selected.
virtual char *	GetSingletonTag ()
virtual bool	GetUndoEnabled ()
virtual bool	HasCopyContent () const
	Returns true if the class supports deep and shallow copying node content.
bool	HasNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
	Return true if referencedNodeID is in the node ID list for a specific referenceRole.
virtual void	HideFromEditorsOff ()
virtual void	HideFromEditorsOn ()
virtual void	InvokeCustomModifiedEvent (int eventId, void *callData=nullptr)
	This method allows the node to compress events.
virtual int	InvokePendingModifiedEvent ()
	Invokes any modified events that are pending.
bool	IsSingleton ()
void	Modified () override
	Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent.
virtual void	OnNodeAddedToScene ()
void	PrintSelf (ostream &os, vtkIndent indent) override
virtual void	ProcessChildNode (vtkMRMLNode *)
	Set dependencies between this node and a child node when parsing XML file.
void	RemoveAttribute (const char *name)
	Remove attribute with the specified name.
void	RemoveNodeReferenceIDs (const char *referenceRole)
	Remove all node IDs and associated nodes for a specific referenceRole.
void	RemoveNodeReferenceProperty (const std::string &referenceRole, const std::string &propertyName)
	Remove a node reference property for a specific referenceRole.
void	RemoveNthNodeReferenceID (const char *referenceRole, int n)
	Convenience method that removes the Nth node ID from the list.
void	RemoveNthNodeReferenceProperty (const std::string &referenceRole, int n, const std::string &propertyName)
virtual void	Reset (vtkMRMLNode *defaultNode)
	Reset node attributes to the initial state as defined in the constructor or the passed default node.
virtual void	SaveWithSceneOff ()
virtual void	SaveWithSceneOn ()
virtual void	SelectableOff ()
virtual void	SelectableOn ()
virtual void	SelectedOff ()
virtual void	SelectedOn ()
virtual void	SetAddToScene (int)
void	SetAddToSceneNoModify (int value)
vtkMRMLNode *	SetAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr, ContentModifiedObserveType observeContentModifiedEvents=ContentModifiedObserveUndefined)
	Set and observe a reference node from this node for a specific referenceRole.
vtkMRMLNode *	SetAndObserveNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID, vtkIntArray *events=nullptr, ContentModifiedObserveType observeContentModifiedEvents=ContentModifiedObserveUndefined)
	Set and observe the Nth node ID for a specific reference role.
void	SetAttribute (const char *name, const char *value)
	Set a name value pair attribute.
virtual void	SetDefaultNodeNamePrefix (const std::string &prefix)
virtual void	SetDescription (const char *)
	Text description of this node, to be set by the user.
void	SetDisableModifiedEvent (int onOff)
virtual void	SetHideFromEditors (int)
void	SetInMRMLCallbackFlag (int flag)
virtual void	SetName (const char *)
	Name of this node, to be set by the user.
vtkMRMLNode *	SetNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
	Set a reference to a node with specified nodeID from this node for a specific referenceRole.
void	SetNodeReferenceProperty (const std::string &referenceRole, const std::string &propertyName, const std::string &value)
	Set the node reference property for a specific referenceRole.
vtkMRMLNode *	SetNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID)
	Set a N-th reference from this node with specified referencedNodeID for a specific referenceRole.
void	SetNthNodeReferenceProperty (const std::string &referenceRole, int n, const std::string &propertyName, const std::string &value)
virtual void	SetSaveWithScene (int)
virtual void	SetScene (vtkMRMLScene *scene)
	This method is for internal use only. Use AddNode method of vtkMRMLScene to add a node to the scene.
virtual void	SetSceneReferences ()
	Update the references of the node to the scene.
virtual void	SetSelectable (int)
virtual void	SetSelected (int)
void	SetSingletonOff ()
void	SetSingletonOn ()
virtual void	SetSingletonTag (const char *)
	Tag that make this node a singleton in the scene.
virtual void	SetTypeDisplayName (const std::string &name)
virtual void	SetUndoEnabled (bool)
virtual int	StartModify ()
	Start modifying the node. Disable Modify events.
virtual void	UndoEnabledOff ()
virtual void	UndoEnabledOn ()
virtual void	UpdateReferenceID (const char *oldID, const char *newID)
	Update the stored reference to another node in the scene.
virtual void	UpdateReferences ()
	The method should remove all pointers and observations to all nodes that are not in the scene anymore.
virtual void	UpdateScene (vtkMRMLScene *)
const char *	URLDecodeString (const char *inString)
	Decode a URL string.
const char *	URLEncodeString (const char *inString)
	Encode a URL string.
virtual void	WriteNodeBodyXML (ostream &of, int indent)
	Write this node's body to a MRML file in XML format.
std::string	XMLAttributeDecodeString (const std::string &inString)
	Decode an XML attribute string.
std::string	XMLAttributeEncodeString (const std::string &inString)
	Encode an XML attribute string (replaces special characters by code sequences)

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkMRMLVolumeSequenceStorageNode *	New ()
static vtkMRMLVolumeSequenceStorageNode *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkMRMLStorageNode
static std::string	ClampFileName (const std::string &filename, int extensionLength, int maxFileNameLength, int hashLength=4)
static const char *	GetCoordinateSystemTypeAsString (int id)
	Convert between coordinate system ID and name.
static int	GetCoordinateSystemTypeFromString (const char *name)
static std::string	GetLowercaseExtensionFromFileName (const std::string &filename)
static int	IsTypeOf (const char *type)
static vtkMRMLStorageNode *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkMRMLNode
static int	IsTypeOf (const char *type)
static vtkMRMLNode *	SafeDownCast (vtkObject *o)

Protected Member Functions
void	InitializeSupportedReadFileTypes () override
	Initialize all the supported write file types.
void	InitializeSupportedWriteFileTypes () override
	Initialize all the supported write file types.
void	operator= (const vtkMRMLVolumeSequenceStorageNode &)
int	ReadDataInternal (vtkMRMLNode *refNode) override
	vtkMRMLVolumeSequenceStorageNode ()
	vtkMRMLVolumeSequenceStorageNode (const vtkMRMLVolumeSequenceStorageNode &)
	~vtkMRMLVolumeSequenceStorageNode () override
Protected Member Functions inherited from vtkMRMLStorageNode
void	operator= (const vtkMRMLStorageNode &)
void	StageReadData (vtkMRMLNode *refNode)
void	StageWriteData (vtkMRMLNode *refNode)
virtual void	UpdateCompressionPresets ()
	vtkMRMLStorageNode ()
	vtkMRMLStorageNode (const vtkMRMLStorageNode &)
	~vtkMRMLStorageNode () override
Protected Member Functions inherited from vtkMRMLNode
virtual const char *	GetMRMLAttributeNameFromReferenceRole (const char *refRole)
	Return the mrml attribute name (if found) associated with a reference role. Return 0 otherwise.
virtual const char *	GetReferenceRoleFromMRMLAttributeName (const char *attName)
	Return the reference role (if found) associated with the attribute name found in a MRML scene file. Return 0 otherwise.
virtual char *	GetTempURLString ()
void	GetUpdatedReferencedNodeEventList (int &oldReferencedNodeUseCount, int &newReferencedNodeUseCount, vtkIntArray *oldConsolidatedEventList, vtkIntArray *newConsolidatedEventList, vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkMRMLNodeReference *referenceToIgnore, vtkIntArray *newEvents, bool newObserveContentModifiedEvents)
virtual void	InvalidateNodeReferences ()
virtual bool	IsReferenceRoleGeneric (const char *refRole)
	Return true if the reference role is generic (ends with '/') or false otherwise.
std::string	NodeReferencePropertyDecodeString (const std::string &inString)
	Decode a node reference property string.
std::string	NodeReferencePropertyEncodeString (const std::string &inString)
	Encode a node reference property string (replaces special characters by code sequences)
virtual void	OnNodeReferenceAdded (vtkMRMLNodeReference *reference)
virtual void	OnNodeReferenceModified (vtkMRMLNodeReference *reference)
	Called when a referenced node pointer is modified.
virtual void	OnNodeReferenceRemoved (vtkMRMLNodeReference *reference)
	Called when a referenced node pointer is removed (set to nullptr).
void	operator= (const vtkMRMLNode &)
void	ParseReferencesAttribute (const char *attValue, std::set< std::string > &references)
void	RemoveInvalidReferences (const std::set< std::string > &validNodeIDs)
virtual void	SetTempURLString (const char *)
	Get/Set the string used to manage encoding/decoding of strings/URLs with special characters.
vtkMRMLNode *	UpdateNodeReferenceEventObserver (vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkIntArray *newEvents, bool newObserveContentModifiedEvents, vtkMRMLNodeReference *referenceToIgnore)
virtual void	UpdateNodeReferences (const char *referenceRole=nullptr)
virtual void	UpdateNthNodeReference (const char *referenceRole, int n)
	vtkMRMLNode ()
	vtkMRMLNode (const vtkMRMLNode &)
	~vtkMRMLNode () override
	critical to have a virtual destructor!

Additional Inherited Members
Protected Types inherited from vtkMRMLNode
typedef std::map< std::string, std::string >	AttributesType
typedef std::map< std::string, NodeReferenceEventList >	NodeReferenceEventsType
typedef std::vector< vtkSmartPointer< vtkMRMLNodeReference > >	NodeReferenceListType
typedef std::map< std::string, NodeReferenceListType >	NodeReferencesType
Static Protected Member Functions inherited from vtkMRMLNode
static void	MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
Protected Attributes inherited from vtkMRMLStorageNode
std::string	CompressionParameter
std::vector< CompressionPreset >	CompressionPresets
std::string	DefaultWriteFileExtension
	List of supported extensions to write in.
char *	FileName
std::vector< std::string >	FileNameList
	An array of file names, should contain the FileName but may not.
vtkWeakPointer< vtkMRMLStorableNode >	LastFoundStorableNode
int	ReadState
vtkTimeStamp *	StoredTime
vtkStringArray *	SupportedReadFileTypes
	List of supported extensions to read in.
vtkStringArray *	SupportedWriteFileTypes
char *	TempFileName
char *	URI
vtkURIHandler *	URIHandler
std::vector< std::string >	URIList
	An array of URI's, should contain the URI but may not.
int	UseCompression
vtkMRMLMessageCollection *	UserMessages
char *	WriteFileFormat
int	WriteState
Protected Attributes inherited from vtkMRMLNode
int	AddToScene { 1 }
AttributesType	Attributes
vtkIntArray *	ContentModifiedEvents
std::string	DefaultNodeNamePrefix
char *	Description { nullptr }
int	HideFromEditors { 0 }
char *	ID { nullptr }
int	InMRMLCallbackFlag { 0 }
	Flag to avoid event loops.
vtkCallbackCommand *	MRMLCallbackCommand
	Holders for MRML callbacks.
vtkObserverManager *	MRMLObserverManager
char *	Name { nullptr }
NodeReferenceEventsType	NodeReferenceEvents
std::map< std::string, std::string >	NodeReferenceMRMLAttributeNames
NodeReferencesType	NodeReferences
int	SaveWithScene { true }
vtkWeakPointer< vtkMRMLScene >	Scene
int	Selectable { 1 }
int	Selected { 0 }
std::string	TypeDisplayName
bool	UndoEnabled { false }

Detailed Description

Store a sequence of volumes in a NRRD file.

vtkMRMLVolumeSequenceStorageNode - MRML node that can read/write a Sequence node containing volumes in a single NRRD file.

The sequence axis is always the last image axis ("list" kind).. It can store vector (spatial or RGB/RGBA color) voxel in the first image axis (vector or RGB/RGBA kind). Altogether it can store 4D (xyzt) or 5D (cxyzt) data.

If the image stores spatial vectors then those vectors are written to the file in LPS coordinate system. A file stores spatial vectors if the component axis is "vector" kind and measurement frame is specified; or it is "covariant-vector" kind.

Custom fields store information on the sequence:

• DataNodeClassName: exact node type that the file should be read into (e.g., vtkMRMLScalarVolumeNode)
• axis 3 index type: numeric or text
• axis 3 index values: space-separated list of index values (URL-encoded, to deal with special characters)

Definition at line 48 of file vtkMRMLVolumeSequenceStorageNode.h.

Member Typedef Documentation

Superclass

typedef vtkMRMLStorageNode vtkMRMLVolumeSequenceStorageNode::Superclass

Definition at line 52 of file vtkMRMLVolumeSequenceStorageNode.h.

Constructor & Destructor Documentation

vtkMRMLVolumeSequenceStorageNode() [1/2]

vtkMRMLVolumeSequenceStorageNode::vtkMRMLVolumeSequenceStorageNode ( )

protected

~vtkMRMLVolumeSequenceStorageNode()

vtkMRMLVolumeSequenceStorageNode::~vtkMRMLVolumeSequenceStorageNode ( )

overrideprotected

vtkMRMLVolumeSequenceStorageNode() [2/2]

vtkMRMLVolumeSequenceStorageNode::vtkMRMLVolumeSequenceStorageNode ( const vtkMRMLVolumeSequenceStorageNode & )

protected

Member Function Documentation

CanReadInReferenceNode()

bool vtkMRMLVolumeSequenceStorageNode::CanReadInReferenceNode ( vtkMRMLNode * refNode )

overridevirtual

Return true if this class can read the node.

Implements vtkMRMLStorageNode.

CanWriteFromReferenceNode()

bool vtkMRMLVolumeSequenceStorageNode::CanWriteFromReferenceNode ( vtkMRMLNode * refNode )

overridevirtual

Return true if this class can write the node.

Reimplemented from vtkMRMLStorageNode.

CreateNodeInstance()

vtkMRMLNode * vtkMRMLVolumeSequenceStorageNode::CreateNodeInstance ( )

overridevirtual

Create instance of the default node. Like New only virtual.

Note

Subclasses should implement this method

Implements vtkMRMLStorageNode.

GetClassName()

virtual const char * vtkMRMLVolumeSequenceStorageNode::GetClassName ( )

virtual

Reimplemented from vtkMRMLStorageNode.

GetDefaultWriteFileExtension()

const char * vtkMRMLVolumeSequenceStorageNode::GetDefaultWriteFileExtension ( )

overridevirtual

Return a default file extension for writing.

Reimplemented from vtkMRMLStorageNode.

GetNodeTagName()

const char * vtkMRMLVolumeSequenceStorageNode::GetNodeTagName ( )

inlineoverridevirtual

Get node XML tag name (like Storage, Model)

Implements vtkMRMLStorageNode.

Definition at line 58 of file vtkMRMLVolumeSequenceStorageNode.h.

GetTypeDisplayName()

std::string vtkMRMLVolumeSequenceStorageNode::GetTypeDisplayName ( )

inlineoverridevirtual

Get node type to be displayed to the user.

Reimplemented from vtkMRMLNode.

Definition at line 61 of file vtkMRMLVolumeSequenceStorageNode.h.

InitializeSupportedReadFileTypes()

void vtkMRMLVolumeSequenceStorageNode::InitializeSupportedReadFileTypes ( )

overrideprotectedvirtual

Initialize all the supported write file types.

Reimplemented from vtkMRMLStorageNode.

InitializeSupportedWriteFileTypes()

void vtkMRMLVolumeSequenceStorageNode::InitializeSupportedWriteFileTypes ( )

overrideprotectedvirtual

Initialize all the supported write file types.

Reimplemented from vtkMRMLStorageNode.

IsA()

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

virtual

Reimplemented from vtkMRMLStorageNode.

IsTypeOf()

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

static

New()

static vtkMRMLVolumeSequenceStorageNode * vtkMRMLVolumeSequenceStorageNode::New ( )

static

operator=()

void vtkMRMLVolumeSequenceStorageNode::operator= ( const vtkMRMLVolumeSequenceStorageNode & )

protected

ReadDataInternal()

int vtkMRMLVolumeSequenceStorageNode::ReadDataInternal ( vtkMRMLNode * refNode )

overrideprotectedvirtual

Does the actual reading. Returns 1 on success, 0 otherwise. Returns 0 by default (read not supported). This implementation delegates most everything to the superclass but it has an early exit if the file to be read is incompatible.

It is assumed that the nrrd file is formatted such as: "kinds: [component] domain domain domain list"

Reimplemented from vtkMRMLStorageNode.

SafeDownCast()

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

static

WriteDataInternal()

int vtkMRMLVolumeSequenceStorageNode::WriteDataInternal ( vtkMRMLNode * refNode )

overridevirtual

Write the data. Returns 1 on success, 0 otherwise.

The nrrd file will be formatted such as: "kinds: [component] domain domain domain list"

Reimplemented from vtkMRMLStorageNode.

---

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

• Libs/MRML/Core/vtkMRMLVolumeSequenceStorageNode.h