Slicer  4.13
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
vtkMRMLMarkupsROINode Class Reference

MRML node to represent an ROI markup. More...

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

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

Public Types

enum  { ROITypeBox, ROITypeBoundingBox, ROIType_Last }
 
typedef vtkMRMLMarkupsNode Superclass
 
- Public Types inherited from vtkMRMLMarkupsNode
enum  {
  LockModifiedEvent = 19000, LabelFormatModifiedEvent, PointAddedEvent, PointRemovedEvent,
  PointPositionDefinedEvent, PointPositionUndefinedEvent, PointPositionMissingEvent, PointPositionNonMissingEvent,
  PointModifiedEvent, PointStartInteractionEvent, PointEndInteractionEvent, CenterOfRotationModifiedEvent,
  FixedNumberOfControlPointsModifiedEvent, PointAboutToBeRemovedEvent
}
 
enum  {
  PositionUndefined, PositionPreview, PositionDefined, PositionMissing,
  PositionStatus_Last
}
 Placement status of a control point. More...
 
typedef std::vector< ControlPoint * > ControlPointsListType
 
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

void ApplyTransform (vtkAbstractTransform *transform) override
 Apply the passed transformation to the ROI. More...
 
void CreateDefaultDisplayNodes () override
 Create default display node or nullptr if does not have one. More...
 
vtkMRMLStorageNodeCreateDefaultStorageNode () override
 Create default storage node or nullptr if does not have one. More...
 
vtkMRMLNodeCreateNodeInstance () override
 MRMLNode methods. More...
 
const char * GetAddIcon () override
 
virtual const char * GetClassName ()
 
const char * GetDefaultNodeNamePrefix () override
 Get markup short name. More...
 
const char * GetIcon () override
 
virtual vtkImplicitFunction * GetImplicitFunction ()
 Get the implicit function that represents the ROI in node coordinates. More...
 
virtual vtkImplicitFunction * GetImplicitFunctionWorld ()
 Get the implicit function that represents the ROI in world coordinates. More...
 
const char * GetMarkupType () override
 Get markup type internal name. More...
 
const char * GetNodeTagName () override
 Get node XML tag name (like Volume, Model) More...
 
vtkMatrix4x4 * GetObjectToWorldMatrix ()
 
const char * GetPlaceAddIcon () override
 
void GetTransformedPlanes (vtkPlanes *planes, bool insideOut=false)
 
const char * GetTypeDisplayName () override
 
virtual int IsA (const char *type)
 
void OnTransformNodeReferenceChanged (vtkMRMLTransformNode *transformNode) override
 Reimplemented to recalculate InteractionHandleToWorld matrix when parent transform is changed. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Print out the node information to the output stream. More...
 
void ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData) override
 Alternative method to propagate events generated in Display nodes. More...
 
void UpdateInteractionHandleToWorldMatrix () override
 Update the InteractionHandleToWorldMatrix based on the ObjectToNode and NodeToWorld transforms. More...
 
 vtkMRMLCopyContentMacro (vtkMRMLMarkupsROINode)
 
void WriteCLI (std::vector< std::string > &commandLine, std::string prefix, int coordinateSystem=vtkMRMLStorageNode::CoordinateSystemRAS, int multipleFlag=1) override
 
virtual double * GetSize ()
 Length of the ROI sides. More...
 
virtual void GetSize (double &, double &, double &)
 
virtual void GetSize (double [3])
 
void SetSize (const double size[3])
 
void SetSize (double x, double y, double z)
 
void GetSizeWorld (double size_World[3])
 
void SetSizeWorld (const double size_World[3])
 
void SetSizeWorld (double x_World, double y_World, double z_World)
 
void GetCenter (double center[3])
 Center of the ROI. More...
 
void GetCenterWorld (double center[3])
 
vtkVector3d GetCenter ()
 
vtkVector3d GetCenterWorld ()
 
void SetCenterWorld (const double center[3])
 
void SetCenterWorld (double x, double y, double z)
 
void SetCenter (const double center[3])
 
void SetCenter (double x, double y, double z)
 
void GetXAxisWorld (double axis_World[3])
 
void GetYAxisWorld (double axis_World[3])
 
void GetZAxisWorld (double axis_World[3])
 
void GetAxisWorld (int axisIndex, double axis_World[3])
 
void GetXAxis (double axis_Node[3])
 
void GetYAxis (double axis_Node[3])
 
void GetZAxis (double axis_Node[3])
 
void GetAxis (int axisIndex, double axis_Node[3])
 
vtkMatrix4x4 * GetObjectToNodeMatrix ()
 4x4 matrix defining the object center and axis directions within the node coordinate system. More...
 
void SetAndObserveObjectToNodeMatrix (vtkMatrix4x4 *objectToNodeMatrix)
 
virtual void UpdateROIFromControlPoints ()
 Calculate the ROI dimensions from the control points. More...
 
virtual void UpdateBoxROIFromControlPoints ()
 
virtual void UpdateBoundingBoxROIFromControlPoints ()
 
virtual void UpdateControlPointsFromROI ()
 Calculate the position of control points from the ROI. More...
 
virtual void UpdateControlPointsFromBoundingBoxROI ()
 
virtual void UpdateControlPointsFromBoxROI ()
 
void GetRASBounds (double bounds[6]) override
 
void GetBounds (double bounds[6]) override
 
void GetPlanes (vtkPlanes *planes)
 
void GetPlanesWorld (vtkPlanes *planes)
 
void GetPlanes (vtkPlanes *planes, bool insideOut)
 
void GetPlanesWorld (vtkPlanes *planes, bool insideOut)
 
bool IsPointInROI (double point_Node[3])
 Returns true if the specified point is within the ROI. More...
 
bool IsPointInROIWorld (double point_World[3])
 
void SetInsideOut (bool insideOut)
 
virtual bool GetInsideOut ()
 
virtual void InsideOutOn ()
 
virtual void InsideOutOff ()
 
int SetXYZ (double center[3])
 
int SetXYZ (double x, double y, double z)
 
bool GetXYZ (double center[3])
 
void SetRadiusXYZ (double radiusXYZ[3])
 
void SetRadiusXYZ (double x, double y, double z)
 
void GetRadiusXYZ (double radiusXYZ[3])
 
- Public Member Functions inherited from vtkMRMLMarkupsNode
int AddControlPoint (ControlPoint *controlPoint, bool autoLabel=true)
 
bool CanApplyNonLinearTransforms () const override
 
bool ControlPointExists (int n)
 Return true if n is a valid control point, false otherwise. More...
 
int EndModify (int previousDisableModifiedEventState) override
 End modifying the node. Updates pending measurements and other updates. More...
 
vtkVector3d GetCenterOfRotation ()
 
bool GetCenterOfRotation (double point[3])
 
vtkVector3d GetCenterOfRotationVector ()
 
bool GetCenterOfRotationWorld (double worldxyz[3])
 
int GetClosestControlPointIndexToPositionWorld (double pos[3], bool visibleOnly=false)
 
int GetControlPointIndexFromInterpolatedPointIndex (vtkIdType interpolatedPointIndex)
 Converts curve point index to control point index. More...
 
void GetControlPointLabels (vtkStringArray *labels)
 Get all control point labels at once. More...
 
virtual bool GetControlPointPlacementComplete ()
 Returns true if no additional control points can be added to this node. More...
 
void GetControlPointPositionsWorld (vtkPoints *points)
 Get a copy of all control point positions in world coordinate system. More...
 
std::vector< ControlPoint * > * GetControlPoints ()
 Return a pointer to the std::vector of control points stored in this node. More...
 
virtual bool GetCurveClosed ()
 Returns true if the curve generator creates a closed curve. More...
 
vtkCurveGeneratorGetCurveGenerator ()
 
virtual vtkMatrix4x4 * GetInteractionHandleToWorldMatrix ()
 4x4 matrix detailing the orientation and position in world coordinates of the interaction handles. More...
 
std::string GetMarkupLabelFormat ()
 
void GetMarkupPoint (int markupIndex, int pointIndex, double point[3])
 
vtkVector3d GetMarkupPointVector (int markupIndex, int)
 
vtkMRMLMarkupsDisplayNodeGetMarkupsDisplayNode ()
 Return a cast display node, returns null if none. More...
 
virtual int GetMaximumNumberOfControlPoints ()
 
bool GetModifiedSinceRead () override
 
ControlPointGetNthControlPoint (int n)
 Return a pointer to the Nth control point stored in this node, null if n is out of bounds. More...
 
ControlPointGetNthControlPointByID (const char *controlPointID)
 Get the Nth control point based on it's ID. More...
 
std::string GetNthControlPointID (int n)
 Get the id for the Nth control point. More...
 
int GetNthControlPointIndexByID (const char *controlPointID)
 Get the Nth control point index based on it's ID. More...
 
int GetNthControlPointIndexByPositionStatus (int pointIndex, int positionStatus)
 
bool GetNthControlPointLocked (int n=0)
 
void GetNthControlPointOrientation (int n, double orientationWXYZ[4])
 
vtkVector4d GetNthControlPointOrientationVector (int pointIndex)
 
int GetNthControlPointPositionStatus (int pointIndex)
 Get control point position status (PositionUndefined, PositionPreview, PositionDefined) More...
 
vtkVector3d GetNthControlPointPositionVector (int pointIndex)
 
bool GetNthControlPointPositionVisibility (int n=0)
 
bool GetNthControlPointSelected (int n=0)
 
bool GetNthControlPointVisibility (int n=0)
 
std::string GetNthMarkupAssociatedNodeID (int n=0)
 
std::string GetNthMarkupID (int n=0)
 
std::string GetNthMarkupLabel (int n=0)
 
bool GetNthMarkupLocked (int n=0)
 
int GetNumberOfControlPoints ()
 Return the number of control points that are stored in this node. More...
 
int GetNumberOfDefinedControlPoints (bool includePreview=false)
 Return the number of control points that are already placed (not being previewed or undefined). More...
 
int GetNumberOfMarkups ()
 
int GetNumberOfPointsInNthMarkup (int)
 
int GetNumberOfUndefinedControlPoints (bool includePreview=false)
 Return the number of control points that have not been placed (not being previewed or skipped). More...
 
virtual std::string GetPropertiesLabelText ()
 
virtual int GetRequiredNumberOfControlPoints ()
 
vtkMRMLUnitNodeGetUnitNode (const char *quantity)
 Utility function to get unit node from scene. More...
 
bool MarkupExists (int n)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ReadXMLAttributes (const char **atts) override
 Read node attributes from XML file. More...
 
virtual void RemoveAllControlPoints ()
 Clear out the node of all control points. More...
 
void RemoveAllMarkups ()
 
void RemoveMarkup (int pointIndex)
 
void RemoveNthControlPoint (int pointIndex)
 Remove Nth Control Point. More...
 
std::string ReplaceListNameInControlPointLabelFormat ()
 
std::string ReplaceListNameInMarkupLabelFormat ()
 
bool ResetNthControlPointID (int n)
 
void ResetNthControlPointPosition (int n)
 Set control point status to preview. More...
 
void RestoreNthControlPointPosition (int n)
 Set control point status to defined and return to the previous position. More...
 
void SetCenterOfRotationFromArray (const double pos[3])
 
void SetCenterOfRotationFromPointer (const double *pos)
 
void SetControlPointPositionsWorld (vtkPoints *points)
 
void SetMarkupLabelFormat (std::string format)
 
void SetNthControlPointLocked (int n, bool flag)
 
void SetNthControlPointPositionFromArray (const int pointIndex, const double pos[3], int positionStatus=PositionDefined)
 
void SetNthControlPointPositionFromPointer (const int pointIndex, const double *pos)
 
void SetNthControlPointPositionMissing (int pointIndex)
 Set control point status to ignored. More...
 
void SetNthControlPointPositionOrientationWorld (const int pointIndex, const double pos[3], const double orientationMatrix[9], const char *associatedNodeID, int positionStatus=PositionDefined)
 
void SetNthControlPointPositionOrientationWorldFromArray (const int pointIndex, const double positionWorld[3], const double orientationMatrix_World[9], const char *associatedNodeID, int positionStatus=PositionDefined)
 
void SetNthControlPointPositionWorldFromArray (const int pointIndex, const double pos[3], int positionStatus=PositionDefined)
 
void SetNthControlPointSelected (int n, bool flag)
 
void SetNthControlPointVisibility (int n, bool flag)
 
void SetNthMarkupAssociatedNodeID (int n, std::string id)
 
void SetNthMarkupLabel (int n, std::string label)
 
void SetNthMarkupLocked (int n, bool flag)
 
void SwapControlPoints (int m1, int m2)
 Swap two control points (position data and all other properties). More...
 
virtual void UnsetAllControlPoints ()
 
void UnsetNthControlPointPosition (int pointIndex)
 Set control point status to undefined. More...
 
void UpdateAllMeasurements ()
 
virtual void UpdateAssignedAttribute ()
 
 vtkMRMLCopyContentMacro (vtkMRMLMarkupsNode)
 
void WriteCLI (std::vector< std::string > &commandLine, std::string prefix, int coordinateSystem=vtkMRMLStorageNode::CoordinateSystemRAS, int multipleFlag=1) override
 
void WriteXML (ostream &of, int indent) override
 Write this node's information to a MRML file in XML format. More...
 
int GetNumberOfMeasurements ()
 
int GetNumberOfEnabledMeasurements ()
 
vtkMRMLMeasurementGetNthMeasurement (int id)
 
vtkMRMLMeasurementGetMeasurement (const char *name)
 
void AddMeasurement (vtkMRMLMeasurement *measurement)
 
void RemoveNthMeasurement (int id)
 
void ClearValueForAllMeasurements ()
 
void SetNthMeasurement (int id, vtkMRMLMeasurement *measurement)
 
void SetNthMeasurement (int id, const std::string &name, double value, const std::string &units, std::string printFormat="", const std::string description="", vtkCodedEntry *quantityCode=nullptr, vtkCodedEntry *derivationCode=nullptr, vtkCodedEntry *unitsCode=nullptr, vtkCodedEntry *methodCode=nullptr)
 
void RemoveAllMeasurements ()
 
virtual int GetLocked ()
 
void SetLocked (int locked)
 
virtual void LockedOn ()
 
virtual void LockedOff ()
 
int AddNControlPoints (int n, std::string label=std::string(), vtkVector3d *point=nullptr)
 
int AddNControlPoints (int n, std::string label, double point[3])
 
int AddControlPoint (vtkVector3d point, std::string label=std::string())
 
int AddControlPoint (double point[3], std::string label=std::string())
 
int AddControlPointWorld (vtkVector3d point, std::string label=std::string())
 
int AddControlPointWorld (double point[3], std::string label=std::string())
 
bool InsertControlPoint (ControlPoint *controlPoint, int targetIndex)
 
bool InsertControlPoint (int n, vtkVector3d point, std::string label=std::string())
 
bool InsertControlPoint (int n, double point[3], std::string label=std::string())
 
bool InsertControlPointWorld (int n, vtkVector3d pointWorld, std::string label=std::string())
 
bool InsertControlPointWorld (int n, double pointWorld[3], std::string label=std::string())
 
bool GetNthControlPointAutoCreated (int n)
 
void SetNthControlPointAutoCreated (int n, bool flag)
 
void GetNthControlPointPosition (int pointIndex, double point[3])
 
double * GetNthControlPointPosition (int pointIndex) VTK_SIZEHINT(3)
 
int GetNthControlPointPositionWorld (int pointIndex, double worldxyz[3])
 
vtkVector3d GetNthControlPointPositionWorld (int pointIndex)
 
void SetNthControlPointPosition (const int pointIndex, const double x, const double y, const double z, int positionStatus=PositionDefined)
 Set of the Nth control point position from coordinates. More...
 
void SetNthControlPointPosition (const int pointIndex, const double position[3], int positionStatus=PositionDefined)
 
void SetNthControlPointPositionWorld (const int pointIndex, const double x, const double y, const double z, int positionStatus=PositionDefined)
 
void SetNthControlPointPositionWorld (const int pointIndex, const double position[3], int positionStatus=PositionDefined)
 
void SetNthControlPointOrientation (int n, double w, double x, double y, double z)
 
void SetNthControlPointOrientation (int n, const double wxyz[4])
 
double * GetNthControlPointOrientationMatrix (int n) VTK_SIZEHINT(9)
 
void SetNthControlPointOrientationMatrix (int n, double orientationMatrix[9])
 
void GetNthControlPointOrientationMatrix (int n, vtkMatrix3x3 *matrix)
 
void SetNthControlPointOrientationMatrix (int n, vtkMatrix3x3 *matrix)
 
void GetNthControlPointOrientationMatrixWorld (int n, double orientationMatrix[9])
 
vtkVector< double, 9 > GetNthControlPointOrientationMatrixWorld (int n)
 
void SetNthControlPointOrientationMatrixWorld (int n, const double orientationMatrix[9])
 
void GetNthControlPointOrientationMatrixWorld (int n, vtkMatrix3x3 *matrix)
 
void SetNthControlPointOrientationMatrixWorld (int n, vtkMatrix3x3 *matrix)
 
void SetCenterOfRotation (const double x, const double y, const double z)
 
void SetCenterOfRotation (const double position[3])
 
void SetCenterOfRotationWorld (const double x, const double y, const double z)
 
void SetCenterOfRotationWorld (const double positionWorld[3])
 
void GetNthControlPointNormal (int n, double normal[3])
 
vtkVector3d GetNthControlPointNormal (int n)
 
void GetNthControlPointNormalWorld (int n, double normalWorld[3])
 
vtkVector3d GetNthControlPointNormalWorld (int n)
 
std::string GetNthControlPointAssociatedNodeID (int n=0)
 
void SetNthControlPointAssociatedNodeID (int n, std::string id)
 
std::string GetNthControlPointLabel (int n=0)
 
void SetNthControlPointLabel (int n, std::string label)
 
std::string GetNthControlPointDescription (int n=0)
 
void SetNthControlPointDescription (int n, std::string description)
 
std::string GetControlPointLabelFormat ()
 
void SetControlPointLabelFormat (std::string format)
 
bool GetFixedNumberOfControlPoints ()
 
void SetFixedNumberOfControlPoints (bool fixed)
 
virtual vtkPoints * GetCurvePoints ()
 
virtual vtkPoints * GetCurvePointsWorld ()
 
virtual vtkPolyData * GetCurve ()
 
virtual vtkPolyData * GetCurveWorld ()
 
virtual vtkAlgorithmOutput * GetCurveWorldConnection ()
 
int GetControlPointPlacementStartIndex ()
 
void SetControlPointPlacementStartIndex (int)
 
virtual int GetLastUsedControlPointNumber ()
 
virtual void SetLastUsedControlPointNumber (int)
 
void SetNthControlPointOrientationFromPointer (int n, const double *orientationWXYZ)
 
void SetNthControlPointOrientationFromArray (int n, const double orientationWXYZ[4])
 
- Public Member Functions inherited from vtkMRMLDisplayableNode
void AddAndObserveDisplayNodeID (const char *displayNodeID)
 
void Copy (vtkMRMLNode *node) override
 
Copy the node's attributes to this object More...
 
virtual void CreateDefaultSequenceDisplayNodes ()
 
virtual int GetDisplayClassVisibility (const char *nodeClass)
 
vtkMRMLDisplayNodeGetDisplayNode ()
 
const char * GetDisplayNodeID ()
 
virtual const char * GetDisplayNodeReferenceRole ()
 
virtual int GetDisplayVisibility ()
 
vtkMRMLDisplayNodeGetNthDisplayNode (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) 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)
 
void SetSelectable (int) override
 
virtual void WriteCLI (std::vector< std::string > &vtkNotUsed(commandLine), std::string vtkNotUsed(prefix), int vtkNotUsed(coordinateSystemFlag)=vtkMRMLStorageNode::CoordinateSystemRAS, int vtkNotUsed(multipleFlag)=1)
 
- Public Member Functions inherited from vtkMRMLTransformableNode
virtual void ApplyTransformMatrix (vtkMatrix4x4 *transformMatrix)
 
vtkMRMLTransformNodeGetParentTransformNode ()
 
Associated transform MRML node More...
 
const char * GetTransformNodeID ()
 Get referenced transform node id. More...
 
bool HardenTransform ()
 
void PrintSelf (ostream &os, vtkIndent indent) 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=nullptr)
 
void Copy (vtkMRMLNode *node) override
 Copy node contents from another node of the same type. Reimplemented to copy default sequence storage node class. More...
 
virtual vtkMRMLStorageNodeCreateDefaultSequenceStorageNode ()
 
virtual std::string GetDefaultSequenceStorageNodeClassName ()
 
virtual std::string GetDefaultStorageNodeClassName (const char *filename=nullptr)
 
vtkMRMLStorageNodeGetNthStorageNode (int n)
 
Get associated display MRML node More...
 
const char * GetNthStorageNodeID (int n)
 
int GetNumberOfStorageNodes ()
 
const char * GetSlicerDataType ()
 
vtkMRMLStorageNodeGetStorageNode ()
 
const char * GetStorageNodeID ()
 
virtual vtkTagTableGetUserTagTable ()
 Methods for user-specified metadata. More...
 
bool HasStorageNodeID (const char *storageNodeID)
 
Return true if storageNodeID is in the storage node ID list. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void SetAndObserveNthStorageNodeID (int n, const char *storageNodeID)
 
void SetAndObserveStorageNodeID (const char *storageNodeID)
 
String ID of the storage MRML node More...
 
virtual void SetDefaultSequenceStorageNodeClassName (std::string)
 
void SetSlicerDataType (const char *type)
 
virtual void StorableModified ()
 
void UpdateScene (vtkMRMLScene *scene) override
 
Finds the storage node and read the data More...
 
 vtkMRMLCopyContentMacro (vtkMRMLStorableNode)
 
- 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 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 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 ()
 
int GetCustomModifiedEventPending (int eventId)
 
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 ()
 
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)
 
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 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...
 
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 vtkMRMLMarkupsROINodeNew ()
 
static vtkMRMLMarkupsROINodeSafeDownCast (vtkObject *o)
 
static void GenerateOrthogonalMatrix (vtkMatrix4x4 *inputMatrix, vtkMatrix4x4 *outputMatrix, vtkAbstractTransform *transform=nullptr, bool applyScaling=true)
 
static void GenerateOrthogonalMatrix (double xAxis[3], double yAxis[3], double zAxis[3], double origin[3], vtkMatrix4x4 *outputMatrix, vtkAbstractTransform *transform=nullptr, bool applyScaling=true)
 
- Static Public Member Functions inherited from vtkMRMLMarkupsNode
static const char * GetPositionStatusAsString (int id)
 
static int GetPositionStatusFromString (const char *name)
 
static int IsTypeOf (const char *type)
 
static vtkMRMLMarkupsNodeSafeDownCast (vtkObject *o)
 
static void ConvertOrientationMatrixToWXYZ (const double orientationMatrix[9], double orientationWXYZ[4])
 
static void ConvertOrientationWXYZToMatrix (const double orientationWXYZ[4], double orientationMatrix[9])
 
- Static Public Member Functions inherited from vtkMRMLDisplayableNode
static int IsTypeOf (const char *type)
 
static vtkMRMLDisplayableNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLTransformableNode
static int IsTypeOf (const char *type)
 
static vtkMRMLTransformableNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLStorableNode
static int IsTypeOf (const char *type)
 
static vtkMRMLStorableNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (vtkObject *o)
 

Protected Member Functions

void GenerateBoxBounds (double bounds[6], double xAxis[3], double yAxis[3], double zAxis[3], double center[3], double size[3])
 Fills the specified vtkPoints with the points for all of the box ROI corners. More...
 
bool GetObjectToNodeMatrixRotated ()
 
void operator= (const vtkMRMLMarkupsROINode &)
 
void UpdateImplicitFunction ()
 Updates the parameters of the internal implicit functions. More...
 
void UpdateObjectToWorldMatrix ()
 Calculates the transform from the Object (ROI) to World coordinates. More...
 
 vtkMRMLMarkupsROINode ()
 
 vtkMRMLMarkupsROINode (const vtkMRMLMarkupsROINode &)
 
 ~vtkMRMLMarkupsROINode () override
 
- Protected Member Functions inherited from vtkMRMLMarkupsNode
std::string GenerateControlPointLabel (int controlPointIndex)
 
std::string GenerateUniqueControlPointID ()
 
ControlPointGetNthControlPointCustomLog (int n, const char *failedMethodName)
 
void operator= (const vtkMRMLMarkupsNode &)
 
bool SetControlPointLabelsWorld (vtkStringArray *labels, vtkPoints *points, std::string separator="")
 
void SetNthControlPointID (int n, std::string id)
 
virtual void TransformOrientationMatrixFromNodeToWorld (const double position_Node[3], const double orientationMatrix_Node[9], double orientationMatrix_World[9])
 Transform the orientation matrix from node to world coordinates. More...
 
virtual void TransformOrientationMatrixFromWorldToNode (const double position_World[3], const double orientationMatrix_World[9], double orientationMatrix_Node[9])
 Transform the orientation matrix from world to node coordinates. More...
 
virtual void UpdateCurvePolyFromControlPoints ()
 
virtual void UpdateMeasurementsInternal ()
 
 vtkMRMLMarkupsNode ()
 
 vtkMRMLMarkupsNode (const vtkMRMLMarkupsNode &)
 
virtual void WriteMeasurementsToDescription ()
 
 ~vtkMRMLMarkupsNode () override
 
- Protected Member Functions inherited from vtkMRMLDisplayableNode
virtual const char * GetDisplayNodeReferenceMRMLAttributeName ()
 
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 vtkMRMLDisplayableNode &)
 
 vtkMRMLDisplayableNode ()
 
 vtkMRMLDisplayableNode (const vtkMRMLDisplayableNode &)
 
 ~vtkMRMLDisplayableNode () override
 
- Protected Member Functions inherited from vtkMRMLTransformableNode
virtual const char * GetTransformNodeReferenceMRMLAttributeName ()
 
virtual const char * GetTransformNodeReferenceRole ()
 
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 vtkMRMLTransformableNode &)
 
 vtkMRMLTransformableNode ()
 
 vtkMRMLTransformableNode (const vtkMRMLTransformableNode &)
 
 ~vtkMRMLTransformableNode () override
 
- 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 () 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::set< std::string > &references)
 
void RemoveInvalidReferences (const std::set< std::string > &validNodeIDs)
 
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

vtkSmartPointer< vtkImplicitFunction > ImplicitFunction { nullptr }
 
vtkSmartPointer< vtkImplicitFunction > ImplicitFunctionWorld { nullptr }
 
bool InsideOut {false}
 
bool IsUpdatingControlPointsFromROI {false}
 
bool IsUpdatingInteractionHandleToWorldMatrix {false}
 
bool IsUpdatingROIFromControlPoints {false}
 
vtkSmartPointer< vtkMatrix4x4 > ObjectToNodeMatrix { nullptr }
 
vtkSmartPointer< vtkMatrix4x4 > ObjectToWorldMatrix { nullptr }
 
int ROIType {vtkMRMLMarkupsROINode::ROITypeBox}
 
double Size [3] { 0.0, 0.0, 0.0 }
 
- Protected Attributes inherited from vtkMRMLMarkupsNode
vtkVector3d CenterOfRotation
 
std::string ControlPointLabelFormat {"%N-%d"}
 
int ControlPointPlacementStartIndex { -1 }
 Index of the control point index that placement is started from (if no other point is requested specifically). More...
 
ControlPointsListType ControlPoints
 Vector of control points. More...
 
bool CurveClosed {false}
 
vtkSmartPointer< vtkParallelTransportFrame > CurveCoordinateSystemGeneratorWorld
 
vtkSmartPointer< vtkCurveGeneratorCurveGenerator
 Converts curve control points to curve points. More...
 
vtkSmartPointer< vtkPolyData > CurveInputPoly
 
vtkSmartPointer< vtkGeneralTransform > CurvePolyToWorldTransform
 
vtkSmartPointer< vtkTransformPolyDataFilter > CurvePolyToWorldTransformer
 
bool FixedNumberOfControlPoints {false}
 
vtkSmartPointer< vtkMatrix4x4 > InteractionHandleToWorldMatrix
 Transform that moves the xyz unit vectors and origin of the interaction handles to local coordinates. More...
 
bool IsUpdatingPoints {false}
 Flag set from SetControlPointPositionsWorld that pauses update of measurements until the update is complete. More...
 
int LastUsedControlPointNumber {0}
 
int Locked {0}
 Locks all the points and GUI. More...
 
int MaximumNumberOfControlPoints {-1}
 
vtkCollection * Measurements
 List of measurements stored for the markup. More...
 
std::string PropertiesLabelText
 
int RequiredNumberOfControlPoints {0}
 
vtkSmartPointer< vtkStringArray > TextList
 
vtkSmartPointer< vtkPointLocator > TransformedCurvePolyLocator
 
- Protected Attributes inherited from vtkMRMLStorableNode
std::string DefaultSequenceStorageNodeClassName
 
std::string SlicerDataType
 
vtkTimeStamp StorableModifiedTime
 
vtkTagTableUserTagTable
 
- 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...
 
vtkObserverManagerMRMLObserverManager
 
char * Name {nullptr}
 
NodeReferenceEventsType NodeReferenceEvents
 
std::map< std::string, std::string > NodeReferenceMRMLAttributeNames
 
NodeReferencesType NodeReferences
 
int SaveWithScene {true}
 
vtkWeakPointer< vtkMRMLSceneScene
 
int Selectable {1}
 
int Selected {0}
 
bool UndoEnabled {false}
 
static const char * GetROITypeAsString (int roiType)
 
static int GetROITypeFromString (const char *roiType)
 
virtual int GetROIType ()
 
void SetROIType (int roiType)
 

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)
 
- 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 an ROI markup.

Coordinate systems used:

Definition at line 56 of file vtkMRMLMarkupsROINode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 60 of file vtkMRMLMarkupsROINode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
ROITypeBox 

Requires two Control points that are removed after they have been placed.

ROITypeBoundingBox 

ROI forms a bounding box around the control points.

ROIType_Last 

Definition at line 168 of file vtkMRMLMarkupsROINode.h.

Constructor & Destructor Documentation

◆ vtkMRMLMarkupsROINode() [1/2]

vtkMRMLMarkupsROINode::vtkMRMLMarkupsROINode ( )
protected

◆ ~vtkMRMLMarkupsROINode()

vtkMRMLMarkupsROINode::~vtkMRMLMarkupsROINode ( )
overrideprotected

◆ vtkMRMLMarkupsROINode() [2/2]

vtkMRMLMarkupsROINode::vtkMRMLMarkupsROINode ( const vtkMRMLMarkupsROINode )
protected

Member Function Documentation

◆ ApplyTransform()

void vtkMRMLMarkupsROINode::ApplyTransform ( vtkAbstractTransform *  transform)
overridevirtual

Apply the passed transformation to the ROI.

Reimplemented from vtkMRMLMarkupsNode.

◆ CreateDefaultDisplayNodes()

void vtkMRMLMarkupsROINode::CreateDefaultDisplayNodes ( )
overridevirtual

Create default display node or nullptr if does not have one.

Reimplemented from vtkMRMLMarkupsNode.

◆ CreateDefaultStorageNode()

vtkMRMLStorageNode* vtkMRMLMarkupsROINode::CreateDefaultStorageNode ( )
overridevirtual

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

Reimplemented from vtkMRMLMarkupsNode.

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLMarkupsROINode::CreateNodeInstance ( )
overridevirtual

MRMLNode methods.

Implements vtkMRMLDisplayableNode.

◆ GenerateBoxBounds()

void vtkMRMLMarkupsROINode::GenerateBoxBounds ( double  bounds[6],
double  xAxis[3],
double  yAxis[3],
double  zAxis[3],
double  center[3],
double  size[3] 
)
protected

Fills the specified vtkPoints with the points for all of the box ROI corners.

◆ GenerateOrthogonalMatrix() [1/2]

static void vtkMRMLMarkupsROINode::GenerateOrthogonalMatrix ( vtkMatrix4x4 *  inputMatrix,
vtkMatrix4x4 *  outputMatrix,
vtkAbstractTransform *  transform = nullptr,
bool  applyScaling = true 
)
static

Helper method for generating an orthogonal right handed matrix from axes. Transform can optionally be specified to apply an additional transform on the vectors before generating the matrix.

◆ GenerateOrthogonalMatrix() [2/2]

static void vtkMRMLMarkupsROINode::GenerateOrthogonalMatrix ( double  xAxis[3],
double  yAxis[3],
double  zAxis[3],
double  origin[3],
vtkMatrix4x4 *  outputMatrix,
vtkAbstractTransform *  transform = nullptr,
bool  applyScaling = true 
)
static

◆ GetAddIcon()

const char* vtkMRMLMarkupsROINode::GetAddIcon ( )
inlineoverridevirtual

Reimplemented from vtkMRMLMarkupsNode.

Definition at line 65 of file vtkMRMLMarkupsROINode.h.

◆ GetAxis()

void vtkMRMLMarkupsROINode::GetAxis ( int  axisIndex,
double  axis_Node[3] 
)

◆ GetAxisWorld()

void vtkMRMLMarkupsROINode::GetAxisWorld ( int  axisIndex,
double  axis_World[3] 
)

◆ GetBounds()

void vtkMRMLMarkupsROINode::GetBounds ( double  bounds[6])
overridevirtual

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

◆ GetCenter() [1/2]

void vtkMRMLMarkupsROINode::GetCenter ( double  center[3])

Center of the ROI.

◆ GetCenter() [2/2]

vtkVector3d vtkMRMLMarkupsROINode::GetCenter ( )

◆ GetCenterWorld() [1/2]

void vtkMRMLMarkupsROINode::GetCenterWorld ( double  center[3])

◆ GetCenterWorld() [2/2]

vtkVector3d vtkMRMLMarkupsROINode::GetCenterWorld ( )

◆ GetClassName()

virtual const char* vtkMRMLMarkupsROINode::GetClassName ( )
virtual

Reimplemented from vtkMRMLMarkupsNode.

◆ GetDefaultNodeNamePrefix()

const char* vtkMRMLMarkupsROINode::GetDefaultNodeNamePrefix ( )
inlineoverridevirtual

Get markup short name.

Reimplemented from vtkMRMLMarkupsNode.

Definition at line 84 of file vtkMRMLMarkupsROINode.h.

◆ GetIcon()

const char* vtkMRMLMarkupsROINode::GetIcon ( )
inlineoverridevirtual

Reimplemented from vtkMRMLMarkupsNode.

Definition at line 64 of file vtkMRMLMarkupsROINode.h.

◆ GetImplicitFunction()

virtual vtkImplicitFunction* vtkMRMLMarkupsROINode::GetImplicitFunction ( )
virtual

Get the implicit function that represents the ROI in node coordinates.

◆ GetImplicitFunctionWorld()

virtual vtkImplicitFunction* vtkMRMLMarkupsROINode::GetImplicitFunctionWorld ( )
virtual

Get the implicit function that represents the ROI in world coordinates.

◆ GetInsideOut()

virtual bool vtkMRMLMarkupsROINode::GetInsideOut ( )
virtual

◆ GetMarkupType()

const char* vtkMRMLMarkupsROINode::GetMarkupType ( )
inlineoverridevirtual

Get markup type internal name.

Reimplemented from vtkMRMLMarkupsNode.

Definition at line 78 of file vtkMRMLMarkupsROINode.h.

◆ GetNodeTagName()

const char* vtkMRMLMarkupsROINode::GetNodeTagName ( )
inlineoverridevirtual

Get node XML tag name (like Volume, Model)

Implements vtkMRMLDisplayableNode.

Definition at line 75 of file vtkMRMLMarkupsROINode.h.

◆ GetObjectToNodeMatrix()

vtkMatrix4x4* vtkMRMLMarkupsROINode::GetObjectToNodeMatrix ( )
inline

4x4 matrix defining the object center and axis directions within the node coordinate system.

Definition at line 130 of file vtkMRMLMarkupsROINode.h.

◆ GetObjectToNodeMatrixRotated()

bool vtkMRMLMarkupsROINode::GetObjectToNodeMatrixRotated ( )
protected

◆ GetObjectToWorldMatrix()

vtkMatrix4x4* vtkMRMLMarkupsROINode::GetObjectToWorldMatrix ( )
inline

4x4 matrix defining the object center and axis directions within the world coordinate system. Changes made to the matrix will not be applied.

Definition at line 139 of file vtkMRMLMarkupsROINode.h.

◆ GetPlaceAddIcon()

const char* vtkMRMLMarkupsROINode::GetPlaceAddIcon ( )
inlineoverridevirtual

Reimplemented from vtkMRMLMarkupsNode.

Definition at line 66 of file vtkMRMLMarkupsROINode.h.

◆ GetPlanes() [1/2]

void vtkMRMLMarkupsROINode::GetPlanes ( vtkPlanes *  planes)
inline

Returns the planes that define each of the 6 faces of the ROI. If InsideOut property of the node is true the normals of the plane will face inward, otherwise the plane normals face outward.

Parameters
planesOutput planes object

Definition at line 205 of file vtkMRMLMarkupsROINode.h.

◆ GetPlanes() [2/2]

void vtkMRMLMarkupsROINode::GetPlanes ( vtkPlanes *  planes,
bool  insideOut 
)

Returns the planes that define each of the 6 faces of the ROI.

Parameters
insideOutOverrides the InsideOut node property of the node. If false the normals of the planes will face outward so that the inside is "in", if true the normals of the plane will face inward so that the inside is "out".

◆ GetPlanesWorld() [1/2]

void vtkMRMLMarkupsROINode::GetPlanesWorld ( vtkPlanes *  planes)
inline

Definition at line 206 of file vtkMRMLMarkupsROINode.h.

◆ GetPlanesWorld() [2/2]

void vtkMRMLMarkupsROINode::GetPlanesWorld ( vtkPlanes *  planes,
bool  insideOut 
)

◆ GetRadiusXYZ()

void vtkMRMLMarkupsROINode::GetRadiusXYZ ( double  radiusXYZ[3])

◆ GetRASBounds()

void vtkMRMLMarkupsROINode::GetRASBounds ( double  bounds[6])
overridevirtual

Reimplemented to recalculate the axis-aligned bounds of the ROI. If the ROI is rotated, this function will not reflect the oriented bounds defined by the ROI. To get the planes that define the oriented bounding box, use GetPlanes()/GetPlanesWorld(). GetBounds/GetRASBounds will return the axis-aligned bounding box in node/world coordinates, while GetPlanes/GetPlanesWorld() will return the 6 planes that define the faces of the oriented bounding box.

See also
GetPlanes(), GetPlanesWorld()

Reimplemented from vtkMRMLMarkupsNode.

◆ GetROIType()

virtual int vtkMRMLMarkupsROINode::GetROIType ( )
virtual

ROIType represents the method that is used to calculate the size of the ROI. BOX ROI does not require control points to define a region, while the size of a BOUNDING_BOX ROI will be defined by the control points.

◆ GetROITypeAsString()

static const char* vtkMRMLMarkupsROINode::GetROITypeAsString ( int  roiType)
static

◆ GetROITypeFromString()

static int vtkMRMLMarkupsROINode::GetROITypeFromString ( const char *  roiType)
static

◆ GetSize() [1/3]

virtual double* vtkMRMLMarkupsROINode::GetSize ( )
virtual

Length of the ROI sides.

◆ GetSize() [2/3]

virtual void vtkMRMLMarkupsROINode::GetSize ( double &  ,
double &  ,
double &   
)
virtual

◆ GetSize() [3/3]

virtual void vtkMRMLMarkupsROINode::GetSize ( double  [3])
virtual

◆ GetSizeWorld()

void vtkMRMLMarkupsROINode::GetSizeWorld ( double  size_World[3])

◆ GetTransformedPlanes()

void vtkMRMLMarkupsROINode::GetTransformedPlanes ( vtkPlanes *  planes,
bool  insideOut = false 
)

◆ GetTypeDisplayName()

const char* vtkMRMLMarkupsROINode::GetTypeDisplayName ( )
inlineoverridevirtual

Get node type display name (like "Closed Curve", "Markup", etc).

Note
Subclasses should override this method to provide a more appropriate and translatable name.

Reimplemented from vtkMRMLNode.

Definition at line 81 of file vtkMRMLMarkupsROINode.h.

◆ GetXAxis()

void vtkMRMLMarkupsROINode::GetXAxis ( double  axis_Node[3])

◆ GetXAxisWorld()

void vtkMRMLMarkupsROINode::GetXAxisWorld ( double  axis_World[3])

The directional axis of the ROI that are defined by ObjectToNodeMatrix.

See also
GetObjectToNodeMatrix()

◆ GetXYZ()

bool vtkMRMLMarkupsROINode::GetXYZ ( double  center[3])

◆ GetYAxis()

void vtkMRMLMarkupsROINode::GetYAxis ( double  axis_Node[3])

◆ GetYAxisWorld()

void vtkMRMLMarkupsROINode::GetYAxisWorld ( double  axis_World[3])

◆ GetZAxis()

void vtkMRMLMarkupsROINode::GetZAxis ( double  axis_Node[3])

◆ GetZAxisWorld()

void vtkMRMLMarkupsROINode::GetZAxisWorld ( double  axis_World[3])

◆ InsideOutOff()

virtual void vtkMRMLMarkupsROINode::InsideOutOff ( )
virtual

◆ InsideOutOn()

virtual void vtkMRMLMarkupsROINode::InsideOutOn ( )
virtual

◆ IsA()

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

Reimplemented from vtkMRMLMarkupsNode.

◆ IsPointInROI()

bool vtkMRMLMarkupsROINode::IsPointInROI ( double  point_Node[3])

Returns true if the specified point is within the ROI.

◆ IsPointInROIWorld()

bool vtkMRMLMarkupsROINode::IsPointInROIWorld ( double  point_World[3])

◆ IsTypeOf()

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

◆ New()

static vtkMRMLMarkupsROINode* vtkMRMLMarkupsROINode::New ( )
static

◆ OnTransformNodeReferenceChanged()

void vtkMRMLMarkupsROINode::OnTransformNodeReferenceChanged ( vtkMRMLTransformNode transformNode)
overridevirtual

Reimplemented to recalculate InteractionHandleToWorld matrix when parent transform is changed.

Reimplemented from vtkMRMLMarkupsNode.

◆ operator=()

void vtkMRMLMarkupsROINode::operator= ( const vtkMRMLMarkupsROINode )
protected

◆ PrintSelf()

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

Print out the node information to the output stream.

◆ ProcessMRMLEvents()

void vtkMRMLMarkupsROINode::ProcessMRMLEvents ( vtkObject *  ,
unsigned long  long,
void *   
)
overridevirtual

Alternative method to propagate events generated in Display nodes.

Reimplemented from vtkMRMLMarkupsNode.

◆ SafeDownCast()

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

◆ SetAndObserveObjectToNodeMatrix()

void vtkMRMLMarkupsROINode::SetAndObserveObjectToNodeMatrix ( vtkMatrix4x4 *  objectToNodeMatrix)

◆ SetCenter() [1/2]

void vtkMRMLMarkupsROINode::SetCenter ( const double  center[3])

◆ SetCenter() [2/2]

void vtkMRMLMarkupsROINode::SetCenter ( double  x,
double  y,
double  z 
)

◆ SetCenterWorld() [1/2]

void vtkMRMLMarkupsROINode::SetCenterWorld ( const double  center[3])

◆ SetCenterWorld() [2/2]

void vtkMRMLMarkupsROINode::SetCenterWorld ( double  x,
double  y,
double  z 
)

◆ SetInsideOut()

void vtkMRMLMarkupsROINode::SetInsideOut ( bool  insideOut)

Get/Set the ROI inside out flag. Used for computing ImplicitFunction and bounding planes. It may be also used for rendering the ROI differently (e.g., filling inside or outside).

See also
GetImplicitFunction, GetImplicitFunctionWorld, GetPlanes

◆ SetRadiusXYZ() [1/2]

void vtkMRMLMarkupsROINode::SetRadiusXYZ ( double  radiusXYZ[3])

Legacy method from vtkMRMLAnnotationROINode Get/Set for radius of the ROI in RAS coordinates Old API: void SetRadiusXYZ(double RadiusX, double RadiusY, double RadiusZ); void SetRadiusXYZ(double* RadiusXYZ); vtkGetVectorMacro(RadiusXYZ,double,3);

See also
SetSize(), GetSize()

◆ SetRadiusXYZ() [2/2]

void vtkMRMLMarkupsROINode::SetRadiusXYZ ( double  x,
double  y,
double  z 
)

◆ SetROIType()

void vtkMRMLMarkupsROINode::SetROIType ( int  roiType)

◆ SetSize() [1/2]

void vtkMRMLMarkupsROINode::SetSize ( const double  size[3])

◆ SetSize() [2/2]

void vtkMRMLMarkupsROINode::SetSize ( double  x,
double  y,
double  z 
)

◆ SetSizeWorld() [1/2]

void vtkMRMLMarkupsROINode::SetSizeWorld ( const double  size_World[3])

◆ SetSizeWorld() [2/2]

void vtkMRMLMarkupsROINode::SetSizeWorld ( double  x_World,
double  y_World,
double  z_World 
)

◆ SetXYZ() [1/2]

int vtkMRMLMarkupsROINode::SetXYZ ( double  center[3])

Legacy vtkMRMLAnnotationROINode methodsLegacy method from vtkMRMLAnnotationROINode Get/Set for ROI Position in RAS coordinates Note: The ROI Position is the center of the ROI Old API: void SetXYZ(double X, double Y, double Z); void SetXYZ(double* XYZ); vtkGetVectorMacro(XYZ,double,3); double* GetXYZ() {return this->GetControlPointCoordinates(0);}

See also
SetCenter(), GetCenter()

◆ SetXYZ() [2/2]

int vtkMRMLMarkupsROINode::SetXYZ ( double  x,
double  y,
double  z 
)

◆ UpdateBoundingBoxROIFromControlPoints()

virtual void vtkMRMLMarkupsROINode::UpdateBoundingBoxROIFromControlPoints ( )
virtual

◆ UpdateBoxROIFromControlPoints()

virtual void vtkMRMLMarkupsROINode::UpdateBoxROIFromControlPoints ( )
virtual

◆ UpdateControlPointsFromBoundingBoxROI()

virtual void vtkMRMLMarkupsROINode::UpdateControlPointsFromBoundingBoxROI ( )
virtual

◆ UpdateControlPointsFromBoxROI()

virtual void vtkMRMLMarkupsROINode::UpdateControlPointsFromBoxROI ( )
virtual

◆ UpdateControlPointsFromROI()

virtual void vtkMRMLMarkupsROINode::UpdateControlPointsFromROI ( )
virtual

Calculate the position of control points from the ROI.

◆ UpdateImplicitFunction()

void vtkMRMLMarkupsROINode::UpdateImplicitFunction ( )
protected

Updates the parameters of the internal implicit functions.

◆ UpdateInteractionHandleToWorldMatrix()

void vtkMRMLMarkupsROINode::UpdateInteractionHandleToWorldMatrix ( )
overridevirtual

Update the InteractionHandleToWorldMatrix based on the ObjectToNode and NodeToWorld transforms.

Reimplemented from vtkMRMLMarkupsNode.

◆ UpdateObjectToWorldMatrix()

void vtkMRMLMarkupsROINode::UpdateObjectToWorldMatrix ( )
protected

Calculates the transform from the Object (ROI) to World coordinates.

◆ UpdateROIFromControlPoints()

virtual void vtkMRMLMarkupsROINode::UpdateROIFromControlPoints ( )
virtual

Calculate the ROI dimensions from the control points.

◆ vtkMRMLCopyContentMacro()

vtkMRMLMarkupsROINode::vtkMRMLCopyContentMacro ( vtkMRMLMarkupsROINode  )

Copy node content (excludes basic data, such as name and node references).

See also
vtkMRMLNode::CopyContent

◆ WriteCLI()

void vtkMRMLMarkupsROINode::WriteCLI ( std::vector< std::string > &  commandLine,
std::string  prefix,
int  coordinateSystem = vtkMRMLStorageNode::CoordinateSystemRAS,
int  multipleFlag = 1 
)
override

Write this node's information to a vector of strings for passing to a CLI, precede each datum with the prefix if not an empty string coordinateSystemFlag = vtkMRMLStorageNode::CoordinateSystemRAS or vtkMRMLStorageNode::CoordinateSystemLPS multipleFlag = 1 for the whole list, 1 for the first selected control point

Member Data Documentation

◆ ImplicitFunction

vtkSmartPointer<vtkImplicitFunction> vtkMRMLMarkupsROINode::ImplicitFunction { nullptr }
protected

Definition at line 306 of file vtkMRMLMarkupsROINode.h.

◆ ImplicitFunctionWorld

vtkSmartPointer<vtkImplicitFunction> vtkMRMLMarkupsROINode::ImplicitFunctionWorld { nullptr }
protected

Definition at line 307 of file vtkMRMLMarkupsROINode.h.

◆ InsideOut

bool vtkMRMLMarkupsROINode::InsideOut {false}
protected

Definition at line 300 of file vtkMRMLMarkupsROINode.h.

◆ IsUpdatingControlPointsFromROI

bool vtkMRMLMarkupsROINode::IsUpdatingControlPointsFromROI {false}
protected

Definition at line 297 of file vtkMRMLMarkupsROINode.h.

◆ IsUpdatingInteractionHandleToWorldMatrix

bool vtkMRMLMarkupsROINode::IsUpdatingInteractionHandleToWorldMatrix {false}
protected

Definition at line 299 of file vtkMRMLMarkupsROINode.h.

◆ IsUpdatingROIFromControlPoints

bool vtkMRMLMarkupsROINode::IsUpdatingROIFromControlPoints {false}
protected

Definition at line 298 of file vtkMRMLMarkupsROINode.h.

◆ ObjectToNodeMatrix

vtkSmartPointer<vtkMatrix4x4> vtkMRMLMarkupsROINode::ObjectToNodeMatrix { nullptr }
protected

Definition at line 303 of file vtkMRMLMarkupsROINode.h.

◆ ObjectToWorldMatrix

vtkSmartPointer<vtkMatrix4x4> vtkMRMLMarkupsROINode::ObjectToWorldMatrix { nullptr }
protected

Definition at line 304 of file vtkMRMLMarkupsROINode.h.

◆ ROIType

int vtkMRMLMarkupsROINode::ROIType {vtkMRMLMarkupsROINode::ROITypeBox}
protected

Definition at line 293 of file vtkMRMLMarkupsROINode.h.

◆ Size

double vtkMRMLMarkupsROINode::Size[3] { 0.0, 0.0, 0.0 }
protected

Definition at line 295 of file vtkMRMLMarkupsROINode.h.


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