vtkMRMLSliceCompositeNode Class Reference

#include <vtkMRMLSliceCompositeNode.h>

Inheritance diagram for vtkMRMLSliceCompositeNode:

Public Types
enum	{ XYZ = 0, IJK, RAS, IJKAndRAS }
	Modes for annotation space and mode. More...
enum	{ NoAnnotation = 0, All, LabelValuesOnly, LabelAndVoxelValuesOnly }
enum	{ Alpha = 0, ReverseAlpha, Add, Subtract }
	Modes for compositing. More...
Public Member Functions
virtual void	Copy (vtkMRMLNode *node)
virtual vtkMRMLNode *	CreateNodeInstance ()
char *	GetLayoutName ()
virtual const char *	GetNodeTagName ()
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	ReadXMLAttributes (const char **atts)
void	SetLayoutName (const char *layoutName)
void	SetReferenceBackgroundVolumeID (const char *id)
void	SetReferenceForegroundVolumeID (const char *id)
void	SetReferenceLabelVolumeID (const char *id)
virtual void	UpdateReferenceID (const char oldID, const char newID)
virtual void	UpdateReferences ()
virtual void	UpdateScene (vtkMRMLScene *)
	vtkGetMacro (DoPropagateVolumeSelection, bool)
	vtkGetMacro (AnnotationMode, int)
	vtkGetMacro (AnnotationSpace, int)
	vtkGetMacro (SliceIntersectionVisibility, int)
	vtkGetMacro (FiducialLabelVisibility, int)
	vtkGetMacro (FiducialVisibility, int)
	vtkGetMacro (LabelGrid, int)
	vtkGetMacro (BackgroundGrid, int)
	vtkGetMacro (ForegroundGrid, int)
	vtkGetMacro (LinkedControl, int)
	vtkGetMacro (LabelOpacity, double)
	vtkGetMacro (ForegroundOpacity, double)
	vtkGetMacro (Compositing, int)
	vtkGetStringMacro (LabelVolumeID)
	vtkGetStringMacro (ForegroundVolumeID)
	vtkGetStringMacro (BackgroundVolumeID)
	vtkSetMacro (DoPropagateVolumeSelection, bool)
	vtkSetMacro (AnnotationMode, int)
	vtkSetMacro (AnnotationSpace, int)
	vtkSetMacro (SliceIntersectionVisibility, int)
	vtkSetMacro (FiducialLabelVisibility, int)
	vtkSetMacro (FiducialVisibility, int)
	vtkSetMacro (LabelGrid, int)
	vtkSetMacro (BackgroundGrid, int)
	vtkSetMacro (ForegroundGrid, int)
	vtkSetMacro (LinkedControl, int)
	vtkSetMacro (LabelOpacity, double)
	vtkSetMacro (ForegroundOpacity, double)
	vtkSetMacro (Compositing, int)
	vtkSetReferenceStringMacro (LabelVolumeID)
	vtkSetReferenceStringMacro (ForegroundVolumeID)
	vtkSetReferenceStringMacro (BackgroundVolumeID)
	vtkTypeMacro (vtkMRMLSliceCompositeNode, vtkMRMLNode)
virtual void	WriteXML (ostream &of, int indent)
Static Public Member Functions
static vtkMRMLSliceCompositeNode *	New ()
Protected Member Functions
void	operator= (const vtkMRMLSliceCompositeNode &)
	vtkMRMLSliceCompositeNode (const vtkMRMLSliceCompositeNode &)
	vtkMRMLSliceCompositeNode ()
	~vtkMRMLSliceCompositeNode ()
Protected Attributes
int	AnnotationMode
int	AnnotationSpace
int	BackgroundGrid
char *	BackgroundVolumeID
int	Compositing
bool	DoPropagateVolumeSelection
int	FiducialLabelVisibility
int	FiducialVisibility
int	ForegroundGrid
double	ForegroundOpacity
char *	ForegroundVolumeID
int	LabelGrid
double	LabelOpacity
char *	LabelVolumeID
int	LinkedControl
int	SliceIntersectionVisibility

Detailed Description

vtkMRMLSliceCompositeNode - MRML node for storing a slice through RAS space

This node stores the information about how to composite two vtkMRMLVolumes into a single display image

Member Enumeration Documentation

anonymous enum

Modes for annotation space and mode.

Enumerator:

XYZ
IJK
RAS
IJKAndRAS

anonymous enum

Enumerator:

NoAnnotation
All
LabelValuesOnly
LabelAndVoxelValuesOnly

anonymous enum

Modes for compositing.

Enumerator:

Alpha
ReverseAlpha
Add
Subtract

Constructor & Destructor Documentation

vtkMRMLSliceCompositeNode::vtkMRMLSliceCompositeNode ( ) [protected]

References All, AnnotationMode, AnnotationSpace, BackgroundGrid, BackgroundVolumeID, Compositing, DoPropagateVolumeSelection, FiducialLabelVisibility, FiducialVisibility, ForegroundGrid, ForegroundOpacity, ForegroundVolumeID, IJKAndRAS, LabelGrid, LabelOpacity, LabelVolumeID, LinkedControl, and SliceIntersectionVisibility.

vtkMRMLSliceCompositeNode::~vtkMRMLSliceCompositeNode ( ) [protected]

References BackgroundVolumeID, ForegroundVolumeID, and LabelVolumeID.

vtkMRMLSliceCompositeNode::vtkMRMLSliceCompositeNode ( const vtkMRMLSliceCompositeNode & ) [protected]

Member Function Documentation

void vtkMRMLSliceCompositeNode::Copy ( vtkMRMLNode * node ) [virtual]

Copy the node's attributes to this object

References vtkMRMLNode::EndModify(), and vtkMRMLNode::StartModify().

vtkMRMLNode * vtkMRMLSliceCompositeNode::CreateNodeInstance ( ) [virtual]

Create instance of the default node. Like New only virtual NOTE: Subclasses should implement this method

Implements vtkMRMLNode.

References autoSlicerTracto2regions::ret.

char* vtkMRMLSliceCompositeNode::GetLayoutName ( ) [inline]

Referenced by UpdateScene(), vtkSlicerSliceLogic::UpdateSliceCompositeNode(), and WriteXML().

virtual const char* vtkMRMLSliceCompositeNode::GetNodeTagName ( ) [inline, virtual]

Get node XML tag name (like Volume, Model)

Implements vtkMRMLNode.

vtkMRMLSliceCompositeNode * vtkMRMLSliceCompositeNode::New ( ) [static]

Reimplemented from vtkMRMLNode.

References autoSlicerTracto2regions::ret.

void vtkMRMLSliceCompositeNode::operator= ( const vtkMRMLSliceCompositeNode & ) [protected]

Reimplemented from vtkMRMLNode.

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

Reimplemented from vtkMRMLNode.

References AnnotationMode, AnnotationSpace, BackgroundGrid, BackgroundVolumeID, Compositing, DoPropagateVolumeSelection, FiducialLabelVisibility, FiducialVisibility, ForegroundGrid, ForegroundOpacity, ForegroundVolumeID, LabelGrid, LabelOpacity, LabelVolumeID, LinkedControl, and SliceIntersectionVisibility.

Referenced by vtkSlicerSliceLogic::PrintSelf().

void vtkMRMLSliceCompositeNode::ReadXMLAttributes ( const char ** atts ) [virtual]

Set node attributes

Reimplemented from vtkMRMLNode.

References All, vtkMRMLNode::EndModify(), IJK, LabelAndVoxelValuesOnly, LabelValuesOnly, NoAnnotation, RAS, SetLayoutName(), vtkMRMLNode::StartModify(), and XYZ.

void vtkMRMLSliceCompositeNode::SetLayoutName ( const char * layoutName ) [inline]

Name of the layout

Referenced by ReadXMLAttributes(), and vtkSlicerSliceLogic::UpdateSliceCompositeNode().

void vtkMRMLSliceCompositeNode::SetReferenceBackgroundVolumeID ( const char * id ) [inline]

void vtkMRMLSliceCompositeNode::SetReferenceForegroundVolumeID ( const char * id ) [inline]

void vtkMRMLSliceCompositeNode::SetReferenceLabelVolumeID ( const char * id ) [inline]

void vtkMRMLSliceCompositeNode::UpdateReferenceID	(	const char *	oldID,
		const char *	newID
	)			`[virtual]`

Update the stored reference to another node in the scene

Reimplemented from vtkMRMLNode.

References BackgroundVolumeID, ForegroundVolumeID, and LabelVolumeID.

void vtkMRMLSliceCompositeNode::UpdateReferences ( ) [virtual]

Updates this node if it depends on other nodes when the node is deleted in the scene

Reimplemented from vtkMRMLNode.

References BackgroundVolumeID, ForegroundVolumeID, vtkMRMLScene::GetNodeByID(), LabelVolumeID, and vtkMRMLNode::Scene.

void vtkMRMLSliceCompositeNode::UpdateScene ( vtkMRMLScene * scene ) [virtual]

Updates other nodes in the scene depending on this node or updates this node if it depends on other nodes when the scene is read in This method is called automatically by XML parser after all nodes are created

Reimplemented from vtkMRMLNode.

References GetLayoutName(), vtkMRMLScene::GetNthNodeByClass(), vtkMRMLScene::GetNumberOfNodesByClass(), mathExample::n, and vtkMRMLScene::RemoveNodeNoNotify().

vtkMRMLSliceCompositeNode::vtkGetMacro	(	DoPropagateVolumeSelection	,
		bool
	)

vtkMRMLSliceCompositeNode::vtkGetMacro	(	AnnotationMode	,
		int
	)

vtkMRMLSliceCompositeNode::vtkGetMacro	(	AnnotationSpace	,
		int
	)

configures the annotations

vtkMRMLSliceCompositeNode::vtkGetMacro	(	SliceIntersectionVisibility	,
		int
	)

toggles visibility of intersections of other slices in the slice viewer

vtkMRMLSliceCompositeNode::vtkGetMacro	(	FiducialLabelVisibility	,
		int
	)

vtkMRMLSliceCompositeNode::vtkGetMacro	(	FiducialVisibility	,
		int
	)

toggles fiducial visibility in the slice viewer

vtkMRMLSliceCompositeNode::vtkGetMacro	(	LabelGrid	,
		int
	)

vtkMRMLSliceCompositeNode::vtkGetMacro	(	BackgroundGrid	,
		int
	)

vtkMRMLSliceCompositeNode::vtkGetMacro	(	ForegroundGrid	,
		int
	)

toggles for grid in different slice layers.

vtkMRMLSliceCompositeNode::vtkGetMacro	(	LinkedControl	,
		int
	)

toggle that gangs control of slice viewers

vtkMRMLSliceCompositeNode::vtkGetMacro	(	LabelOpacity	,
		double
	)

opacity of the Label for rendering over background TODO: make this an arbitrary list of layers TODO: make different composite types (checkerboard, etc)

vtkMRMLSliceCompositeNode::vtkGetMacro	(	ForegroundOpacity	,
		double
	)

opacity of the Foreground for rendering over background TODO: make this an arbitrary list of layers TODO: make different composite types (checkerboard, etc)

vtkMRMLSliceCompositeNode::vtkGetMacro	(	Compositing	,
		int
	)

Compositing mode for foreground and background can be alpha blending, reverse alpha blending, addition, or subtraction

vtkMRMLSliceCompositeNode::vtkGetStringMacro ( LabelVolumeID )

the ID of a MRMLVolumeNode TODO: make this an arbitrary list of layers

vtkMRMLSliceCompositeNode::vtkGetStringMacro ( ForegroundVolumeID )

the ID of a MRMLVolumeNode TODO: make this an arbitrary list of layers

vtkMRMLSliceCompositeNode::vtkGetStringMacro ( BackgroundVolumeID )

the ID of a MRMLVolumeNode

vtkMRMLSliceCompositeNode::vtkSetMacro	(	DoPropagateVolumeSelection	,
		bool
	)

configures the behavior of PropagateVolumeSelection(): if set to false, the background/label for slice views will not be reset. Default value is true

vtkMRMLSliceCompositeNode::vtkSetMacro	(	AnnotationMode	,
		int
	)

vtkMRMLSliceCompositeNode::vtkSetMacro	(	AnnotationSpace	,
		int
	)

vtkMRMLSliceCompositeNode::vtkSetMacro	(	SliceIntersectionVisibility	,
		int
	)

vtkMRMLSliceCompositeNode::vtkSetMacro	(	FiducialLabelVisibility	,
		int
	)

vtkMRMLSliceCompositeNode::vtkSetMacro	(	FiducialVisibility	,
		int
	)

vtkMRMLSliceCompositeNode::vtkSetMacro	(	LabelGrid	,
		int
	)

vtkMRMLSliceCompositeNode::vtkSetMacro	(	BackgroundGrid	,
		int
	)

vtkMRMLSliceCompositeNode::vtkSetMacro	(	ForegroundGrid	,
		int
	)

vtkMRMLSliceCompositeNode::vtkSetMacro	(	LinkedControl	,
		int
	)

vtkMRMLSliceCompositeNode::vtkSetMacro	(	LabelOpacity	,
		double
	)

vtkMRMLSliceCompositeNode::vtkSetMacro	(	ForegroundOpacity	,
		double
	)

vtkMRMLSliceCompositeNode::vtkSetMacro	(	Compositing	,
		int
	)

vtkMRMLSliceCompositeNode::vtkSetReferenceStringMacro ( LabelVolumeID )

vtkMRMLSliceCompositeNode::vtkSetReferenceStringMacro ( ForegroundVolumeID )

vtkMRMLSliceCompositeNode::vtkSetReferenceStringMacro ( BackgroundVolumeID )

vtkMRMLSliceCompositeNode::vtkTypeMacro	(	vtkMRMLSliceCompositeNode	,
		vtkMRMLNode
	)

void vtkMRMLSliceCompositeNode::WriteXML	(	ostream &	of,
		int	indent
	)			`[virtual]`

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

Reimplemented from vtkMRMLNode.

References All, AnnotationMode, AnnotationSpace, BackgroundGrid, BackgroundVolumeID, Compositing, DoPropagateVolumeSelection, FiducialLabelVisibility, FiducialVisibility, ForegroundGrid, ForegroundOpacity, ForegroundVolumeID, GetLayoutName(), IJK, LabelAndVoxelValuesOnly, LabelGrid, LabelOpacity, LabelValuesOnly, LabelVolumeID, LinkedControl, NoAnnotation, RAS, SliceIntersectionVisibility, and XYZ.

Member Data Documentation

int vtkMRMLSliceCompositeNode::AnnotationMode [protected]

Referenced by PrintSelf(), vtkMRMLSliceCompositeNode(), and WriteXML().

int vtkMRMLSliceCompositeNode::AnnotationSpace [protected]

Referenced by PrintSelf(), vtkMRMLSliceCompositeNode(), and WriteXML().

int vtkMRMLSliceCompositeNode::BackgroundGrid [protected]

Referenced by PrintSelf(), vtkMRMLSliceCompositeNode(), and WriteXML().

char* vtkMRMLSliceCompositeNode::BackgroundVolumeID [protected]

Referenced by PrintSelf(), UpdateReferenceID(), UpdateReferences(), vtkMRMLSliceCompositeNode(), WriteXML(), and ~vtkMRMLSliceCompositeNode().

int vtkMRMLSliceCompositeNode::Compositing [protected]

Referenced by PrintSelf(), vtkMRMLSliceCompositeNode(), and WriteXML().

bool vtkMRMLSliceCompositeNode::DoPropagateVolumeSelection [protected]

Referenced by PrintSelf(), vtkMRMLSliceCompositeNode(), and WriteXML().

int vtkMRMLSliceCompositeNode::FiducialLabelVisibility [protected]

Referenced by PrintSelf(), vtkMRMLSliceCompositeNode(), and WriteXML().

int vtkMRMLSliceCompositeNode::FiducialVisibility [protected]

Referenced by PrintSelf(), vtkMRMLSliceCompositeNode(), and WriteXML().

int vtkMRMLSliceCompositeNode::ForegroundGrid [protected]

Referenced by PrintSelf(), vtkMRMLSliceCompositeNode(), and WriteXML().

double vtkMRMLSliceCompositeNode::ForegroundOpacity [protected]

Referenced by PrintSelf(), vtkMRMLSliceCompositeNode(), and WriteXML().

char* vtkMRMLSliceCompositeNode::ForegroundVolumeID [protected]

Referenced by PrintSelf(), UpdateReferenceID(), UpdateReferences(), vtkMRMLSliceCompositeNode(), WriteXML(), and ~vtkMRMLSliceCompositeNode().

int vtkMRMLSliceCompositeNode::LabelGrid [protected]

Referenced by PrintSelf(), vtkMRMLSliceCompositeNode(), and WriteXML().

double vtkMRMLSliceCompositeNode::LabelOpacity [protected]

Referenced by PrintSelf(), vtkMRMLSliceCompositeNode(), and WriteXML().

char* vtkMRMLSliceCompositeNode::LabelVolumeID [protected]

Referenced by PrintSelf(), UpdateReferenceID(), UpdateReferences(), vtkMRMLSliceCompositeNode(), WriteXML(), and ~vtkMRMLSliceCompositeNode().

int vtkMRMLSliceCompositeNode::LinkedControl [protected]

Referenced by PrintSelf(), vtkMRMLSliceCompositeNode(), and WriteXML().

int vtkMRMLSliceCompositeNode::SliceIntersectionVisibility [protected]

Referenced by PrintSelf(), vtkMRMLSliceCompositeNode(), and WriteXML().

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

Libs/MRML/vtkMRMLSliceCompositeNode.h
Libs/MRML/vtkMRMLSliceCompositeNode.cxx

vtkMRMLSliceCompositeNode Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation