MRML node to represent a fiducial markup Fiducial Markups nodes contain a list of fiducial points. Visualization parameters are set in the vtkMRMLMarkupsDisplayNode class. More...

#include <Modules/Loadable/Markups/MRML/vtkMRMLMarkupsFiducialNode.h>

Inheritance diagram for vtkMRMLMarkupsFiducialNode:

[legend]

Collaboration diagram for vtkMRMLMarkupsFiducialNode:

[legend]

Public Types
typedef vtkMRMLMarkupsNode	Superclass

Public Types inherited from vtkMRMLMarkupsNode
enum	{ LockModifiedEvent = 19000, LabelFormatModifiedEvent, PointModifiedEvent, PointStartInteractionEvent, PointEndInteractionEvent, PointClickedEvent, NthMarkupModifiedEvent, MarkupAddedEvent, MarkupRemovedEvent }

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
int	AddFiducial (double x, double y, double z)
	Add a new fiducial from x,y,z coordinates and return the fiducial index. More...

int	AddFiducial (double x, double y, double z, std::string label)

int	AddFiducialFromArray (double pos[3], std::string label=std::string())
	Add a new fiducial from an array and return the fiducial index. More...

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

virtual void	CreateDefaultDisplayNodes () VTK_OVERRIDE
	Create and observe default display node(s) More...

virtual vtkMRMLStorageNode *	CreateDefaultStorageNode () VTK_OVERRIDE
	Create default storage node or NULL if does not have one. More...

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

virtual void	GetBounds (double bounds[6]) VTK_OVERRIDE

virtual const char *	GetClassName ()

virtual const char *	GetIcon () VTK_OVERRIDE

vtkMRMLMarkupsDisplayNode *	GetMarkupsDisplayNode ()
	Return a cast display node, returns null if none. More...

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

std::string	GetNthFiducialAssociatedNodeID (int n=0)
	Get associated node id on nth fiducial. More...

std::string	GetNthFiducialLabel (int n=0)
	Get label on nth fiducial. More...

void	GetNthFiducialPosition (int n, double pos[3])
	Get the position of the nth fiducial, returning it in the pos array. More...

bool	GetNthFiducialSelected (int n=0)
	Get selected property on Nth fiducial. More...

bool	GetNthFiducialVisibility (int n=0)
	Get visibility property on Nth fiducial. More...

void	GetNthFiducialWorldCoordinates (int n, double coords[4])
	Get world coordinates on nth fiducial. More...

int	GetNumberOfFiducials ()
	Get the number of fiducials in this node. More...

virtual void	GetRASBounds (double bounds[6]) VTK_OVERRIDE

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
	Print out the node information to the output stream. More...

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

void	SetNthFiducialAssociatedNodeID (int n, const char *id)
	Set associated node id on nth fiducial. More...

void	SetNthFiducialLabel (int n, std::string label)
	Set label on nth fiducial. More...

void	SetNthFiducialPosition (int n, double x, double y, double z)
	Set the position of the nth fiducial from x, y, z coordinates. More...

void	SetNthFiducialPositionFromArray (int n, double pos[3])
	Set the position of the nth fiducial from a double array. More...

void	SetNthFiducialSelected (int n, bool flag)
	Set selected property on Nth fiducial. More...

void	SetNthFiducialVisibility (int n, bool flag)

void	SetNthFiducialWorldCoordinates (int n, double coords[4])
	Set world coordinates on nth fiducial. More...

void	UpdateScene (vtkMRMLScene *scene) VTK_OVERRIDE
	Calls the superclass UpdateScene. 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 vtkMRMLMarkupsNode
int	AddMarkup (Markup markup)

int	AddMarkupWithNPoints (int n, std::string label=std::string(), vtkVector3d *point=NULL)

int	AddPointToNewMarkup (vtkVector3d point, std::string label=std::string())

int	AddPointToNthMarkup (vtkVector3d point, int n)
	Add a point to the nth markup, returning the point index. More...

int	AddPointWorldToNewMarkup (vtkVector3d point, std::string label=std::string())

int	AddText (const char *newText)
	Access to a VTK string array, not currently used. More...

virtual void	ApplyTransform (vtkAbstractTransform *transform) VTK_OVERRIDE

virtual bool	CanApplyNonLinearTransforms () const VTK_OVERRIDE

void	CopyMarkup (Markup source, Markup target)
	Copy settings from source markup to target markup. More...

int	DeleteText (int id)

virtual int	GetLocked ()
	Get the Locked property on the markup node/list of markups. More...

Markup *	GetMarkupByID (const char *markupID)
	Get Markup based on it's ID. More...

int	GetMarkupIndexByID (const char *markupID)
	Get Markup index based on it's ID. More...

std::string	GetMarkupLabelFormat ()

void	GetMarkupPoint (int markupIndex, int pointIndex, double point[3])

void	GetMarkupPointLPS (int markupIndex, int pointIndex, double point[3])
	Get points in LPS coordinate system. More...

vtkVector3d	GetMarkupPointVector (int markupIndex, int pointIndex)

int	GetMarkupPointWorld (int markupIndex, int pointIndex, double worldxyz[4])

virtual bool	GetModifiedSinceRead () VTK_OVERRIDE

Markup *	GetNthMarkup (int n)
	Return a pointer to the nth markup stored in this node, null if n is out of bounds. More...

std::string	GetNthMarkupAssociatedNodeID (int n=0)
	Get/Set the associated node id for the nth markup. More...

std::string	GetNthMarkupDescription (int n=0)

std::string	GetNthMarkupID (int n=0)
	Get the id for the nth markup. More...

std::string	GetNthMarkupLabel (int n=0)

bool	GetNthMarkupLocked (int n=0)

void	GetNthMarkupOrientation (int n, double orientation[4])
	Get the orientation quaternion for a markup. More...

bool	GetNthMarkupSelected (int n=0)

bool	GetNthMarkupVisibility (int n=0)

int	GetNumberOfMarkups ()
	Return the number of markups that are stored in this node. More...

int	GetNumberOfPointsInNthMarkup (int n)
	Return the number of points in a markup, 0 if n is invalid. More...

int	GetNumberOfTexts ()

vtkStdString	GetText (int id)

void	InitMarkup (Markup *markup)
	Initialise a markup to default values. More...

bool	InsertMarkup (Markup m, int targetIndex)

virtual void	LockedOff ()

virtual void	LockedOn ()

bool	MarkupExists (int n)
	Return true if n is a valid markup, false otherwise. More...

bool	PointExistsInMarkup (int p, int n)
	Return true if p is a valid point in a valid markup n, false otherwise. More...

void	PrintMarkup (ostream &os, vtkIndent indent, Markup *markup)

void	PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE

virtual void	RemoveAllMarkups ()
	Clear out the node of all markups. More...

void	RemoveAllTexts ()

void	RemoveMarkup (int m)
	Remove a markup. More...

std::string	ReplaceListNameInMarkupLabelFormat ()

bool	ResetNthMarkupID (int n)

void	SetLocked (int locked)

void	SetMarkupLabelFormat (std::string format)

void	SetMarkupPoint (const int markupIndex, const int pointIndex, const double x, const double y, const double z)

void	SetMarkupPointFromArray (const int markupIndex, const int pointIndex, const double pos[3])

void	SetMarkupPointFromPointer (const int markupIndex, const int pointIndex, const double *pos)

void	SetMarkupPointLPS (const int markupIndex, const int pointIndex, const double x, const double y, const double z)

void	SetMarkupPointWorld (const int markupIndex, const int pointIndex, const double x, const double y, const double z)

void	SetNthMarkupAssociatedNodeID (int n, std::string id)

void	SetNthMarkupDescription (int n, std::string description)
	Set the Description on the nth markup. More...

void	SetNthMarkupLabel (int n, std::string label)
	Set the Label on the nth markup. More...

void	SetNthMarkupLocked (int n, bool flag)

void	SetNthMarkupOrientation (int n, double w, double x, double y, double z)
	Set the orientation for a markup from passed parameters. More...

void	SetNthMarkupOrientationFromArray (int n, const double orientation[4])
	Set the orientation for a markup from a double array. More...

void	SetNthMarkupOrientationFromPointer (int n, const double *orientation)
	Set the orientation for a markup from a pointer to a double array. More...

void	SetNthMarkupSelected (int n, bool flag)

void	SetNthMarkupVisibility (int n, bool flag)

void	SetText (int id, const char *newText)

void	SwapMarkups (int m1, int m2)
	Swap the position of two markups. More...

void	UpdateScene (vtkMRMLScene *scene) VTK_OVERRIDE
	Currently only calls superclass UpdateScene. More...

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

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

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	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
virtual void	ApplyTransformMatrix (vtkMatrix4x4 *transformMatrix)

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

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

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

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

static vtkMRMLMarkupsFiducialNode *	New ()

static vtkMRMLMarkupsFiducialNode *	SafeDownCast (vtkObject *o)

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

static vtkMRMLMarkupsNode *	New ()

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

	vtkMRMLMarkupsFiducialNode ()

	vtkMRMLMarkupsFiducialNode (const vtkMRMLMarkupsFiducialNode &)

	~vtkMRMLMarkupsFiducialNode ()

Protected Member Functions inherited from vtkMRMLMarkupsNode
std::string	GenerateUniqueMarkupID ()

void	operator= (const vtkMRMLMarkupsNode &)

void	SetNthMarkupID (int n, std::string id)

	vtkMRMLMarkupsNode ()

	vtkMRMLMarkupsNode (const vtkMRMLMarkupsNode &)

	~vtkMRMLMarkupsNode ()

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

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

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)

Protected Attributes inherited from vtkMRMLMarkupsNode
vtkStringArray *	TextList

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

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 to represent a fiducial markup Fiducial Markups nodes contain a list of fiducial points. Visualization parameters are set in the vtkMRMLMarkupsDisplayNode class.

Markups is intended to be used for manual marking/editing of point positions. There is no specific limit for number of points that can be added to a list, but performance is optimal if there are less than 100 points. For visualizing more points, it is recommended to use a vtkMRMLModelNode, which contains vtkPolyData generated by a vtkGlyph3D filter.

Definition at line 43 of file vtkMRMLMarkupsFiducialNode.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMRMLMarkupsNode vtkMRMLMarkupsFiducialNode::Superclass

Definition at line 47 of file vtkMRMLMarkupsFiducialNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLMarkupsFiducialNode() [1/2]

vtkMRMLMarkupsFiducialNode::vtkMRMLMarkupsFiducialNode ( )

protected

◆ ~vtkMRMLMarkupsFiducialNode()

vtkMRMLMarkupsFiducialNode::~vtkMRMLMarkupsFiducialNode ( )

protected

◆ vtkMRMLMarkupsFiducialNode() [2/2]

vtkMRMLMarkupsFiducialNode::vtkMRMLMarkupsFiducialNode ( const vtkMRMLMarkupsFiducialNode & )

protected

Member Function Documentation

◆ AddFiducial() [1/2]

int vtkMRMLMarkupsFiducialNode::AddFiducial	(	double	x,
		double	y,
		double	z
	)

Add a new fiducial from x,y,z coordinates and return the fiducial index.

◆ AddFiducial() [2/2]

int vtkMRMLMarkupsFiducialNode::AddFiducial	(	double	x,
		double	y,
		double	z,
		std::string	label
	)

◆ AddFiducialFromArray()

int vtkMRMLMarkupsFiducialNode::AddFiducialFromArray	(	double	pos[3],
		std::string	label = `std::string()`
	)

Add a new fiducial from an array and return the fiducial index.

◆ Copy()

virtual void vtkMRMLMarkupsFiducialNode::Copy ( vtkMRMLNode * node )

virtual

Copy the node's attributes to this object.

Reimplemented from vtkMRMLMarkupsNode.

◆ CreateDefaultDisplayNodes()

virtual void vtkMRMLMarkupsFiducialNode::CreateDefaultDisplayNodes ( )

virtual

Create and observe default display node(s)

Reimplemented from vtkMRMLDisplayableNode.

◆ CreateDefaultStorageNode()

virtual vtkMRMLStorageNode* vtkMRMLMarkupsFiducialNode::CreateDefaultStorageNode ( )

virtual

Create default storage node or NULL if does not have one.

Reimplemented from vtkMRMLMarkupsNode.

◆ CreateNodeInstance()

virtual vtkMRMLNode* vtkMRMLMarkupsFiducialNode::CreateNodeInstance ( )

virtual

MRMLNode methods.

Reimplemented from vtkMRMLMarkupsNode.

◆ GetBounds()

virtual void vtkMRMLMarkupsFiducialNode::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.

◆ GetClassName()

virtual const char* vtkMRMLMarkupsFiducialNode::GetClassName ( )

virtual

Reimplemented from vtkMRMLMarkupsNode.

◆ GetIcon()

virtual const char* vtkMRMLMarkupsFiducialNode::GetIcon ( )

inlinevirtual

Reimplemented from vtkMRMLMarkupsNode.

Definition at line 51 of file vtkMRMLMarkupsFiducialNode.h.

◆ GetMarkupsDisplayNode()

vtkMRMLMarkupsDisplayNode* vtkMRMLMarkupsFiducialNode::GetMarkupsDisplayNode ( )

Return a cast display node, returns null if none.

◆ GetNodeTagName()

virtual const char* vtkMRMLMarkupsFiducialNode::GetNodeTagName ( )

inlinevirtual

Get node XML tag name (like Volume, Model)

Reimplemented from vtkMRMLMarkupsNode.

Definition at line 59 of file vtkMRMLMarkupsFiducialNode.h.

◆ GetNthFiducialAssociatedNodeID()

std::string vtkMRMLMarkupsFiducialNode::GetNthFiducialAssociatedNodeID ( int n = 0 )

Get associated node id on nth fiducial.

◆ GetNthFiducialLabel()

std::string vtkMRMLMarkupsFiducialNode::GetNthFiducialLabel ( int n = 0 )

Get label on nth fiducial.

◆ GetNthFiducialPosition()

void vtkMRMLMarkupsFiducialNode::GetNthFiducialPosition	(	int	n,
		double	pos[3]
	)

Get the position of the nth fiducial, returning it in the pos array.

◆ GetNthFiducialSelected()

bool vtkMRMLMarkupsFiducialNode::GetNthFiducialSelected ( int n = 0 )

Get selected property on Nth fiducial.

◆ GetNthFiducialVisibility()

bool vtkMRMLMarkupsFiducialNode::GetNthFiducialVisibility ( int n = 0 )

Get visibility property on Nth fiducial.

◆ GetNthFiducialWorldCoordinates()

void vtkMRMLMarkupsFiducialNode::GetNthFiducialWorldCoordinates	(	int	n,
		double	coords[4]
	)

Get world coordinates on nth fiducial.

◆ GetNumberOfFiducials()

int vtkMRMLMarkupsFiducialNode::GetNumberOfFiducials ( )

inline

Get the number of fiducials in this node.

Definition at line 91 of file vtkMRMLMarkupsFiducialNode.h.

◆ GetRASBounds()

virtual void vtkMRMLMarkupsFiducialNode::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: GetBounds()

Reimplemented from vtkMRMLDisplayableNode.

◆ IsA()

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

virtual

Reimplemented from vtkMRMLMarkupsNode.

◆ IsTypeOf()

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

static

◆ New()

static vtkMRMLMarkupsFiducialNode* vtkMRMLMarkupsFiducialNode::New ( )

static

◆ operator=()

void vtkMRMLMarkupsFiducialNode::operator= ( const vtkMRMLMarkupsFiducialNode & )

protected

◆ PrintSelf()

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

Print out the node information to the output stream.

◆ ProcessMRMLEvents()

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

virtual

Alternative method to propagate events generated in Display nodes.

Reimplemented from vtkMRMLMarkupsNode.

◆ ReadXMLAttributes()

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

virtual

Read node attributes from XML file.

Reimplemented from vtkMRMLMarkupsNode.

◆ SafeDownCast()

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

static

◆ SetNthFiducialAssociatedNodeID()

void vtkMRMLMarkupsFiducialNode::SetNthFiducialAssociatedNodeID	(	int	n,
		const char *	id
	)

Set associated node id on nth fiducial.

◆ SetNthFiducialLabel()

void vtkMRMLMarkupsFiducialNode::SetNthFiducialLabel	(	int	n,
		std::string	label
	)

Set label on nth fiducial.

◆ SetNthFiducialPosition()

void vtkMRMLMarkupsFiducialNode::SetNthFiducialPosition	(	int	n,
		double	x,
		double	y,
		double	z
	)

Set the position of the nth fiducial from x, y, z coordinates.

◆ SetNthFiducialPositionFromArray()

void vtkMRMLMarkupsFiducialNode::SetNthFiducialPositionFromArray	(	int	n,
		double	pos[3]
	)

Set the position of the nth fiducial from a double array.

◆ SetNthFiducialSelected()

void vtkMRMLMarkupsFiducialNode::SetNthFiducialSelected	(	int	n,
		bool	flag
	)

Set selected property on Nth fiducial.

◆ SetNthFiducialVisibility()

void vtkMRMLMarkupsFiducialNode::SetNthFiducialVisibility	(	int	n,
		bool	flag
	)

Set visibility property on Nth fiducial. If the visibility is set to true on the node/list as a whole, the nth fiducial visibility is used to determine if it is visible. If the visibility is set to false on the node as a whole, all fiducials are hidden but keep this value for when the list as a whole is turned visible.

See also: vtkMRMLDisplayableNode::SetDisplayVisibility; vtkMRMLDisplayNode::SetVisibility

◆ SetNthFiducialWorldCoordinates()

void vtkMRMLMarkupsFiducialNode::SetNthFiducialWorldCoordinates	(	int	n,
		double	coords[4]
	)

Set world coordinates on nth fiducial.

◆ UpdateScene()

void vtkMRMLMarkupsFiducialNode::UpdateScene ( vtkMRMLScene * scene )

virtual

Calls the superclass UpdateScene.

Reimplemented from vtkMRMLStorableNode.

◆ WriteXML()

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

virtual

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

Reimplemented from vtkMRMLMarkupsNode.

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

Modules/Loadable/Markups/MRML/vtkMRMLMarkupsFiducialNode.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkMRMLMarkupsFiducialNode() [1/2]

◆ ~vtkMRMLMarkupsFiducialNode()

◆ vtkMRMLMarkupsFiducialNode() [2/2]

Member Function Documentation

◆ AddFiducial() [1/2]

◆ AddFiducial() [2/2]

◆ AddFiducialFromArray()

◆ Copy()

◆ CreateDefaultDisplayNodes()

◆ CreateDefaultStorageNode()

◆ CreateNodeInstance()

◆ GetBounds()

◆ GetClassName()

◆ GetIcon()

◆ GetMarkupsDisplayNode()

◆ GetNodeTagName()

◆ GetNthFiducialAssociatedNodeID()

◆ GetNthFiducialLabel()

◆ GetNthFiducialPosition()

◆ GetNthFiducialSelected()

◆ GetNthFiducialVisibility()

◆ GetNthFiducialWorldCoordinates()

◆ GetNumberOfFiducials()

◆ GetRASBounds()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ operator=()

◆ PrintSelf()

◆ ProcessMRMLEvents()

◆ ReadXMLAttributes()

◆ SafeDownCast()

◆ SetNthFiducialAssociatedNodeID()

◆ SetNthFiducialLabel()

◆ SetNthFiducialPosition()

◆ SetNthFiducialPositionFromArray()

◆ SetNthFiducialSelected()

◆ SetNthFiducialVisibility()

◆ SetNthFiducialWorldCoordinates()

◆ UpdateScene()

◆ WriteXML()