Slicer  4.11
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
vtkMRMLPlotSeriesNode Class Reference

MRML node to represent a vtkPlot object. More...

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

Inheritance diagram for vtkMRMLPlotSeriesNode:
Inheritance graph
[legend]
Collaboration diagram for vtkMRMLPlotSeriesNode:
Collaboration graph
[legend]

Public Types

enum  {
  PlotTypeLine, PlotTypeBar, PlotTypeScatter, PlotTypeScatterBar,
  PlotType_Last
}
 Enumerated values for SetPlot/GetPlot. More...
 
enum  {
  MarkerStyleNone, MarkerStyleCross, MarkerStylePlus, MarkerStyleSquare,
  MarkerStyleCircle, MarkerStyleDiamond, MarkerStyle_Last
}
 Enumerated values for SetMarkerStyle/GetMarkerStyle. More...
 
enum  {
  LineStyleNone, LineStyleSolid, LineStyleDash, LineStyleDot,
  LineStyleDashDot, LineStyleDashDotDot, LineStyle_Last
}
 Enumerated values for SetLineStyle/GetLineStyle. More...
 
enum  { TableModifiedEvent = 15000 }
 
TableModifiedEvent is send when the parent table is modified More...
 
typedef vtkMRMLNode Superclass
 
- Public Types inherited from vtkMRMLNode
enum  {
  HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent,
  ReferenceRemovedEvent, ReferencedNodeModifiedEvent
}
 
typedef vtkObject Superclass
 

Public Member Functions

vtkMRMLNodeCreateNodeInstance () override
 Standard methods for MRML nodes. More...
 
virtual const char * GetClassName ()
 
virtual double * GetColor ()
 
Set/Get Color of the line and markers of the plot More...
 
virtual void GetColor (double &, double &, double &)
 
virtual void GetColor (double [3])
 
virtual std::string GetLabelColumnName ()
 
virtual int GetLineStyle ()
 
const char * GetLineStyleAsString (int id)
 
Convert between line style ID and name More...
 
int GetLineStyleFromString (const char *name)
 
virtual float GetLineWidth ()
 
virtual float GetMarkerSize ()
 
virtual int GetMarkerStyle ()
 
const char * GetNodeTagName () override
 
Get node XML tag name (like Volume, Model). More...
 
virtual double GetOpacity ()
 
Get set line opacity More...
 
virtual int GetPlotType ()
 
virtual vtkMRMLTableNodeGetTableNode ()
 
Get associated Table MRML node. More...
 
const char * GetTableNodeID ()
 
Get referenced transform node id More...
 
virtual std::string GetXColumnName ()
 Get the name of the Y column in the referenced table (for scatter plots). More...
 
virtual std::string GetYColumnName ()
 
Get the name of the Y column in the referenced table. More...
 
virtual int IsA (const char *type)
 
bool IsXColumnRequired ()
 
Returns true if X column is required (true for scatter plots) More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData) override
 
Method to propagate events generated in Plot nodes. More...
 
void ReadXMLAttributes (const char **atts) override
 
Set node attributes. More...
 
virtual void SetAndObserveTableNodeID (const char *tableNodeID)
 
virtual void SetAndObserveTableNodeID (const std::string &tableNodeID)
 
virtual void SetColor (double [3])
 
virtual void SetColor (double, double, double)
 
virtual void SetLabelColumnName (std::string)
 
virtual void SetLineStyle (int)
 
virtual void SetLineWidth (float)
 
virtual void SetMarkerSize (float)
 
virtual void SetMarkerStyle (int)
 
virtual void SetOpacity (double)
 
virtual void SetPlotType (int)
 Get and Set Macros. More...
 
virtual void SetPlotType (const char *type)
 
void SetUniqueColor (const char *colorTableNodeID=nullptr)
 
virtual void SetXColumnName (std::string)
 
virtual void SetYColumnName (std::string)
 
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
vtkMRMLNodeAddAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Add and observe a reference node from this node for a specific referenceRole. More...
 
vtkMRMLNodeAddNodeReferenceID (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 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 ()
 
vtkMRMLNodeGetNodeReference (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...
 
vtkMRMLNodeGetNthNodeReference (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 vtkMRMLSceneGetScene ()
 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 ()
 
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)
 
vtkMRMLNodeSetAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Set and observe a reference node from this node for a specific referenceRole. More...
 
vtkMRMLNodeSetAndObserveNthNodeReferenceID (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...
 
vtkMRMLNodeSetNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Set a reference to a node with specified nodeID from this node for a specific referenceRole. More...
 
vtkMRMLNodeSetNthNodeReferenceID (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 SetSceneReferences ()
 Update the references of the 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 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...
 
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 const char * GetMarkerStyleAsString (int id)
 
Convert between plot markers style ID and name More...
 
static int GetMarkerStyleFromString (const char *name)
 
static const char * GetPlotTypeAsString (int id)
 
Convert between plot type ID and name More...
 
static int GetPlotTypeFromString (const char *name)
 
static int IsTypeOf (const char *type)
 
static vtkMRMLPlotSeriesNodeNew ()
 
static vtkMRMLPlotSeriesNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (vtkObject *o)
 

Protected Member Functions

void Copy (vtkMRMLNode *node) override
 
virtual const char * GetTableNodeReferenceMRMLAttributeName ()
 
virtual const char * GetTableNodeReferenceRole ()
 
void OnNodeReferenceAdded (vtkMRMLNodeReference *reference) override
 
Called when a node reference ID is added (list size increased). More...
 
void OnNodeReferenceModified (vtkMRMLNodeReference *reference) override
 
Called when a node reference ID is modified. More...
 
void OnNodeReferenceRemoved (vtkMRMLNodeReference *reference) override
 
Called after a node reference ID is removed (list size decreased). More...
 
void operator= (const vtkMRMLPlotSeriesNode &)
 
 vtkMRMLPlotSeriesNode ()
 Constructor and destructor. More...
 
 vtkMRMLPlotSeriesNode (const vtkMRMLPlotSeriesNode &)
 
 ~vtkMRMLPlotSeriesNode () 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...
 
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...
 
vtkMRMLNodeUpdateNodeReferenceEventObserver (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

double Color [3]
 
std::string LabelColumnName
 
int LineStyle
 
float LineWidth
 
float MarkerSize
 
int MarkerStyle
 
double Opacity
 
int PlotType
 Data. More...
 
std::string XColumnName
 
std::string YColumnName
 
- 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...
 
vtkObserverManagerMRMLObserverManager
 
char * Name
 
NodeReferenceEventsType NodeReferenceEvents
 
std::map< std::string, std::string > NodeReferenceMRMLAttributeNames
 
NodeReferencesType NodeReferences
 
int SaveWithScene
 
vtkWeakPointer< vtkMRMLSceneScene
 
int Selectable
 
int Selected
 
bool UndoEnabled
 

Static Protected Attributes

static const char * TableNodeReferenceMRMLAttributeName
 
static const char * TableNodeReferenceRole
 

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, NodeReferenceListTypeNodeReferencesType
 
- Static Protected Member Functions inherited from vtkMRMLNode
static void MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 

Detailed Description

MRML node to represent a vtkPlot object.

Plot nodes describe the properties of a single plot: input data (one or two columns of a table node), and display properties (plot type, marker style, color, etc).

Definition at line 42 of file vtkMRMLPlotSeriesNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 46 of file vtkMRMLPlotSeriesNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerated values for SetPlot/GetPlot.

Enumerator
PlotTypeLine 
PlotTypeBar 
PlotTypeScatter 
PlotTypeScatterBar 
PlotType_Last 

Definition at line 49 of file vtkMRMLPlotSeriesNode.h.

◆ anonymous enum

anonymous enum

Enumerated values for SetMarkerStyle/GetMarkerStyle.

Enumerator
MarkerStyleNone 
MarkerStyleCross 
MarkerStylePlus 
MarkerStyleSquare 
MarkerStyleCircle 
MarkerStyleDiamond 
MarkerStyle_Last 

Definition at line 59 of file vtkMRMLPlotSeriesNode.h.

◆ anonymous enum

anonymous enum

Enumerated values for SetLineStyle/GetLineStyle.

Enumerator
LineStyleNone 
LineStyleSolid 
LineStyleDash 
LineStyleDot 
LineStyleDashDot 
LineStyleDashDotDot 
LineStyle_Last 

Definition at line 71 of file vtkMRMLPlotSeriesNode.h.

◆ anonymous enum

anonymous enum


TableModifiedEvent is send when the parent table is modified

Enumerator
TableModifiedEvent 

Definition at line 125 of file vtkMRMLPlotSeriesNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLPlotSeriesNode() [1/2]

vtkMRMLPlotSeriesNode::vtkMRMLPlotSeriesNode ( )
protected

Constructor and destructor.

◆ ~vtkMRMLPlotSeriesNode()

vtkMRMLPlotSeriesNode::~vtkMRMLPlotSeriesNode ( )
overrideprotected

◆ vtkMRMLPlotSeriesNode() [2/2]

vtkMRMLPlotSeriesNode::vtkMRMLPlotSeriesNode ( const vtkMRMLPlotSeriesNode )
protected

Member Function Documentation

◆ Copy()

void vtkMRMLPlotSeriesNode::Copy ( vtkMRMLNode node)
overrideprotectedvirtual

Copy the node's attributes to this object This is used only internally. Externally CopyWithScene has to be called.

Reimplemented from vtkMRMLNode.

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLPlotSeriesNode::CreateNodeInstance ( )
overridevirtual

Standard methods for MRML nodes.

Implements vtkMRMLNode.

◆ GetClassName()

virtual const char* vtkMRMLPlotSeriesNode::GetClassName ( )
virtual

Reimplemented from vtkMRMLNode.

◆ GetColor() [1/3]

virtual double* vtkMRMLPlotSeriesNode::GetColor ( )
virtual


Set/Get Color of the line and markers of the plot

◆ GetColor() [2/3]

virtual void vtkMRMLPlotSeriesNode::GetColor ( double &  ,
double &  ,
double &   
)
virtual

◆ GetColor() [3/3]

virtual void vtkMRMLPlotSeriesNode::GetColor ( double  [3])
virtual

◆ GetLabelColumnName()

virtual std::string vtkMRMLPlotSeriesNode::GetLabelColumnName ( )
virtual

Get/Set the name of the X (for scatter plot) or labels (for line or bar plot) column in the referenced table.

◆ GetLineStyle()

virtual int vtkMRMLPlotSeriesNode::GetLineStyle ( )
virtual

◆ GetLineStyleAsString()

const char* vtkMRMLPlotSeriesNode::GetLineStyleAsString ( int  id)


Convert between line style ID and name

◆ GetLineStyleFromString()

int vtkMRMLPlotSeriesNode::GetLineStyleFromString ( const char *  name)

◆ GetLineWidth()

virtual float vtkMRMLPlotSeriesNode::GetLineWidth ( )
virtual

Utility methods to set/get the Line width available for Line Plots.

◆ GetMarkerSize()

virtual float vtkMRMLPlotSeriesNode::GetMarkerSize ( )
virtual

Utility methods to set/get the marker size available for line plots.

◆ GetMarkerStyle()

virtual int vtkMRMLPlotSeriesNode::GetMarkerStyle ( )
virtual

◆ GetMarkerStyleAsString()

static const char* vtkMRMLPlotSeriesNode::GetMarkerStyleAsString ( int  id)
static


Convert between plot markers style ID and name

◆ GetMarkerStyleFromString()

static int vtkMRMLPlotSeriesNode::GetMarkerStyleFromString ( const char *  name)
static

◆ GetNodeTagName()

const char* vtkMRMLPlotSeriesNode::GetNodeTagName ( )
inlineoverridevirtual


Get node XML tag name (like Volume, Model).

Implements vtkMRMLNode.

Definition at line 100 of file vtkMRMLPlotSeriesNode.h.

◆ GetOpacity()

virtual double vtkMRMLPlotSeriesNode::GetOpacity ( )
virtual


Get set line opacity

◆ GetPlotType()

virtual int vtkMRMLPlotSeriesNode::GetPlotType ( )
virtual

◆ GetPlotTypeAsString()

static const char* vtkMRMLPlotSeriesNode::GetPlotTypeAsString ( int  id)
static


Convert between plot type ID and name

◆ GetPlotTypeFromString()

static int vtkMRMLPlotSeriesNode::GetPlotTypeFromString ( const char *  name)
static

◆ GetTableNode()

virtual vtkMRMLTableNode* vtkMRMLPlotSeriesNode::GetTableNode ( )
virtual


Get associated Table MRML node.

◆ GetTableNodeID()

const char* vtkMRMLPlotSeriesNode::GetTableNodeID ( )


Get referenced transform node id

◆ GetTableNodeReferenceMRMLAttributeName()

virtual const char* vtkMRMLPlotSeriesNode::GetTableNodeReferenceMRMLAttributeName ( )
protectedvirtual

◆ GetTableNodeReferenceRole()

virtual const char* vtkMRMLPlotSeriesNode::GetTableNodeReferenceRole ( )
protectedvirtual

◆ GetXColumnName()

virtual std::string vtkMRMLPlotSeriesNode::GetXColumnName ( )
virtual

Get the name of the Y column in the referenced table (for scatter plots).

◆ GetYColumnName()

virtual std::string vtkMRMLPlotSeriesNode::GetYColumnName ( )
virtual


Get the name of the Y column in the referenced table.

◆ IsA()

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

Reimplemented from vtkMRMLNode.

◆ IsTypeOf()

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

◆ IsXColumnRequired()

bool vtkMRMLPlotSeriesNode::IsXColumnRequired ( )


Returns true if X column is required (true for scatter plots)

◆ New()

static vtkMRMLPlotSeriesNode* vtkMRMLPlotSeriesNode::New ( )
static

◆ OnNodeReferenceAdded()

void vtkMRMLPlotSeriesNode::OnNodeReferenceAdded ( vtkMRMLNodeReference reference)
inlineoverrideprotectedvirtual


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

Reimplemented from vtkMRMLNode.

Definition at line 243 of file vtkMRMLPlotSeriesNode.h.

◆ OnNodeReferenceModified()

void vtkMRMLPlotSeriesNode::OnNodeReferenceModified ( vtkMRMLNodeReference reference)
inlineoverrideprotectedvirtual


Called when a node reference ID is modified.

Reimplemented from vtkMRMLNode.

Definition at line 254 of file vtkMRMLPlotSeriesNode.h.

◆ OnNodeReferenceRemoved()

void vtkMRMLPlotSeriesNode::OnNodeReferenceRemoved ( vtkMRMLNodeReference reference)
inlineoverrideprotectedvirtual


Called after a node reference ID is removed (list size decreased).

Reimplemented from vtkMRMLNode.

Definition at line 265 of file vtkMRMLPlotSeriesNode.h.

◆ operator=()

void vtkMRMLPlotSeriesNode::operator= ( const vtkMRMLPlotSeriesNode )
protected

◆ PrintSelf()

void vtkMRMLPlotSeriesNode::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
override

◆ ProcessMRMLEvents()

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


Method to propagate events generated in Plot nodes.

Reimplemented from vtkMRMLNode.

◆ ReadXMLAttributes()

void vtkMRMLPlotSeriesNode::ReadXMLAttributes ( const char **  atts)
overridevirtual


Set node attributes.

Reimplemented from vtkMRMLNode.

◆ SafeDownCast()

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

◆ SetAndObserveTableNodeID() [1/2]

virtual void vtkMRMLPlotSeriesNode::SetAndObserveTableNodeID ( const char *  tableNodeID)
virtual

Set and observe Table node ID.

See also
TableNodeID, GetTableNodeID(), SetInputData()

◆ SetAndObserveTableNodeID() [2/2]

virtual void vtkMRMLPlotSeriesNode::SetAndObserveTableNodeID ( const std::string &  tableNodeID)
virtual

Set and observe Table node ID. Utility method that conveniently takes a string instead of a char*.

See also
TableNodeID, GetTableNodeID(), SetInputData()

◆ SetColor() [1/2]

virtual void vtkMRMLPlotSeriesNode::SetColor ( double  ,
double  ,
double   
)
virtual

◆ SetColor() [2/2]

virtual void vtkMRMLPlotSeriesNode::SetColor ( double  [3])
virtual

◆ SetLabelColumnName()

virtual void vtkMRMLPlotSeriesNode::SetLabelColumnName ( std::string  )
virtual

◆ SetLineStyle()

virtual void vtkMRMLPlotSeriesNode::SetLineStyle ( int  )
virtual

Set/get the line style. Valid values: LineStyleNone, LineStyleSolid, LineStyleDash, LineStyleDot, LineStyleDashDot, LineStyleDashDotDot.

◆ SetLineWidth()

virtual void vtkMRMLPlotSeriesNode::SetLineWidth ( float  )
virtual

◆ SetMarkerSize()

virtual void vtkMRMLPlotSeriesNode::SetMarkerSize ( float  )
virtual

◆ SetMarkerStyle()

virtual void vtkMRMLPlotSeriesNode::SetMarkerStyle ( int  )
virtual

Utility methods to set/get the marker style available for line plots. Valid values: MarkerStyleNone, MarkerStyleCross, MarkerStylePlus, MarkerStyleSquare, MarkerStyleCircle, MarkerStyleDiamond

◆ SetOpacity()

virtual void vtkMRMLPlotSeriesNode::SetOpacity ( double  )
virtual

◆ SetPlotType() [1/2]

virtual void vtkMRMLPlotSeriesNode::SetPlotType ( int  )
virtual

Get and Set Macros.

Get/Set the type of the plot (line, bar, scatter, scatter bar). PlotTypeLine: line points are equally spaced along X axis, Y column defines height of each point PlotTypeBar: vertical bars equally spaced along X axis, Y column defines height of each bar PlotTypeScatter: X and Y columns define X and Y coordinates of points, connected by line PlotTypeScatterBar: X and Y columns define bar position and height

◆ SetPlotType() [2/2]

virtual void vtkMRMLPlotSeriesNode::SetPlotType ( const char *  type)
virtual

Convenience method to set the type of the plot from strings.

◆ SetUniqueColor()

void vtkMRMLPlotSeriesNode::SetUniqueColor ( const char *  colorTableNodeID = nullptr)

Utility function that generates a color that is not used by other plot series nodes. If colorTableNodeID is not specified then vtkMRMLColorTableNodeRandom is used.

◆ SetXColumnName()

virtual void vtkMRMLPlotSeriesNode::SetXColumnName ( std::string  )
virtual

◆ SetYColumnName()

virtual void vtkMRMLPlotSeriesNode::SetYColumnName ( std::string  )
virtual

◆ WriteXML()

void vtkMRMLPlotSeriesNode::WriteXML ( ostream &  of,
int  indent 
)
overridevirtual


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

Reimplemented from vtkMRMLNode.

Member Data Documentation

◆ Color

double vtkMRMLPlotSeriesNode::Color[3]
protected

Definition at line 299 of file vtkMRMLPlotSeriesNode.h.

◆ LabelColumnName

std::string vtkMRMLPlotSeriesNode::LabelColumnName
protected

Definition at line 291 of file vtkMRMLPlotSeriesNode.h.

◆ LineStyle

int vtkMRMLPlotSeriesNode::LineStyle
protected

Definition at line 294 of file vtkMRMLPlotSeriesNode.h.

◆ LineWidth

float vtkMRMLPlotSeriesNode::LineWidth
protected

Definition at line 293 of file vtkMRMLPlotSeriesNode.h.

◆ MarkerSize

float vtkMRMLPlotSeriesNode::MarkerSize
protected

Definition at line 296 of file vtkMRMLPlotSeriesNode.h.

◆ MarkerStyle

int vtkMRMLPlotSeriesNode::MarkerStyle
protected

Definition at line 297 of file vtkMRMLPlotSeriesNode.h.

◆ Opacity

double vtkMRMLPlotSeriesNode::Opacity
protected

Definition at line 300 of file vtkMRMLPlotSeriesNode.h.

◆ PlotType

int vtkMRMLPlotSeriesNode::PlotType
protected

Data.

Type of Plot (scatter, line, bar, ...).

Definition at line 287 of file vtkMRMLPlotSeriesNode.h.

◆ TableNodeReferenceMRMLAttributeName

const char* vtkMRMLPlotSeriesNode::TableNodeReferenceMRMLAttributeName
staticprotected

Definition at line 236 of file vtkMRMLPlotSeriesNode.h.

◆ TableNodeReferenceRole

const char* vtkMRMLPlotSeriesNode::TableNodeReferenceRole
staticprotected

Definition at line 235 of file vtkMRMLPlotSeriesNode.h.

◆ XColumnName

std::string vtkMRMLPlotSeriesNode::XColumnName
protected

Definition at line 289 of file vtkMRMLPlotSeriesNode.h.

◆ YColumnName

std::string vtkMRMLPlotSeriesNode::YColumnName
protected

Definition at line 290 of file vtkMRMLPlotSeriesNode.h.


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