MRML node for referencing a collection of data to plot. More...

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

Inheritance diagram for vtkMRMLChartNode:

Collaboration diagram for vtkMRMLChartNode:

Public Types
typedef vtkMRMLNode	Superclass

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

typedef vtkObject	Superclass

Public Member Functions
void	AddArray (const char name, const char id)
	Access methods. More...

void	ClearArrays ()
	Remove all the arrays More...

void	ClearProperties (const char *arrname)
	Remove all the properties for an array More...

void	ClearProperties ()
	Remove all the properties for all the arrays More...

void	ClearProperty (const char arrname, const char property)
	Remove a property for an array More...

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

vtkMRMLNode *	CreateNodeInstance () override
	Create instance of the default node. Like New only virtual. More...

const char *	GetArray (const char *name)
	Get the array id referenced by a particular name More...

vtkStringArray *	GetArrayNames ()
	Get the list of array names More...

vtkStringArray *	GetArrays ()
	Get the list of array ids More...

virtual const char *	GetClassName ()

const char *	GetNodeTagName () override
	Get node XML tag name (like Volume, Model) More...

const char *	GetProperty (const char arrname, const char property)

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	ProcessMRMLEvents (vtkObject caller, unsigned long event, void callData) override
	Method to propagate events generated in mrml More...

void	ReadXMLAttributes (const char **atts) override
	Set node attributes More...

void	RemoveArray (const char *name)
	Remove a double array from the chart More...

void	SetProperty (const char arrname, const char property, const char *value)

void	SetSceneReferences () override

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

void	UpdateReferences () override

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

Public Member Functions inherited from vtkMRMLNode
vtkMRMLNode *	AddAndObserveNodeReferenceID (const char referenceRole, const char referencedNodeID, vtkIntArray *events=nullptr)
	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=nullptr, vtkIntArray *events=nullptr)
	Add a referenceRole. More...

virtual void	AddToSceneOff ()

virtual void	AddToSceneOn ()

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

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

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

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 vtkIntArray *	GetContentModifiedEvents ()

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 ()
	Get the scene this node has been added to. More...

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

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

virtual char *	GetSingletonTag ()

virtual bool	GetUndoEnabled ()

virtual bool	HasCopyContent () const
	Returns true if the class supports deep and shallow copying node content. More...

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=nullptr)
	This method allows the node to compress events. More...

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

bool	IsSingleton ()

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

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. 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=nullptr)
	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=nullptr)
	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)
	This method is for internal use only. Use AddNode method of vtkMRMLScene to add a node to the scene. More...

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

virtual void	SetUndoEnabled (bool)

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

virtual void	UndoEnabledOff ()

virtual void	UndoEnabledOn ()

virtual void	UpdateScene (vtkMRMLScene *)

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 int	IsTypeOf (const char *type)

static vtkMRMLChartNode *	New ()
	Constants. More...

static vtkMRMLChartNode *	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	operator= (const vtkMRMLChartNode &)

	vtkMRMLChartNode ()
	Constructor and destroctor. More...

	vtkMRMLChartNode (const vtkMRMLChartNode &)

	~vtkMRMLChartNode () 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. 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...

virtual void	OnNodeReferenceAdded (vtkMRMLNodeReference *reference)

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

virtual void	OnNodeReferenceRemoved (vtkMRMLNodeReference *reference)
	Called when a referenced node pointer is removed (set to nullptr). More...

void	operator= (const vtkMRMLNode &)

void	ParseReferencesAttribute (const char *attValue, std::set< 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=nullptr)

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

	vtkMRMLNode ()

	vtkMRMLNode (const vtkMRMLNode &)

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

Protected Attributes
vtkStringArray *	ArrayNames

vtkStringArray *	Arrays

DoubleArrayIDMap *	DoubleArrayIDs
	Data. More...

ChartPropertyMap *	Properties

Protected Attributes inherited from vtkMRMLNode
int	AddToScene {1}

AttributesType	Attributes

vtkIntArray *	ContentModifiedEvents

char *	Description {nullptr}

int	HideFromEditors {0}

char *	ID {nullptr}

int	InMRMLCallbackFlag {0}
	Flag to avoid event loops More...

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

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}

bool	UndoEnabled {false}

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)

Detailed Description

MRML node for referencing a collection of data to plot.

Definition at line 28 of file vtkMRMLChartNode.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMRMLNode vtkMRMLChartNode::Superclass

Definition at line 42 of file vtkMRMLChartNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLChartNode() [1/2]

vtkMRMLChartNode::vtkMRMLChartNode ( )

protected

Constructor and destroctor.

◆ ~vtkMRMLChartNode()

vtkMRMLChartNode::~vtkMRMLChartNode ( )

overrideprotected

◆ vtkMRMLChartNode() [2/2]

vtkMRMLChartNode::vtkMRMLChartNode ( const vtkMRMLChartNode & )

protected

Member Function Documentation

◆ AddArray()

void vtkMRMLChartNode::AddArray	(	const char *	name,
		const char *	id
	)

Access methods.

Add a double array to the chart. Parameter "name" is used for referencing the array when setting properties for plotting the array or for removing the array from the chart.

◆ ClearArrays()

void vtkMRMLChartNode::ClearArrays ( )

Remove all the arrays

◆ ClearProperties() [1/2]

void vtkMRMLChartNode::ClearProperties ( const char * arrname )

Remove all the properties for an array

◆ ClearProperties() [2/2]

void vtkMRMLChartNode::ClearProperties ( )

Remove all the properties for all the arrays

◆ ClearProperty()

void vtkMRMLChartNode::ClearProperty	(	const char *	arrname,
		const char *	property
	)

Remove a property for an array

◆ Copy()

void vtkMRMLChartNode::Copy ( vtkMRMLNode * node )

overridevirtual

Copy the node's attributes to this object

Reimplemented from vtkMRMLNode.

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLChartNode::CreateNodeInstance ( )

overridevirtual

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

Note: Subclasses should implement this method

Implements vtkMRMLNode.

◆ GetArray()

const char* vtkMRMLChartNode::GetArray ( const char * name )

Get the array id referenced by a particular name

◆ GetArrayNames()

vtkStringArray* vtkMRMLChartNode::GetArrayNames ( )

Get the list of array names

◆ GetArrays()

vtkStringArray* vtkMRMLChartNode::GetArrays ( )

Get the list of array ids

◆ GetClassName()

virtual const char* vtkMRMLChartNode::GetClassName ( )

virtual

Reimplemented from vtkMRMLNode.

◆ GetNodeTagName()

const char* vtkMRMLChartNode::GetNodeTagName ( )

inlineoverridevirtual

Get node XML tag name (like Volume, Model)

Implements vtkMRMLNode.

Definition at line 62 of file vtkMRMLChartNode.h.

◆ GetProperty()

const char* vtkMRMLChartNode::GetProperty	(	const char *	arrname,
		const char *	property
	)

◆ IsA()

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

virtual

Reimplemented from vtkMRMLNode.

◆ IsTypeOf()

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

static

◆ New()

static vtkMRMLChartNode* vtkMRMLChartNode::New ( )

static

Constants.

Standard methods for MRML nodes

◆ operator=()

void vtkMRMLChartNode::operator= ( const vtkMRMLChartNode & )

protected

◆ PrintSelf()

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

override

◆ ProcessMRMLEvents()

void vtkMRMLChartNode::ProcessMRMLEvents	(	vtkObject *	caller,
		unsigned long	event,
		void *	callData
	)

overridevirtual

Method to propagate events generated in mrml

Reimplemented from vtkMRMLNode.

◆ ReadXMLAttributes()

void vtkMRMLChartNode::ReadXMLAttributes ( const char ** atts )

overridevirtual

Set node attributes

Reimplemented from vtkMRMLNode.

◆ RemoveArray()

void vtkMRMLChartNode::RemoveArray ( const char * name )

Remove a double array from the chart

◆ SafeDownCast()

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

static

◆ SetProperty()

void vtkMRMLChartNode::SetProperty	(	const char *	arrname,
		const char *	property,
		const char *	value
	)

Set/Get a property for a specific array to control how it will appear in the chart. If the array name is "default", then the property is either a property of the entire chart or a default property for the arrays (which can be overridden by properties assigned to specific arrays). Available properties are:

Chart level properties

"type" - Line, Bar, Scatter, Box
"title" - title displayed on the chart
"showTitle" - show title "on" or "off"
"xAxisLabel" - label displayed on the x-axis
"xAxisPad" - width of the x-axis padding, which is a factor multiplied by the data range on the axis to give the axis range so that data points don't fall on the edges of the axis.
"showXAxisLabel" - show x-axis label "on" or "off"
"xAxisType" - type of data on x-axis, "quantitative", "categorical", "date"
"yAxisLabel" - label displayed on the y-axis
"yAxisPad" - height of the y-axis padding, which is a factor multiplied by the data range on the axis to give the axis range so that data points don't fall on the edges of the axis.
"showYAxisLabel" - show y-axis label "on" or "off"
"yAxisType" - type of data on y-axis, "quantitative", "categorical"
"showGrid" - show grid "on" or "off"
"showLegend" - show legend "on" or "off"
"lookupTable" - MRMLID of a ColorNode to use to color series

Array level properties (can be assigned to "default" to apply to entire chart)

"showLines" - show lines "on" or "off"
"showMarkers" - show markers "on" or "off"
"size" - marker size is an integer larger than 0 and smaller than 2^32 - 1
"linePattern" - line pattern can be "solid", "dashed", "dotted", "dashed-dotted"
"lineWidth" - line width is an integer larger than 0 and smaller than 2^32 - 1
"color" - color to use for the array lines and points (#RRGGBB)
"lookupTable" - MRMLID of a ColorNode to use to color individual bars in bar chart (useful with categorical data)

When using DoubleArrayNodes, dates are specified as floats representing the number of seconds since January 1, 1970 UTC. Fractional seconds are permitted.

◆ SetSceneReferences()

void vtkMRMLChartNode::SetSceneReferences ( )

overridevirtual

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

Reimplemented from vtkMRMLNode.

◆ UpdateReferenceID()

void vtkMRMLChartNode::UpdateReferenceID	(	const char *	oldID,
		const char *	newID
	)

overridevirtual

Update the stored reference to another node in the scene

Reimplemented from vtkMRMLNode.

◆ UpdateReferences()

void vtkMRMLChartNode::UpdateReferences ( )

overridevirtual

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

Reimplemented from vtkMRMLNode.

◆ WriteXML()

void vtkMRMLChartNode::WriteXML	(	ostream &	of,
		int	indent
	)

overridevirtual

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

Reimplemented from vtkMRMLNode.

Member Data Documentation

◆ ArrayNames

vtkStringArray* vtkMRMLChartNode::ArrayNames

protected

Definition at line 188 of file vtkMRMLChartNode.h.

◆ Arrays

vtkStringArray* vtkMRMLChartNode::Arrays

protected

Definition at line 187 of file vtkMRMLChartNode.h.

◆ DoubleArrayIDs

DoubleArrayIDMap* vtkMRMLChartNode::DoubleArrayIDs

protected

Data.

Definition at line 186 of file vtkMRMLChartNode.h.

◆ Properties

ChartPropertyMap* vtkMRMLChartNode::Properties

protected

Definition at line 189 of file vtkMRMLChartNode.h.

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

Libs/MRML/Core/vtkMRMLChartNode.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkMRMLChartNode() [1/2]

◆ ~vtkMRMLChartNode()

◆ vtkMRMLChartNode() [2/2]

Member Function Documentation

◆ AddArray()

◆ ClearArrays()

◆ ClearProperties() [1/2]

◆ ClearProperties() [2/2]

◆ ClearProperty()

◆ Copy()

◆ CreateNodeInstance()

◆ GetArray()

◆ GetArrayNames()

◆ GetArrays()

◆ GetClassName()

◆ GetNodeTagName()

◆ GetProperty()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ operator=()

◆ PrintSelf()

◆ ProcessMRMLEvents()

◆ ReadXMLAttributes()

◆ RemoveArray()

◆ SafeDownCast()

◆ SetProperty()

◆ SetSceneReferences()

◆ UpdateReferenceID()

◆ UpdateReferences()

◆ WriteXML()

Member Data Documentation

◆ ArrayNames

◆ Arrays

◆ DoubleArrayIDs

◆ Properties