MRML node for representing a volume (image stack). More...

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

Inheritance diagram for vtkMRMLVolumeNode:

[legend]

Collaboration diagram for vtkMRMLVolumeNode:

[legend]

Public Types
enum	{ ImageDataModifiedEvent = 18001 }
	ImageDataModifiedEvent is generated when image data is changed. More...

typedef vtkMRMLDisplayableNode	Superclass

Public Types inherited from vtkMRMLDisplayableNode
enum	{ DisplayModifiedEvent = 17000 }

typedef vtkMRMLTransformableNode	Superclass

Public Types inherited from vtkMRMLTransformableNode
enum	{ TransformModifiedEvent = 15000 }
	TransformModifiedEvent is send when the parent transform is modidied. More...

typedef vtkMRMLStorableNode	Superclass

Public Types inherited from vtkMRMLStorableNode
typedef vtkMRMLNode	Superclass

Public Types inherited from vtkMRMLNode
enum	{ HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent, ReferenceRemovedEvent, ReferencedNodeModifiedEvent }

typedef vtkObject	Superclass

Public Member Functions
virtual void	ApplyNonLinearTransform (vtkAbstractTransform *transform)

virtual void	ApplyTransform (vtkAbstractTransform *transform) VTK_OVERRIDE

virtual void	ApplyTransformMatrix (vtkMatrix4x4 *transformMatrix) VTK_OVERRIDE

virtual bool	CanApplyNonLinearTransforms () const VTK_OVERRIDE

virtual void	Copy (vtkMRMLNode *node) VTK_OVERRIDE
	Copy the node's attributes to this object More...

void	CopyOrientation (vtkMRMLVolumeNode *node)
	Copy the node's attributes to this object More...

virtual vtkMRMLNode *	CreateNodeInstance () VTK_OVERRIDE=0
	MRMLNode methods. More...

virtual void	GetBounds (double bounds[6]) VTK_OVERRIDE

virtual const char *	GetClassName ()

void	GetIJKToRASDirectionMatrix (vtkMatrix4x4 *mat)

void	GetIJKToRASDirections (double dirs[3][3])

void	GetIJKToRASMatrix (vtkMatrix4x4 *mat)

virtual double	GetImageBackgroundScalarComponentAsDouble (int component)

virtual vtkImageData *	GetImageData ()

virtual vtkAlgorithmOutput *	GetImageDataConnection ()
	Return the input image data pipeline. More...

void	GetIToRASDirection (double dirs[3])

void	GetJToRASDirection (double dirs[3])

void	GetKToRASDirection (double dirs[3])

double	GetMaxSpacing ()
	Utility function that returns the max spacing between the 3 orientations More...

const itk::MetaDataDictionary &	GetMetaDataDictionary () const

double	GetMinSpacing ()
	Utility function that returns the min spacing between the 3 orientations More...

virtual bool	GetModifiedSinceRead () VTK_OVERRIDE

virtual const char *	GetNodeTagName () VTK_OVERRIDE=0
	Get node XML tag name (like Volume, Model) More...

virtual double *	GetOrigin ()

virtual void	GetOrigin (double &, double &, double &)

virtual void	GetOrigin (double [3])

virtual void	GetRASBounds (double bounds[6]) VTK_OVERRIDE

void	GetRASToIJKMatrix (vtkMatrix4x4 *mat)

void	GetSliceBounds (double bounds[6], vtkMatrix4x4 *rasToSlice)

virtual void	GetSpacing (double &, double &, double &)

virtual double *	GetSpacing ()

virtual void	GetSpacing (double [3])

virtual vtkMRMLVolumeDisplayNode *	GetVolumeDisplayNode ()
	Associated display MRML node More...

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE

virtual void	ProcessMRMLEvents (vtkObject , unsigned long, void ) VTK_OVERRIDE
	alternative method to propagate events generated in Display nodes More...

virtual void	ReadXMLAttributes (const char **atts) VTK_OVERRIDE
	Read node attributes from XML file More...

virtual void	SetAndObserveImageData (vtkImageData *ImageData)

void	SetIJKToRASDirectionMatrix (vtkMatrix4x4 *mat)

void	SetIJKToRASDirections (double dirs[3][3])

void	SetIJKToRASDirections (double ir, double ia, double is, double jr, double ja, double js, double kr, double ka, double ks)

void	SetIJKToRASMatrix (vtkMatrix4x4 *mat)

virtual void	SetImageDataConnection (vtkAlgorithmOutput *inputPort)

void	SetIToRASDirection (double ir, double ia, double is)

void	SetJToRASDirection (double jr, double ja, double js)

void	SetKToRASDirection (double kr, double ka, double ks)

void	SetMetaDataDictionary (const itk::MetaDataDictionary &)
	Set/Get the ITK MetaDataDictionary More...

virtual void	SetOrigin (double arg1, double arg2, double arg3)

virtual void	SetOrigin (double arg[3])

void	SetRASToIJKMatrix (vtkMatrix4x4 *mat)

virtual void	SetSpacing (double arg1, double arg2, double arg3)

virtual void	SetSpacing (double arg[3])

void	ShiftImageDataExtentToZeroStart ()

virtual void	UpdateScene (vtkMRMLScene *scene) VTK_OVERRIDE
	Finds the storage node and read the data More...

virtual void	WriteXML (ostream &of, int indent) VTK_OVERRIDE
	Write this node's information to a MRML file in XML format. More...

Public Member Functions inherited from vtkMRMLDisplayableNode
void	AddAndObserveDisplayNodeID (const char *displayNodeID)

virtual void	CreateDefaultDisplayNodes ()

virtual int	GetDisplayClassVisibility (const char *nodeClass)

vtkMRMLDisplayNode *	GetDisplayNode ()

const char *	GetDisplayNodeID ()

virtual const char *	GetDisplayNodeReferenceRole ()

virtual int	GetDisplayVisibility ()

vtkMRMLDisplayNode *	GetNthDisplayNode (int n)

const char *	GetNthDisplayNodeID (int n)

int	GetNumberOfDisplayNodes ()

bool	HasDisplayNodeID (const char *displayNodeID)
	Return true if displayNodeID is in the display node ID list. More...

void	PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE

void	RemoveAllDisplayNodeIDs ()
	Remove all display node IDs and associated display nodes. More...

void	RemoveNthDisplayNodeID (int n)

void	SetAndObserveDisplayNodeID (const char *displayNodeID)

void	SetAndObserveNthDisplayNodeID (int n, const char *displayNodeID)

virtual void	SetDisplayClassVisibility (const char *nodeClass, int visible)

virtual void	SetDisplayVisibility (int visible)

virtual void	SetSelectable (int) VTK_OVERRIDE

virtual void	WriteCLI (std::vector< std::string > &vtkNotUsed(commandLine), std::string vtkNotUsed(prefix), int vtkNotUsed(coordinateSystemFlag)=0, int vtkNotUsed(multipleFlag)=1)

Public Member Functions inherited from vtkMRMLTransformableNode
vtkMRMLTransformNode *	GetParentTransformNode ()
	Associated transform MRML node More...

const char *	GetTransformNodeID ()
	Get referenced transform node id. More...

bool	HardenTransform ()

void	PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE

bool	SetAndObserveTransformNodeID (const char *transformNodeID)

virtual void	TransformPointFromWorld (const double inWorld[3], double outLocal[3])

virtual void	TransformPointFromWorld (const vtkVector3d &inWorld, vtkVector3d &outLocal)

virtual void	TransformPointToWorld (const double inLocal[3], double outWorld[3])

virtual void	TransformPointToWorld (const vtkVector3d &inLocal, vtkVector3d &outWorld)

Public Member Functions inherited from vtkMRMLStorableNode
void	AddAndObserveStorageNodeID (const char *storageNodeID)

virtual bool	AddDefaultStorageNode (const char *filename=NULL)

virtual vtkMRMLStorageNode *	CreateDefaultStorageNode ()

virtual std::string	GetDefaultStorageNodeClassName (const char *filename=NULL)

vtkMRMLStorageNode *	GetNthStorageNode (int n)
	Get associated display MRML node More...

const char *	GetNthStorageNodeID (int n)

int	GetNumberOfStorageNodes ()

const char *	GetSlicerDataType ()

vtkMRMLStorageNode *	GetStorageNode ()

const char *	GetStorageNodeID ()

virtual vtkTagTable *	GetUserTagTable ()
	Methods for user-specified metadata. More...

bool	HasStorageNodeID (const char *storageNodeID)
	Return true if storageNodeID is in the storage node ID list. More...

void	PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE

void	SetAndObserveNthStorageNodeID (int n, const char *storageNodeID)

void	SetAndObserveStorageNodeID (const char *storageNodeID)
	String ID of the storage MRML node More...

void	SetSlicerDataType (const char *type)

virtual void	StorableModified ()

Public Member Functions inherited from vtkMRMLNode
vtkMRMLNode *	AddAndObserveNodeReferenceID (const char referenceRole, const char referencedNodeID, vtkIntArray *events=0)
	Add and observe a reference node from this node for a specific referenceRole. More...

vtkMRMLNode *	AddNodeReferenceID (const char referenceRole, const char referencedNodeID)
	Convenience method that adds a referencedNodeID at the end of the list. More...

void	AddNodeReferenceRole (const char referenceRole, const char mrmlAttributeName=0, vtkIntArray *events=0)
	Add a referenceRole. More...

virtual void	AddToSceneOff ()

virtual void	AddToSceneOn ()

virtual void	CopyReferences (vtkMRMLNode *node)
	Copy the references of the node into this. More...

void	CopyWithoutModifiedEvent (vtkMRMLNode *node)

void	CopyWithScene (vtkMRMLNode *node)
	Copy everything (including Scene and ID) from another node of the same type. More...

void	CopyWithSceneWithSingleModifiedEvent (vtkMRMLNode *node)
	Copy everything (including Scene and ID) from another node of the same type. More...

void	CopyWithSingleModifiedEvent (vtkMRMLNode *node)

void	DisableModifiedEventOff ()

void	DisableModifiedEventOn ()

virtual int	EndModify (int previousDisableModifiedEventState)
	End modifying the node. More...

virtual int	GetAddToScene ()
	node added to MRML scene. More...

const char *	GetAttribute (const char *name)
	Get value of a name value pair attribute. More...

std::vector< std::string >	GetAttributeNames ()
	Get all attribute names. More...

void	GetAttributeNames (vtkStringArray *attributeNames)
	Get all attribute names. Python-wrappable version. More...

virtual char *	GetDescription ()

virtual int	GetDisableModifiedEvent ()
	Turn on/off generating InvokeEvent for set macros. More...

virtual int	GetHideFromEditors ()
	Describes if the node is hidden. More...

virtual char *	GetID ()
	ID use by other nodes to reference this node in XML. More...

virtual int	GetInMRMLCallbackFlag ()
	Flags to avoid event loops. More...

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

void	GetNodeReferenceIDs (const char referenceRole, std::vector< const char > &referencedNodeIDs)
	Return a list of the referenced node IDs. More...

void	GetNodeReferenceRoles (std::vector< std::string > &roles)

void	GetNodeReferences (const char referenceRole, std::vector< vtkMRMLNode > &nodes)
	Return a list of the referenced nodes. More...

vtkMRMLNode *	GetNthNodeReference (const char *referenceRole, int n)
	Get referenced MRML node for a specific referenceRole. More...

const char *	GetNthNodeReferenceID (const char *referenceRole, int n)
	Return the string of the Nth node ID for a specific reference role. More...

const char *	GetNthNodeReferenceRole (int n)

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). More...

virtual int	GetSaveWithScene ()
	Save node with MRML scene. More...

virtual vtkMRMLScene *	GetScene ()
	Only the scene can set itself to the node. More...

virtual int	GetSelectable ()
	Describes if the node is selectable. More...

virtual int	GetSelected ()
	Get/Set for Selected. More...

virtual char *	GetSingletonTag ()

bool	HasNodeReferenceID (const char referenceRole, const char referencedNodeID)
	Return true if referencedNodeID is in the node ID list for a specific referenceRole. More...

virtual void	HideFromEditorsOff ()

virtual void	HideFromEditorsOn ()

virtual void	InvokeCustomModifiedEvent (int eventId, void *callData=NULL)
	This method allows the node to compress events. More...

virtual int	InvokePendingModifiedEvent ()
	Invokes any modified events that are `pending`. More...

bool	IsSingleton ()

virtual void	Modified () VTK_OVERRIDE
	Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent. More...

virtual void	OnNodeAddedToScene ()

void	PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE

virtual void	ProcessChildNode (vtkMRMLNode *)
	Set dependencies between this node and a child node when parsing XML file. More...

void	RemoveAttribute (const char *name)
	Remove attribute with the specified name. More...

void	RemoveNodeReferenceIDs (const char *referenceRole)
	Remove all node IDs and associated nodes for a specific referenceRole. More...

void	RemoveNthNodeReferenceID (const char *referenceRole, int n)
	Convenience method that removes the Nth node ID from the list. More...

virtual void	Reset (vtkMRMLNode *defaultNode)
	Reset node attributes to the initial state as defined in the constructor or the passed default node. More...

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=0)
	Set and observe a reference node from this node for a specific referenceRole. More...

vtkMRMLNode *	SetAndObserveNthNodeReferenceID (const char referenceRole, int n, const char referencedNodeID, vtkIntArray *events=0)
	Set and observe the Nth node ID for a specific reference role. More...

void	SetAttribute (const char name, const char value)
	Set a name value pair attribute. More...

virtual void	SetDescription (const char *)
	Text description of this node, to be set by the user. More...

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

vtkMRMLNode *	SetNodeReferenceID (const char referenceRole, const char referencedNodeID)
	Set a reference to a node with specified nodeID from this node for a specific referenceRole. More...

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

virtual void	SetSaveWithScene (int)

virtual void	SetScene (vtkMRMLScene *scene)

virtual void	SetSceneReferences ()
	Update the references of the node to the scene. More...

virtual void	SetSelected (int)

void	SetSingletonOff ()

void	SetSingletonOn ()

virtual void	SetSingletonTag (const char *)
	Tag that make this node a singleton in the scene. More...

virtual int	StartModify ()
	Start modifying the node. Disable Modify events. More...

virtual void	UpdateReferenceID (const char oldID, const char newID)
	Update the stored reference to another node in the scene. More...

virtual void	UpdateReferences ()
	The method should remove all pointers and observations to all nodes that are not in the scene anymore. More...

const char *	URLDecodeString (const char *inString)
	Decode a URL string. More...

const char *	URLEncodeString (const char *inString)
	Encode a URL string. More...

virtual void	WriteNodeBodyXML (ostream &of, int indent)
	Write this node's body to a MRML file in XML format. More...

std::string	XMLAttributeDecodeString (const std::string &inString)
	Decode an XML attribute string. More...

std::string	XMLAttributeEncodeString (const std::string &inString)
	Encode an XML attribute string (replaces special characters by code sequences) More...

Static Public Member Functions
static bool	ComputeIJKToRASFromScanOrder (const char order, const double spacing, const int dims, bool centerImage, vtkMatrix4x4 IJKToRAS)
	RAS->IJK Matrix Calculation. More...

static const char *	ComputeScanOrderFromIJKToRAS (vtkMatrix4x4 *IJKToRAS)

static int	IsTypeOf (const char *type)

static vtkMRMLVolumeNode *	SafeDownCast (vtkObject *o)

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

static vtkMRMLDisplayableNode *	SafeDownCast (vtkObject *o)

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

static vtkMRMLTransformableNode *	SafeDownCast (vtkObject *o)

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

static vtkMRMLStorableNode *	SafeDownCast (vtkObject *o)

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

static vtkMRMLNode *	SafeDownCast (vtkObject *o)

Protected Member Functions
virtual void	GetBoundsInternal (double bounds[6], vtkMatrix4x4 *rasToSlice, bool useTransform)

virtual void	OnNodeReferenceAdded (vtkMRMLNodeReference *reference) VTK_OVERRIDE
	Called when a node reference ID is added (list size increased). More...

virtual void	OnNodeReferenceModified (vtkMRMLNodeReference *reference) VTK_OVERRIDE
	Called when a node reference ID is modified. More...

void	operator= (const vtkMRMLVolumeNode &)

void	SetImageDataToDisplayNode (vtkMRMLVolumeDisplayNode *displayNode)

void	SetImageDataToDisplayNodes ()
	Set the image data pipeline to all the display nodes. More...

virtual void	UpdateDisplayNodeImageData (vtkMRMLDisplayNode *dnode)

	vtkMRMLVolumeNode ()

	vtkMRMLVolumeNode (const vtkMRMLVolumeNode &)

	~vtkMRMLVolumeNode ()

Protected Member Functions inherited from vtkMRMLDisplayableNode
virtual const char *	GetDisplayNodeReferenceMRMLAttributeName ()

virtual void	OnNodeReferenceRemoved (vtkMRMLNodeReference *reference) VTK_OVERRIDE
	Called after a node reference ID is removed (list size decreased). More...

void	operator= (const vtkMRMLDisplayableNode &)

	vtkMRMLDisplayableNode ()

	vtkMRMLDisplayableNode (const vtkMRMLDisplayableNode &)

	~vtkMRMLDisplayableNode ()

Protected Member Functions inherited from vtkMRMLTransformableNode
virtual const char *	GetTransformNodeReferenceMRMLAttributeName ()

virtual const char *	GetTransformNodeReferenceRole ()

void	operator= (const vtkMRMLTransformableNode &)

	vtkMRMLTransformableNode ()

	vtkMRMLTransformableNode (const vtkMRMLTransformableNode &)

	~vtkMRMLTransformableNode ()

Protected Member Functions inherited from vtkMRMLStorableNode
virtual const char *	GetStorageNodeReferenceMRMLAttributeName ()

virtual const char *	GetStorageNodeReferenceRole ()

virtual vtkTimeStamp	GetStoredTime ()

void	operator= (const vtkMRMLStorableNode &)

	vtkMRMLStorableNode ()

	vtkMRMLStorableNode (const vtkMRMLStorableNode &)

	~vtkMRMLStorableNode ()

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

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

virtual char *	GetTempURLString ()

void	GetUpdatedReferencedNodeEventList (int &oldReferencedNodeUseCount, int &newReferencedNodeUseCount, vtkIntArray oldConsolidatedEventList, vtkIntArray newConsolidatedEventList, vtkMRMLNode oldReferencedNode, vtkMRMLNode newReferencedNode, vtkMRMLNodeReference referenceToIgnore, vtkIntArray newEvents)

virtual void	InvalidateNodeReferences ()

virtual bool	IsReferenceRoleGeneric (const char *refRole)
	Return true if the reference role is generic (ends with '/') or false otherwise. More...

void	operator= (const vtkMRMLNode &)

void	ParseReferencesAttribute (const char *attValue, std::map< std::string, std::string > &references)

virtual void	SetTempURLString (const char *)
	Get/Set the string used to manage encoding/decoding of strings/URLs with special characters. More...

vtkMRMLNode *	UpdateNodeReferenceEventObserver (vtkMRMLNode oldReferencedNode, vtkMRMLNode newReferencedNode, vtkIntArray newEvents, vtkMRMLNodeReference referenceToIgnore)

virtual void	UpdateNodeReferences (const char *referenceRole=NULL)

virtual void	UpdateNthNodeReference (const char *referenceRole, int n)

	vtkMRMLNode ()

	vtkMRMLNode (const vtkMRMLNode &)

virtual	~vtkMRMLNode ()
	critical to have a virtual destructor! More...

Protected Attributes
vtkEventForwarderCommand *	DataEventForwarder

itk::MetaDataDictionary	Dictionary

double	IJKToRASDirections [3][3]
	these are unit length direction cosines More...

vtkAlgorithmOutput *	ImageDataConnection

double	Origin [3]

double	Spacing [3]
	these are mappings to mm space More...

Protected Attributes inherited from vtkMRMLStorableNode
std::string	SlicerDataType

vtkTimeStamp	StorableModifiedTime

vtkTagTable *	UserTagTable

Protected Attributes inherited from vtkMRMLNode
int	AddToScene

AttributesType	Attributes

char *	Description

int	HideFromEditors

char *	ID

int	InMRMLCallbackFlag
	Flag to avoid event loops More...

vtkCallbackCommand *	MRMLCallbackCommand
	Holders for MRML callbacks. More...

vtkObserverManager *	MRMLObserverManager

char *	Name

NodeReferenceEventsType	NodeReferenceEvents

std::map< std::string, std::string >	NodeReferenceMRMLAttributeNames

NodeReferencesType	NodeReferences

int	SaveWithScene

vtkWeakPointer< vtkMRMLScene >	Scene

int	Selectable

int	Selected

Additional Inherited Members
Protected Types inherited from vtkMRMLNode
typedef std::map< std::string, std::string >	AttributesType

typedef std::map< std::string, vtkSmartPointer< vtkIntArray > >	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)

Static Protected Attributes inherited from vtkMRMLDisplayableNode
static const char *	DisplayNodeReferenceMRMLAttributeName

static const char *	DisplayNodeReferenceRole

Static Protected Attributes inherited from vtkMRMLTransformableNode
static const char *	TransformNodeReferenceMRMLAttributeName

static const char *	TransformNodeReferenceRole

Static Protected Attributes inherited from vtkMRMLStorableNode
static const char *	StorageNodeReferenceMRMLAttributeName

static const char *	StorageNodeReferenceRole

Detailed Description

MRML node for representing a volume (image stack).

Volume nodes describe data sets that can be thought of as stacks of 2D images that form a 3D volume. Volume nodes describe where the images are stored on disk, how to render the data (window and level), and how to read the files. This information is extracted from the image headers (if they exist) at the time the MRML file is generated. Consequently, MRML files isolate MRML browsers from understanding how to read the myriad of file formats for medical data.

Definition at line 40 of file vtkMRMLVolumeNode.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMRMLDisplayableNode vtkMRMLVolumeNode::Superclass

Definition at line 43 of file vtkMRMLVolumeNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

ImageDataModifiedEvent is generated when image data is changed.

Enumerator
ImageDataModifiedEvent

Definition at line 195 of file vtkMRMLVolumeNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLVolumeNode() [1/2]

vtkMRMLVolumeNode::vtkMRMLVolumeNode ( )

protected

◆ ~vtkMRMLVolumeNode()

vtkMRMLVolumeNode::~vtkMRMLVolumeNode ( )

protected

◆ vtkMRMLVolumeNode() [2/2]

vtkMRMLVolumeNode::vtkMRMLVolumeNode ( const vtkMRMLVolumeNode & )

protected

Member Function Documentation

◆ ApplyNonLinearTransform()

virtual void vtkMRMLVolumeNode::ApplyNonLinearTransform ( vtkAbstractTransform * transform )

virtual

◆ ApplyTransform()

virtual void vtkMRMLVolumeNode::ApplyTransform ( vtkAbstractTransform * transform )

virtual

Transforms the node with the provided non-linear transform.

See also: SetAndObserveTransformNodeID, ApplyTransformMatrix, CanApplyNonLinearTransforms

Reimplemented from vtkMRMLTransformableNode.

◆ ApplyTransformMatrix()

virtual void vtkMRMLVolumeNode::ApplyTransformMatrix ( vtkMatrix4x4 * transformMatrix )

virtual

Convenience function to allow transforming a node by specifying a transformation matrix.

See also: ApplyTransformMatrix, ApplyTransform

Reimplemented from vtkMRMLTransformableNode.

◆ CanApplyNonLinearTransforms()

virtual bool vtkMRMLVolumeNode::CanApplyNonLinearTransforms ( ) const

virtual

Returns true if the transformable node can apply non-linear transforms. A transformable node is always expected to apply linear transforms.

See also: ApplyTransformMatrix, ApplyTransform

Reimplemented from vtkMRMLTransformableNode.

◆ ComputeIJKToRASFromScanOrder()

static bool vtkMRMLVolumeNode::ComputeIJKToRASFromScanOrder	(	const char *	order,
		const double *	spacing,
		const int *	dims,
		bool	centerImage,
		vtkMatrix4x4 *	IJKToRAS
	)

static

RAS->IJK Matrix Calculation.

The order of slices in the volume. One of: LR (left-to-right), RL, AP, PA, IS, SI. This information is encoded in the rasToIJKMatrix. This matrix can be computed either from corner points, or just he scanOrder. Return true on success, false otherwise

◆ ComputeScanOrderFromIJKToRAS()

static const char* vtkMRMLVolumeNode::ComputeScanOrderFromIJKToRAS ( vtkMatrix4x4 * IJKToRAS )

static

◆ Copy()

virtual void vtkMRMLVolumeNode::Copy ( vtkMRMLNode * node )

virtual

Copy the node's attributes to this object

Reimplemented from vtkMRMLDisplayableNode.

Reimplemented in vtkMRMLStreamingVolumeNode, vtkMRMLDiffusionWeightedVolumeNode, vtkMRMLScalarVolumeNode, vtkMRMLTensorVolumeNode, vtkMRMLDiffusionImageVolumeNode, and vtkMRMLVectorVolumeNode.

◆ CopyOrientation()

void vtkMRMLVolumeNode::CopyOrientation ( vtkMRMLVolumeNode * node )

Copy the node's attributes to this object

◆ CreateNodeInstance()

virtual vtkMRMLNode* vtkMRMLVolumeNode::CreateNodeInstance ( )

pure virtual

MRMLNode methods.

Implements vtkMRMLDisplayableNode.

Implemented in vtkMRMLStreamingVolumeNode, vtkMRMLLabelMapVolumeNode, vtkMRMLDiffusionWeightedVolumeNode, vtkMRMLScalarVolumeNode, vtkMRMLTensorVolumeNode, vtkMRMLDiffusionTensorVolumeNode, vtkMRMLDiffusionImageVolumeNode, and vtkMRMLVectorVolumeNode.

◆ GetBounds()

virtual void vtkMRMLVolumeNode::GetBounds ( double bounds[6] )

virtual

Get bounding box in global RAS form (xmin,xmax, ymin,ymax, zmin,zmax). This method always returns the bounds of the untransformed object.

See also: GetRASBounds()

Reimplemented from vtkMRMLDisplayableNode.

◆ GetBoundsInternal()

virtual void vtkMRMLVolumeNode::GetBoundsInternal	(	double	bounds[6],
		vtkMatrix4x4 *	rasToSlice,
		bool	useTransform
	)

protectedvirtual

Return the bounds of the node transformed or not depending on the useTransform parameter and the rasToSlice transform

◆ GetClassName()

virtual const char* vtkMRMLVolumeNode::GetClassName ( )

virtual

Reimplemented from vtkMRMLDisplayableNode.

Reimplemented in vtkMRMLStreamingVolumeNode, vtkMRMLLabelMapVolumeNode, vtkMRMLDiffusionWeightedVolumeNode, vtkMRMLScalarVolumeNode, vtkMRMLTensorVolumeNode, vtkMRMLDiffusionTensorVolumeNode, vtkMRMLDiffusionImageVolumeNode, and vtkMRMLVectorVolumeNode.

◆ GetIJKToRASDirectionMatrix()

void vtkMRMLVolumeNode::GetIJKToRASDirectionMatrix ( vtkMatrix4x4 * mat )

◆ GetIJKToRASDirections()

void vtkMRMLVolumeNode::GetIJKToRASDirections ( double dirs[3][3] )

◆ GetIJKToRASMatrix()

void vtkMRMLVolumeNode::GetIJKToRASMatrix ( vtkMatrix4x4 * mat )

Get the IJKToRAS Matrix that includes the spacing and origin information (assumes the image data is Origin 0 0 0 and Spacing 1 1 1) RASToIJK is the inverse of this

◆ GetImageBackgroundScalarComponentAsDouble()

virtual double vtkMRMLVolumeNode::GetImageBackgroundScalarComponentAsDouble ( int component )

virtual

Get background voxel value of the image. It can be used for assigning intensity value to "empty" voxels when the image is transformed. It is computed as median value of the 8 corner voxels.

◆ GetImageData()

virtual vtkImageData* vtkMRMLVolumeNode::GetImageData ( )

virtual

Reimplemented in vtkMRMLStreamingVolumeNode.

◆ GetImageDataConnection()

virtual vtkAlgorithmOutput* vtkMRMLVolumeNode::GetImageDataConnection ( )

virtual

Return the input image data pipeline.

Reimplemented in vtkMRMLStreamingVolumeNode.

◆ GetIToRASDirection()

void vtkMRMLVolumeNode::GetIToRASDirection ( double dirs[3] )

◆ GetJToRASDirection()

void vtkMRMLVolumeNode::GetJToRASDirection ( double dirs[3] )

◆ GetKToRASDirection()

void vtkMRMLVolumeNode::GetKToRASDirection ( double dirs[3] )

◆ GetMaxSpacing()

double vtkMRMLVolumeNode::GetMaxSpacing ( )

Utility function that returns the max spacing between the 3 orientations

◆ GetMetaDataDictionary()

const itk::MetaDataDictionary& vtkMRMLVolumeNode::GetMetaDataDictionary ( ) const

◆ GetMinSpacing()

double vtkMRMLVolumeNode::GetMinSpacing ( )

Utility function that returns the min spacing between the 3 orientations

◆ GetModifiedSinceRead()

virtual bool vtkMRMLVolumeNode::GetModifiedSinceRead ( )

virtual

Returns true if the node is more recent than the file on disk. This information can be used by the application to know which node has been modified since it has been last read or written. Only storable properties are considered: even if a "non storable" property (e.g. color of a mesh) is modified after the node is being loaded, GetModifiedSinceRead() should return false; the new property value won't be stored on file (only in the MRML scene). By default, calling Modified() on the node doesn't make the node "modified since read", only calling Modified() on StorableModifiedTime does. GetModifiedSinceRead() can be overwritten to handle special storable property modification time.

See also: GetStoredTime() StorableModifiedTime Modified() StorableModified()

Reimplemented from vtkMRMLStorableNode.

◆ GetNodeTagName()

virtual const char* vtkMRMLVolumeNode::GetNodeTagName ( )

pure virtual

Get node XML tag name (like Volume, Model)

Implements vtkMRMLDisplayableNode.

Implemented in vtkMRMLStreamingVolumeNode, vtkMRMLDiffusionWeightedVolumeNode, vtkMRMLScalarVolumeNode, vtkMRMLTensorVolumeNode, vtkMRMLDiffusionImageVolumeNode, vtkMRMLVectorVolumeNode, vtkMRMLLabelMapVolumeNode, and vtkMRMLDiffusionTensorVolumeNode.

◆ GetOrigin() [1/3]

virtual double* vtkMRMLVolumeNode::GetOrigin ( )

virtual

◆ GetOrigin() [2/3]

virtual void vtkMRMLVolumeNode::GetOrigin	(	double &	,
		double &	,
		double &
	)

virtual

◆ GetOrigin() [3/3]

virtual void vtkMRMLVolumeNode::GetOrigin ( double [3] )

virtual

◆ GetRASBounds()

virtual void vtkMRMLVolumeNode::GetRASBounds ( double bounds[6] )

virtual

Get bounding box in global RAS form (xmin,xmax, ymin,ymax, zmin,zmax). This method returns the bounds of the object with any transforms that may be applied to it.

See also: GetSliceBounds(), GetIJKToRASMatrix(), vtkMRMLSliceLogic::GetVolumeSliceBounds(); GetNodeBounds()

Reimplemented from vtkMRMLDisplayableNode.

◆ GetRASToIJKMatrix()

void vtkMRMLVolumeNode::GetRASToIJKMatrix ( vtkMatrix4x4 * mat )

◆ GetSliceBounds()

void vtkMRMLVolumeNode::GetSliceBounds	(	double	bounds[6],
		vtkMatrix4x4 *	rasToSlice
	)

Get bounding box in slice form (xmin,xmax, ymin,ymax, zmin,zmax). If not rasToSlice is passed, then it returns the bounds in global RAS form.

See also: GetRASBounds()

◆ GetSpacing() [1/3]

virtual double* vtkMRMLVolumeNode::GetSpacing ( )

virtual

Spacing and Origin, with the Directions, are the independent parameters that go to make up the IJKToRAS matrix In setter methods, StorableModifiedTime may need to be updated, which cannot be achieved by using vtkGetVector3Macro.

◆ GetSpacing() [2/3]

virtual void vtkMRMLVolumeNode::GetSpacing	(	double &	,
		double &	,
		double &
	)

virtual

◆ GetSpacing() [3/3]

virtual void vtkMRMLVolumeNode::GetSpacing ( double [3] )

virtual

◆ GetVolumeDisplayNode()

virtual vtkMRMLVolumeDisplayNode* vtkMRMLVolumeNode::GetVolumeDisplayNode ( )

virtual

Associated display MRML node

◆ IsA()

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

virtual

Reimplemented from vtkMRMLDisplayableNode.

Reimplemented in vtkMRMLStreamingVolumeNode, vtkMRMLLabelMapVolumeNode, vtkMRMLDiffusionWeightedVolumeNode, vtkMRMLScalarVolumeNode, vtkMRMLTensorVolumeNode, vtkMRMLDiffusionTensorVolumeNode, vtkMRMLDiffusionImageVolumeNode, and vtkMRMLVectorVolumeNode.

◆ IsTypeOf()

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

static

◆ OnNodeReferenceAdded()

virtual void vtkMRMLVolumeNode::OnNodeReferenceAdded ( vtkMRMLNodeReference * reference )

protectedvirtual

Called when a node reference ID is added (list size increased).

Reimplemented from vtkMRMLDisplayableNode.

◆ OnNodeReferenceModified()

virtual void vtkMRMLVolumeNode::OnNodeReferenceModified ( vtkMRMLNodeReference * reference )

protectedvirtual

Called when a node reference ID is modified.

Reimplemented from vtkMRMLDisplayableNode.

◆ operator=()

void vtkMRMLVolumeNode::operator= ( const vtkMRMLVolumeNode & )

protected

◆ PrintSelf()

void vtkMRMLVolumeNode::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

◆ ProcessMRMLEvents()

virtual void vtkMRMLVolumeNode::ProcessMRMLEvents	(	vtkObject *	,
		unsigned	long,
		void *
	)

virtual

alternative method to propagate events generated in Display nodes

Reimplemented from vtkMRMLDisplayableNode.

Reimplemented in vtkMRMLDiffusionImageVolumeNode, and vtkMRMLStreamingVolumeNode.

◆ ReadXMLAttributes()

virtual void vtkMRMLVolumeNode::ReadXMLAttributes ( const char ** atts )

virtual

Read node attributes from XML file

Reimplemented from vtkMRMLDisplayableNode.

Reimplemented in vtkMRMLStreamingVolumeNode, vtkMRMLDiffusionWeightedVolumeNode, vtkMRMLScalarVolumeNode, vtkMRMLTensorVolumeNode, vtkMRMLDiffusionImageVolumeNode, and vtkMRMLVectorVolumeNode.

◆ SafeDownCast()

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

static

◆ SetAndObserveImageData()

virtual void vtkMRMLVolumeNode::SetAndObserveImageData ( vtkImageData * ImageData )

virtual

In the ImageData object origin must be set to (0,0,0) and spacing must be set to (1,1,1). If the variables are set to different values then the application's behavior is undefined. The reason for not using origin and spacing in vtkImageData is that vtkImageData cannot store image orientation, and so it cannot store all the information that is necessary to compute the mapping between voxel (IJK) and physical (RAS) coordinate systems. Instead of storing some information in vtkImageData and some outside, the decision was made to store all information in the MRML node (vtkMRMLVolumeNode::Origin, vtkMRMLVolumeNode::Spacing, and vtkMRMLVolumeNode::IJKToRASDirections).

See also: GetImageData(), SetImageDataConnection()

Reimplemented in vtkMRMLStreamingVolumeNode.

◆ SetIJKToRASDirectionMatrix()

void vtkMRMLVolumeNode::SetIJKToRASDirectionMatrix ( vtkMatrix4x4 * mat )

◆ SetIJKToRASDirections() [1/2]

void vtkMRMLVolumeNode::SetIJKToRASDirections ( double dirs[3][3] )

◆ SetIJKToRASDirections() [2/2]

void vtkMRMLVolumeNode::SetIJKToRASDirections	(	double	ir,
		double	ia,
		double	is,
		double	jr,
		double	ja,
		double	js,
		double	kr,
		double	ka,
		double	ks
	)

◆ SetIJKToRASMatrix()

void vtkMRMLVolumeNode::SetIJKToRASMatrix ( vtkMatrix4x4 * mat )

Convenience methods to set the directions, spacing, and origin from a matrix

◆ SetImageDataConnection()

virtual void vtkMRMLVolumeNode::SetImageDataConnection ( vtkAlgorithmOutput * inputPort )

virtual

Set and observe image data pipeline. It is propagated to the display nodes.

See also: GetImageDataConnection()

◆ SetImageDataToDisplayNode()

void vtkMRMLVolumeNode::SetImageDataToDisplayNode ( vtkMRMLVolumeDisplayNode * displayNode )

protected

◆ SetImageDataToDisplayNodes()

void vtkMRMLVolumeNode::SetImageDataToDisplayNodes ( )

protected

Set the image data pipeline to all the display nodes.

◆ SetIToRASDirection()

void vtkMRMLVolumeNode::SetIToRASDirection	(	double	ir,
		double	ia,
		double	is
	)

◆ SetJToRASDirection()

void vtkMRMLVolumeNode::SetJToRASDirection	(	double	jr,
		double	ja,
		double	js
	)

◆ SetKToRASDirection()

void vtkMRMLVolumeNode::SetKToRASDirection	(	double	kr,
		double	ka,
		double	ks
	)

◆ SetMetaDataDictionary()

void vtkMRMLVolumeNode::SetMetaDataDictionary ( const itk::MetaDataDictionary & )

Set/Get the ITK MetaDataDictionary

◆ SetOrigin() [1/2]

virtual void vtkMRMLVolumeNode::SetOrigin	(	double	arg1,
		double	arg2,
		double	arg3
	)

virtual

◆ SetOrigin() [2/2]

virtual void vtkMRMLVolumeNode::SetOrigin ( double arg[3] )

virtual

◆ SetRASToIJKMatrix()

void vtkMRMLVolumeNode::SetRASToIJKMatrix ( vtkMatrix4x4 * mat )

◆ SetSpacing() [1/2]

virtual void vtkMRMLVolumeNode::SetSpacing	(	double	arg1,
		double	arg2,
		double	arg3
	)

virtual

◆ SetSpacing() [2/2]

virtual void vtkMRMLVolumeNode::SetSpacing ( double arg[3] )

virtual

◆ ShiftImageDataExtentToZeroStart()

void vtkMRMLVolumeNode::ShiftImageDataExtentToZeroStart ( )

Make sure image data of a volume node has extents that start at zero. This needs to be done for compatibility reasons, as many components assume the extent has a form of (0,dim[0],0,dim[1],0,dim[2]), which is not the case many times for segmentation merged labelmaps.

◆ UpdateDisplayNodeImageData()

virtual void vtkMRMLVolumeNode::UpdateDisplayNodeImageData ( vtkMRMLDisplayNode * dnode )

protectedvirtual

Called when a display node is added/removed/modified. Propagate the polydata to the new display node.

◆ UpdateScene()

virtual void vtkMRMLVolumeNode::UpdateScene ( vtkMRMLScene * scene )

virtual

Finds the storage node and read the data

Reimplemented from vtkMRMLStorableNode.

◆ WriteXML()

virtual void vtkMRMLVolumeNode::WriteXML	(	ostream &	of,
		int	indent
	)

virtual

Write this node's information to a MRML file in XML format.

Reimplemented from vtkMRMLDisplayableNode.

Reimplemented in vtkMRMLStreamingVolumeNode, vtkMRMLDiffusionWeightedVolumeNode, vtkMRMLScalarVolumeNode, vtkMRMLTensorVolumeNode, vtkMRMLDiffusionImageVolumeNode, and vtkMRMLVectorVolumeNode.

Member Data Documentation

◆ DataEventForwarder

vtkEventForwarderCommand* vtkMRMLVolumeNode::DataEventForwarder

protected

Definition at line 256 of file vtkMRMLVolumeNode.h.

◆ Dictionary

itk::MetaDataDictionary vtkMRMLVolumeNode::Dictionary

protected

Definition at line 258 of file vtkMRMLVolumeNode.h.

◆ IJKToRASDirections

double vtkMRMLVolumeNode::IJKToRASDirections[3][3]

protected

these are unit length direction cosines

Definition at line 249 of file vtkMRMLVolumeNode.h.

◆ ImageDataConnection

vtkAlgorithmOutput* vtkMRMLVolumeNode::ImageDataConnection

protected

Definition at line 255 of file vtkMRMLVolumeNode.h.

◆ Origin

double vtkMRMLVolumeNode::Origin[3]

protected

Definition at line 253 of file vtkMRMLVolumeNode.h.

◆ Spacing

double vtkMRMLVolumeNode::Spacing[3]

protected

these are mappings to mm space

Definition at line 252 of file vtkMRMLVolumeNode.h.

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

Libs/MRML/Core/vtkMRMLVolumeNode.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkMRMLVolumeNode() [1/2]

◆ ~vtkMRMLVolumeNode()

◆ vtkMRMLVolumeNode() [2/2]

Member Function Documentation

◆ ApplyNonLinearTransform()

◆ ApplyTransform()

◆ ApplyTransformMatrix()

◆ CanApplyNonLinearTransforms()

◆ ComputeIJKToRASFromScanOrder()

◆ ComputeScanOrderFromIJKToRAS()

◆ Copy()

◆ CopyOrientation()

◆ CreateNodeInstance()

◆ GetBounds()

◆ GetBoundsInternal()

◆ GetClassName()

◆ GetIJKToRASDirectionMatrix()

◆ GetIJKToRASDirections()

◆ GetIJKToRASMatrix()

◆ GetImageBackgroundScalarComponentAsDouble()

◆ GetImageData()

◆ GetImageDataConnection()

◆ GetIToRASDirection()

◆ GetJToRASDirection()

◆ GetKToRASDirection()

◆ GetMaxSpacing()

◆ GetMetaDataDictionary()

◆ GetMinSpacing()

◆ GetModifiedSinceRead()

◆ GetNodeTagName()

◆ GetOrigin() [1/3]

◆ GetOrigin() [2/3]

◆ GetOrigin() [3/3]

◆ GetRASBounds()

◆ GetRASToIJKMatrix()

◆ GetSliceBounds()

◆ GetSpacing() [1/3]

◆ GetSpacing() [2/3]

◆ GetSpacing() [3/3]

◆ GetVolumeDisplayNode()

◆ IsA()

◆ IsTypeOf()

◆ OnNodeReferenceAdded()

◆ OnNodeReferenceModified()

◆ operator=()

◆ PrintSelf()

◆ ProcessMRMLEvents()

◆ ReadXMLAttributes()

◆ SafeDownCast()

◆ SetAndObserveImageData()

◆ SetIJKToRASDirectionMatrix()

◆ SetIJKToRASDirections() [1/2]

◆ SetIJKToRASDirections() [2/2]

◆ SetIJKToRASMatrix()

◆ SetImageDataConnection()

◆ SetImageDataToDisplayNode()

◆ SetImageDataToDisplayNodes()

◆ SetIToRASDirection()

◆ SetJToRASDirection()

◆ SetKToRASDirection()

◆ SetMetaDataDictionary()

◆ SetOrigin() [1/2]

◆ SetOrigin() [2/2]

◆ SetRASToIJKMatrix()

◆ SetSpacing() [1/2]

◆ SetSpacing() [2/2]

◆ ShiftImageDataExtentToZeroStart()

◆ UpdateDisplayNodeImageData()