![]() |
Slicer
4.10
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
|
MRML node to represent a vtkPlot object. More...
#include <Libs/MRML/Core/vtkMRMLPlotSeriesNode.h>
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 |
![]() | |
enum | { HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent, ReferenceRemovedEvent, ReferencedNodeModifiedEvent } |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual vtkMRMLNode * | CreateNodeInstance () VTK_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 () |
virtual const char * | GetNodeTagName () VTK_OVERRIDE |
Get node XML tag name (like Volume, Model). More... | |
virtual double | GetOpacity () |
Get set line opacity More... | |
virtual int | GetPlotType () |
virtual vtkMRMLTableNode * | GetTableNode () |
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) VTK_OVERRIDE |
virtual void | ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData) VTK_OVERRIDE |
Method to propagate events generated in Plot nodes. More... | |
virtual void | ReadXMLAttributes (const char **atts) VTK_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=NULL) |
virtual void | SetXColumnName (std::string) |
virtual void | SetYColumnName (std::string) |
virtual void | WriteXML (ostream &of, int indent) VTK_OVERRIDE |
Write this node's information to a MRML file in XML format. More... | |
![]() | |
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 | 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 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... | |
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 vtkMRMLPlotSeriesNode * | New () |
static vtkMRMLPlotSeriesNode * | SafeDownCast (vtkObject *o) |
![]() | |
static int | IsTypeOf (const char *type) |
static vtkMRMLNode * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
virtual void | Copy (vtkMRMLNode *node) VTK_OVERRIDE |
virtual const char * | GetTableNodeReferenceMRMLAttributeName () |
virtual const char * | GetTableNodeReferenceRole () |
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... | |
virtual void | OnNodeReferenceRemoved (vtkMRMLNodeReference *reference) VTK_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 () | |
![]() | |
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 | |
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 |
![]() | |
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 |
Static Protected Attributes | |
static const char * | TableNodeReferenceMRMLAttributeName |
static const char * | TableNodeReferenceRole |
Additional Inherited Members | |
![]() | |
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 void | MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData) |
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.
Definition at line 46 of file vtkMRMLPlotSeriesNode.h.
anonymous enum |
Enumerated values for SetPlot/GetPlot.
Enumerator | |
---|---|
PlotTypeLine | |
PlotTypeBar | |
PlotTypeScatter | |
PlotTypeScatterBar | |
PlotType_Last |
Definition at line 49 of file vtkMRMLPlotSeriesNode.h.
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 |
Enumerated values for SetLineStyle/GetLineStyle.
Enumerator | |
---|---|
LineStyleNone | |
LineStyleSolid | |
LineStyleDash | |
LineStyleDot | |
LineStyleDashDot | |
LineStyleDashDotDot | |
LineStyle_Last |
Definition at line 71 of file vtkMRMLPlotSeriesNode.h.
anonymous enum |
TableModifiedEvent is send when the parent table is modified
Enumerator | |
---|---|
TableModifiedEvent |
Definition at line 125 of file vtkMRMLPlotSeriesNode.h.
|
protected |
Constructor and destructor.
|
protected |
|
protected |
|
protectedvirtual |
Copy the node's attributes to this object This is used only internally. Externally CopyWithScene has to be called.
Reimplemented from vtkMRMLNode.
|
virtual |
Standard methods for MRML nodes.
Implements vtkMRMLNode.
|
virtual |
Reimplemented from vtkMRMLNode.
|
virtual |
Set/Get Color of the line and markers of the plot
|
virtual |
|
virtual |
|
virtual |
Get/Set the name of the X (for scatter plot) or labels (for line or bar plot) column in the referenced table.
|
virtual |
const char* vtkMRMLPlotSeriesNode::GetLineStyleAsString | ( | int | id | ) |
Convert between line style ID and name
int vtkMRMLPlotSeriesNode::GetLineStyleFromString | ( | const char * | name | ) |
|
virtual |
Utility methods to set/get the Line width available for Line Plots.
|
virtual |
Utility methods to set/get the marker size available for line plots.
|
virtual |
|
static |
Convert between plot markers style ID and name
|
static |
|
inlinevirtual |
Get node XML tag name (like Volume, Model).
Implements vtkMRMLNode.
Definition at line 100 of file vtkMRMLPlotSeriesNode.h.
|
virtual |
Get set line opacity
|
virtual |
|
static |
Convert between plot type ID and name
|
static |
|
virtual |
Get associated Table MRML node.
const char* vtkMRMLPlotSeriesNode::GetTableNodeID | ( | ) |
Get referenced transform node id
|
protectedvirtual |
|
protectedvirtual |
|
virtual |
Get the name of the Y column in the referenced table (for scatter plots).
|
virtual |
Get the name of the Y column in the referenced table.
|
virtual |
Reimplemented from vtkMRMLNode.
|
static |
bool vtkMRMLPlotSeriesNode::IsXColumnRequired | ( | ) |
Returns true if X column is required (true for scatter plots)
|
static |
|
inlineprotectedvirtual |
Called when a node reference ID is added (list size increased).
Reimplemented from vtkMRMLNode.
Definition at line 243 of file vtkMRMLPlotSeriesNode.h.
|
inlineprotectedvirtual |
Called when a node reference ID is modified.
Reimplemented from vtkMRMLNode.
Definition at line 254 of file vtkMRMLPlotSeriesNode.h.
|
inlineprotectedvirtual |
Called after a node reference ID is removed (list size decreased).
Reimplemented from vtkMRMLNode.
Definition at line 265 of file vtkMRMLPlotSeriesNode.h.
|
protected |
void vtkMRMLPlotSeriesNode::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) |
|
virtual |
Method to propagate events generated in Plot nodes.
Reimplemented from vtkMRMLNode.
|
virtual |
Set node attributes.
Reimplemented from vtkMRMLNode.
|
static |
|
virtual |
Set and observe Table node ID.
|
virtual |
Set and observe Table node ID. Utility method that conveniently takes a string instead of a char*.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Set/get the line style. Valid values: LineStyleNone, LineStyleSolid, LineStyleDash, LineStyleDot, LineStyleDashDot, LineStyleDashDotDot.
|
virtual |
|
virtual |
|
virtual |
Utility methods to set/get the marker style available for line plots. Valid values: MarkerStyleNone, MarkerStyleCross, MarkerStylePlus, MarkerStyleSquare, MarkerStyleCircle, MarkerStyleDiamond
|
virtual |
|
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
|
virtual |
Convenience method to set the type of the plot from strings.
void vtkMRMLPlotSeriesNode::SetUniqueColor | ( | const char * | colorTableNodeID = NULL | ) |
Utility function that generates a color that is not used by other plot series nodes. If colorTableNodeID is not specified then vtkMRMLColorTableNodeRandom is used.
|
virtual |
|
virtual |
|
virtual |
Write this node's information to a MRML file in XML format.
Reimplemented from vtkMRMLNode.
|
protected |
Definition at line 299 of file vtkMRMLPlotSeriesNode.h.
|
protected |
Definition at line 291 of file vtkMRMLPlotSeriesNode.h.
|
protected |
Definition at line 294 of file vtkMRMLPlotSeriesNode.h.
|
protected |
Definition at line 293 of file vtkMRMLPlotSeriesNode.h.
|
protected |
Definition at line 296 of file vtkMRMLPlotSeriesNode.h.
|
protected |
Definition at line 297 of file vtkMRMLPlotSeriesNode.h.
|
protected |
Definition at line 300 of file vtkMRMLPlotSeriesNode.h.
|
protected |
Data.
Type of Plot (scatter, line, bar, ...).
Definition at line 287 of file vtkMRMLPlotSeriesNode.h.
|
staticprotected |
Definition at line 236 of file vtkMRMLPlotSeriesNode.h.
|
staticprotected |
Definition at line 235 of file vtkMRMLPlotSeriesNode.h.
|
protected |
Definition at line 289 of file vtkMRMLPlotSeriesNode.h.
|
protected |
Definition at line 290 of file vtkMRMLPlotSeriesNode.h.