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

MRML node for storing a slice through RAS space. More...

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

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

Public Types

enum  { DefaultJumpSlice =-1, CenteredJumpSlice =0, OffsetJumpSlice }
 Enum to specify the method of jumping slices. More...
 
enum  { AutomaticSliceSpacingMode =0, PrescribedSliceSpacingMode }
 
enum  InteractionFlagType {
  None = 0, SliceToRASFlag = 1, FieldOfViewFlag = 2, OrientationFlag = 4,
  ResetFieldOfViewFlag = 8, MultiplanarReformatFlag = 16, XYZOriginFlag = 32, LabelOutlineFlag = 64,
  SliceVisibleFlag = 128, SliceSpacingFlag = 256, ResetOrientationFlag = 512
}
 
enum  SliceResolutionModeType {
  SliceResolutionMatchVolumes =0, SliceResolutionMatch2DView, SliceFOVMatch2DViewSpacingMatchVolumes, SliceFOVMatchVolumesSpacingMatch2DView,
  SliceResolutionCustom
}
 Enum to specify the method for setting UVW extents. More...
 
typedef vtkMRMLAbstractViewNode Superclass
 
- Public Types inherited from vtkMRMLAbstractViewNode
enum  OrientationMarkerSizeType { OrientationMarkerSizeSmall =0, OrientationMarkerSizeMedium, OrientationMarkerSizeLarge, OrientationMarkerSize_Last }
 
enum  OrientationMarkerTypeType {
  OrientationMarkerTypeNone =0, OrientationMarkerTypeCube, OrientationMarkerTypeHuman, OrientationMarkerTypeAxes,
  OrientationMarkerType_Last
}
 Enum to specify orientation marker types. More...
 
enum  RulerColorType { RulerColorWhite =0, RulerColorBlack, RulerColorYellow, RulerColor_Last }
 Enum to specify ruler colors. More...
 
enum  RulerTypeType { RulerTypeNone =0, RulerTypeThin, RulerTypeThick, RulerType_Last }
 Enum to specify ruler types. More...
 
typedef vtkMRMLNode Superclass
 
- Public Types inherited from vtkMRMLNode
enum  {
  HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent,
  ReferenceRemovedEvent, ReferencedNodeModifiedEvent
}
 
typedef vtkObject Superclass
 

Public Member Functions

bool AddSliceOrientationPreset (const std::string &name, vtkMatrix3x3 *orientationMatrix)
 Add an orientation preset. More...
 
void AddThreeDViewID (const char *viewNodeID)
 
void Copy (vtkMRMLNode *node) override
 
Copy the node's attributes to this object More...
 
vtkMRMLNodeCreateNodeInstance () override
 Create instance of the default node. Like New only virtual. More...
 
virtual int GetActiveSlice ()
 
virtual const char * GetClassName ()
 
virtual char * GetDefaultOrientation ()
 
virtual int * GetDimensions ()
 
virtual void GetDimensions (int data[3])
 
virtual double * GetFieldOfView ()
 
Size of the slice plane in millimeters More...
 
virtual void GetFieldOfView (double &, double &, double &)
 
virtual void GetFieldOfView (double [3])
 
virtual int GetInteracting ()
 
virtual unsigned int GetInteractionFlags ()
 
virtual unsigned int GetInteractionFlagsModifier ()
 
virtual int GetJumpMode ()
 
virtual int GetLayoutGridColumns ()
 
Set/Get the number of columns to use ina LightBox display More...
 
virtual int GetLayoutGridRows ()
 
Set/Get the number of rows to use ina LightBox display More...
 
const char * GetNodeTagName () override
 
Get node XML tag name (like Volume, Model) More...
 
const char * GetNthThreeDViewID (unsigned int index)
 
int GetNumberOfSliceOrientationPresets () const
 Return number of orientation presets. More...
 
int GetNumberOfThreeDViewIDs () const
 
std::string GetOrientation ()
 Get orientation. More...
 
std::string GetOrientation (vtkMatrix4x4 *sliceToRAS)
 Return the orientation name associated with sliceToRAS. More...
 
virtual const char * GetOrientationString ()
 Get orientation. More...
 
virtual double * GetPrescribedSliceSpacing ()
 
virtual void GetPrescribedSliceSpacing (double &, double &, double &)
 
virtual void GetPrescribedSliceSpacing (double [3])
 
double GetSliceOffset ()
 
Get/Set the current distance from the origin to the slice plane More...
 
vtkMatrix3x3 * GetSliceOrientationPreset (const std::string &name)
 Return the sliceToRAS matrix associated with name. More...
 
std::string GetSliceOrientationPresetName (vtkMatrix3x3 *orientationMatrix)
 Return the preset name corresponding to orientationMatrix. More...
 
void GetSliceOrientationPresetNames (vtkStringArray *presetOrientationNames)
 Return all the orientation preset names. More...
 
virtual int GetSliceResolutionMode ()
 
virtual int GetSliceSpacingMode ()
 
virtual vtkMatrix4x4 * GetSliceToRAS ()
 
virtual int GetSliceVisible ()
 
The visibility of the slice in the 3DViewer. More...
 
std::vector< std::string > GetThreeDViewIDs () const
 
virtual int GetUseLabelOutline ()
 
Use the label outline filter on this slice? More...
 
virtual int * GetUVWDimensions ()
 
virtual void GetUVWDimensions (int data[3])
 
virtual double * GetUVWExtents ()
 
Get/Set maximum extent in any direction occupied by slice More...
 
virtual void GetUVWExtents (double &, double &, double &)
 
virtual void GetUVWExtents (double [3])
 
virtual int * GetUVWMaximumDimensions ()
 maximum limit for UVWDimensions More...
 
virtual void GetUVWMaximumDimensions (int data[3])
 
virtual double * GetUVWOrigin ()
 
Origin of UVW window More...
 
virtual void GetUVWOrigin (double &, double &, double &)
 
virtual void GetUVWOrigin (double [3])
 
vtkMatrix4x4 * GetUVWToRAS ()
 
vtkMatrix4x4 * GetUVWToSlice ()
 
virtual int GetWidgetNormalLockedToCamera ()
 
virtual int GetWidgetOutlineVisible ()
 The visibility of the slice plane widget outline in the 3DViewer. More...
 
virtual int GetWidgetVisible ()
 
The visibility of the slice plane widget in the 3DViewer. More...
 
vtkMatrix4x4 * GetXYToRAS ()
 
vtkMatrix4x4 * GetXYToSlice ()
 
virtual double * GetXYZOrigin ()
 
Origin of XYZ window More...
 
virtual void GetXYZOrigin (double &, double &, double &)
 
virtual void GetXYZOrigin (double [3])
 
bool HasSliceOrientationPreset (const std::string &name)
 Return True if an orientation preset is stored. More...
 
virtual void InteractingOff ()
 
virtual void InteractingOn ()
 
virtual int IsA (const char *type)
 
bool IsDisplayableInThreeDView (const char *viewNodeID) const
 
bool IsThreeDViewIDPresent (const char *ThreeDViewID) const
 
void JumpAllSlices (double r, double a, double s)
 
void JumpSlice (double r, double a, double s)
 
void JumpSliceByCentering (double r, double a, double s)
 
void JumpSliceByOffsetting (double r, double a, double s)
 
void JumpSliceByOffsetting (int k, double r, double a, double s)
 
bool MatrixAreEqual (const vtkMatrix4x4 *m1, const vtkMatrix4x4 *m2)
 
helper for comparing to matrices More...
 
bool MatrixAreEqual (const vtkMatrix4x4 *matrix, const vtkMatrix3x3 *orientationMatrix)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ReadXMLAttributes (const char **atts) override
 
Set node attributes More...
 
void RemoveAllThreeDViewIDs ()
 
bool RemoveSliceOrientationPreset (const std::string &name)
 Remove an orientation preset. More...
 
void RemoveThreeDViewID (char *viewNodeID)
 
bool RenameSliceOrientationPreset (const std::string &name, const std::string &updatedName)
 Rename an orientation preset. More...
 
void Reset (vtkMRMLNode *defaultNode) override
 Reimplemented to preserve orientation and layout color when reset. More...
 
void ResetInteractionFlagsModifier ()
 
void RotateToAxes (vtkMatrix4x4 *referenceToRAS, int sliceNormalAxisIndex=-1)
 
void RotateToVolumePlane (vtkMRMLVolumeNode *volumeNode)
 
virtual void SetActiveSlice (int)
 
virtual void SetDefaultOrientation (const char *)
 Set default orientation preset name. More...
 
void SetDimensions (int x, int y, int z)
 
void SetFieldOfView (double x, double y, double z)
 
void SetInteracting (int)
 
void SetInteractionFlags (unsigned int)
 
void SetInteractionFlagsModifier (unsigned int)
 
virtual void SetJumpMode (int)
 
void SetJumpModeToCentered ()
 
void SetJumpModeToOffset ()
 
void SetLayoutGrid (int rows, int columns)
 
virtual void SetLayoutGridColumns (int cols)
 
virtual void SetLayoutGridRows (int rows)
 
bool SetOrientation (const char *orientation)
 Set orientation. More...
 
bool SetOrientationToAxial ()
 Set 'standard' radiological convention views of patient space. More...
 
bool SetOrientationToCoronal ()
 
bool SetOrientationToDefault ()
 
bool SetOrientationToSagittal ()
 
virtual void SetPrescribedSliceSpacing (double [3])
 
virtual void SetPrescribedSliceSpacing (double, double, double)
 
void SetSliceOffset (double offset)
 
void SetSliceOrigin (double xyz[3])
 
Origin of slice in XYZ or UVW space depending on SliceResolutionMode More...
 
void SetSliceOrigin (double x, double y, double z)
 
virtual void SetSliceResolutionMode (int mode)
 
method for setting UVW space (extents, dimensions and spacing) More...
 
virtual void SetSliceSpacingMode (int)
 
void SetSliceSpacingModeToAutomatic ()
 
void SetSliceSpacingModeToPrescribed ()
 
void SetSliceToRASByNTP (double Nx, double Ny, double Nz, double Tx, double Ty, double Tz, double Px, double Py, double Pz, int Orientation)
 
virtual void SetSliceVisible (int)
 
virtual void SetUseLabelOutline (int)
 
void SetUVWDimensions (int x, int y, int z)
 
void SetUVWDimensions (int xyz[3])
 
void SetUVWExtents (double x, double y, double z)
 
void SetUVWExtents (double xyz[3])
 
void SetUVWExtentsAndDimensions (double extents[3], int dimensions[3])
 
void SetUVWMaximumDimensions (int x, int y, int z)
 
void SetUVWMaximumDimensions (int xyz[3])
 
void SetUVWOrigin (double x, double y, double z)
 
void SetUVWOrigin (double xyz[3])
 
virtual void SetWidgetNormalLockedToCamera (int)
 
virtual void SetWidgetOutlineVisible (int)
 
virtual void SetWidgetVisible (int)
 
void SetXYZOrigin (double x, double y, double z)
 
void UpdateMatrices ()
 
virtual void UseLabelOutlineOff ()
 
virtual void UseLabelOutlineOn ()
 
void WriteXML (ostream &of, int indent) override
 
Write this node's information to a MRML file in XML format. More...
 
- Public Member Functions inherited from vtkMRMLAbstractViewNode
virtual int GetActive ()
 Indicates whether or not the view is active. More...
 
const char * GetAxisLabel (int labelIndex)
 
virtual double * GetBackgroundColor ()
 
virtual void GetBackgroundColor (double &, double &, double &)
 
virtual void GetBackgroundColor (double [3])
 
virtual double * GetBackgroundColor2 ()
 
virtual void GetBackgroundColor2 (double &, double &, double &)
 
virtual void GetBackgroundColor2 (double [3])
 
vtkMRMLInteractionNodeGetInteractionNode ()
 Get interaction node. More...
 
virtual double * GetLayoutColor ()
 
virtual void GetLayoutColor (double &, double &, double &)
 
virtual void GetLayoutColor (double [3])
 
virtual char * GetLayoutLabel ()
 
const char * GetLayoutName ()
 
virtual bool GetOrientationMarkerEnabled ()
 
vtkMRMLModelNodeGetOrientationMarkerHumanModelNode ()
 
const char * GetOrientationMarkerHumanModelNodeID ()
 
virtual int GetOrientationMarkerSize ()
 
virtual int GetOrientationMarkerType ()
 
vtkMRMLNodeGetParentLayoutNode ()
 
virtual int GetRulerColor ()
 
virtual bool GetRulerEnabled ()
 
virtual int GetRulerType ()
 
virtual int GetViewGroup ()
 
virtual int GetVisibility ()
 Indicates whether or not the view is visible. More...
 
virtual int IsMappedInLayout ()
 
bool IsViewVisibleInLayout ()
 Indicates whether or not the view is visible in the current layout. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void SetActive (int)
 
bool SetAndObserveParentLayoutNode (vtkMRMLNode *node)
 
bool SetAndObserveParentLayoutNodeID (const char *layoutNodeId)
 
void SetAxisLabel (int labelIndex, const char *label)
 
virtual void SetBackgroundColor (double [3])
 
virtual void SetBackgroundColor (double, double, double)
 
virtual void SetBackgroundColor2 (double, double, double)
 
virtual void SetBackgroundColor2 (double [3])
 
bool SetInteractionNode (vtkMRMLNode *node)
 
bool SetInteractionNodeID (const char *interactionNodeId)
 
virtual void SetLayoutColor (double, double, double)
 
virtual void SetLayoutColor (double [3])
 
virtual void SetLayoutLabel (const char *)
 
void SetLayoutName (const char *layoutName)
 
virtual void SetMappedInLayout (int value)
 
void SetOrientationMarkerHumanModelNodeID (const char *modelNodeId)
 
virtual void SetOrientationMarkerSize (int)
 Get/Set orientation marker is size. There are a few predefined marker sizes, defined by an enumerated value (e.g., small, medium, large). More...
 
virtual void SetOrientationMarkerType (int)
 Get/Set orientation marker type (e.g., not displayed, cube, human, coordinate system axes) More...
 
virtual void SetRulerColor (int)
 Get/Set ruler color (e.g., white or black) More...
 
virtual void SetRulerType (int)
 Get/Set ruler type (e.g., not displayed, thin, thick) More...
 
virtual void SetViewGroup (int)
 
virtual void SetVisibility (int)
 
- Public Member Functions inherited from vtkMRMLNode
vtkMRMLNodeAddAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Add and observe a reference node from this node for a specific referenceRole. More...
 
vtkMRMLNodeAddNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Convenience method that adds a referencedNodeID at the end of the list. More...
 
void AddNodeReferenceRole (const char *referenceRole, const char *mrmlAttributeName=nullptr, vtkIntArray *events=nullptr)
 Add a referenceRole. More...
 
virtual void AddToSceneOff ()
 
virtual void AddToSceneOn ()
 
virtual void CopyReferences (vtkMRMLNode *node)
 Copy the references of the node into this. More...
 
void CopyWithoutModifiedEvent (vtkMRMLNode *node)
 
void CopyWithScene (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type. More...
 
void CopyWithSceneWithSingleModifiedEvent (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type. More...
 
void CopyWithSingleModifiedEvent (vtkMRMLNode *node)
 
void DisableModifiedEventOff ()
 
void DisableModifiedEventOn ()
 
virtual int EndModify (int previousDisableModifiedEventState)
 End modifying the node. More...
 
virtual int GetAddToScene ()
 node added to MRML scene. More...
 
const char * GetAttribute (const char *name)
 Get value of a name value pair attribute. More...
 
std::vector< std::string > GetAttributeNames ()
 Get all attribute names. More...
 
void GetAttributeNames (vtkStringArray *attributeNames)
 Get all attribute names. Python-wrappable version. More...
 
virtual char * GetDescription ()
 
virtual int GetDisableModifiedEvent ()
 Turn on/off generating InvokeEvent for set macros. More...
 
virtual int GetHideFromEditors ()
 Describes if the node is hidden. More...
 
virtual char * GetID ()
 ID use by other nodes to reference this node in XML. More...
 
virtual int GetInMRMLCallbackFlag ()
 Flags to avoid event loops. More...
 
virtual int GetModifiedEventPending ()
 
virtual char * GetName ()
 
vtkMRMLNodeGetNodeReference (const char *referenceRole)
 
const char * GetNodeReferenceID (const char *referenceRole)
 Utility function that returns the first node id for a specific referenceRole. More...
 
void GetNodeReferenceIDs (const char *referenceRole, std::vector< const char *> &referencedNodeIDs)
 Return a list of the referenced node IDs. More...
 
void GetNodeReferenceRoles (std::vector< std::string > &roles)
 
void GetNodeReferences (const char *referenceRole, std::vector< vtkMRMLNode *> &nodes)
 Return a list of the referenced nodes. More...
 
vtkMRMLNodeGetNthNodeReference (const char *referenceRole, int n)
 Get referenced MRML node for a specific referenceRole. More...
 
const char * GetNthNodeReferenceID (const char *referenceRole, int n)
 Return the string of the Nth node ID for a specific reference role. More...
 
const char * GetNthNodeReferenceRole (int n)
 
int GetNumberOfNodeReferenceRoles ()
 
int GetNumberOfNodeReferences (const char *referenceRole)
 Return the number of node IDs for a specific reference role (and nodes as they always have the same size). More...
 
virtual int GetSaveWithScene ()
 Save node with MRML scene. More...
 
virtual vtkMRMLSceneGetScene ()
 Get the scene this node has been added to. More...
 
virtual int GetSelectable ()
 Describes if the node is selectable. More...
 
virtual int GetSelected ()
 Get/Set for Selected. More...
 
virtual char * GetSingletonTag ()
 
virtual bool GetUndoEnabled ()
 
bool HasNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Return true if referencedNodeID is in the node ID list for a specific referenceRole. More...
 
virtual void HideFromEditorsOff ()
 
virtual void HideFromEditorsOn ()
 
virtual void InvokeCustomModifiedEvent (int eventId, void *callData=nullptr)
 This method allows the node to compress events. More...
 
virtual int InvokePendingModifiedEvent ()
 Invokes any modified events that are pending. More...
 
bool IsSingleton ()
 
void Modified () override
 Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent. More...
 
virtual void OnNodeAddedToScene ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void ProcessChildNode (vtkMRMLNode *)
 Set dependencies between this node and a child node when parsing XML file. More...
 
virtual void ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData)
 Propagate events generated in mrml. 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 SaveWithSceneOff ()
 
virtual void SaveWithSceneOn ()
 
virtual void SelectableOff ()
 
virtual void SelectableOn ()
 
virtual void SelectedOff ()
 
virtual void SelectedOn ()
 
virtual void SetAddToScene (int)
 
void SetAddToSceneNoModify (int value)
 
vtkMRMLNodeSetAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Set and observe a reference node from this node for a specific referenceRole. More...
 
vtkMRMLNodeSetAndObserveNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Set and observe the Nth node ID for a specific reference role. More...
 
void SetAttribute (const char *name, const char *value)
 Set a name value pair attribute. More...
 
virtual void SetDescription (const char *)
 Text description of this node, to be set by the user. More...
 
void SetDisableModifiedEvent (int onOff)
 
virtual void SetHideFromEditors (int)
 
void SetInMRMLCallbackFlag (int flag)
 
virtual void SetName (const char *)
 Name of this node, to be set by the user. More...
 
vtkMRMLNodeSetNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Set a reference to a node with specified nodeID from this node for a specific referenceRole. More...
 
vtkMRMLNodeSetNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID)
 Set a N-th reference from this node with specified referencedNodeID for a specific referenceRole. More...
 
virtual void SetSaveWithScene (int)
 
virtual void SetScene (vtkMRMLScene *scene)
 This method is for internal use only. Use AddNode method of vtkMRMLScene to add a node to the scene. More...
 
virtual void SetSceneReferences ()
 Update the references of the node to the scene. More...
 
virtual void SetSelectable (int)
 
virtual void SetSelected (int)
 
void SetSingletonOff ()
 
void SetSingletonOn ()
 
virtual void SetSingletonTag (const char *)
 Tag that make this node a singleton in the scene. More...
 
virtual void SetUndoEnabled (bool)
 
virtual int StartModify ()
 Start modifying the node. Disable Modify events. More...
 
virtual void UndoEnabledOff ()
 
virtual void UndoEnabledOn ()
 
virtual void UpdateReferenceID (const char *oldID, const char *newID)
 Update the stored reference to another node in the scene. More...
 
virtual void UpdateReferences ()
 The method should remove all pointers and observations to all nodes that are not in the scene anymore. More...
 
virtual void UpdateScene (vtkMRMLScene *)
 
const char * URLDecodeString (const char *inString)
 Decode a URL string. More...
 
const char * URLEncodeString (const char *inString)
 Encode a URL string. More...
 
virtual void WriteNodeBodyXML (ostream &of, int indent)
 Write this node's body to a MRML file in XML format. More...
 
std::string XMLAttributeDecodeString (const std::string &inString)
 Decode an XML attribute string. More...
 
std::string XMLAttributeEncodeString (const std::string &inString)
 Encode an XML attribute string (replaces special characters by code sequences) More...
 

Static Public Member Functions

static void AddDefaultSliceOrientationPresets (vtkMRMLScene *scene)
 Add default slice orientation presets to scene. More...
 
static const char * GetReformatOrientationName ()
 
static void InitializeAxialMatrix (vtkMatrix3x3 *orientationMatrix)
 Initialize orientationMatrix as an Axial orientation matrix. More...
 
static void InitializeCoronalMatrix (vtkMatrix3x3 *orientationMatrix)
 Initialize orientationMatrix as a Coronal orientation matrix. More...
 
static void InitializeSagittalMatrix (vtkMatrix3x3 *orientationMatrix)
 Initialize orientationMatrix as a Sagittal orientation matrix. More...
 
static int IsTypeOf (const char *type)
 
static void JumpAllSlices (vtkMRMLScene *scene, double r, double a, double s, int jumpMode=vtkMRMLSliceNode::DefaultJumpSlice, int viewGroup=-1, vtkMRMLSliceNode *exclude=nullptr)
 
static vtkMRMLSliceNodeNew ()
 Instantiate a new Slice node without any orientation presets. More...
 
static vtkMRMLSliceNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLAbstractViewNode
static double * GetCompareColor ()
 
static double * GetGrayColor ()
 
static double * GetGreenColor ()
 
static const char * GetOrientationMarkerSizeAsString (int id)
 Convert between orientation marker type ID and name. More...
 
static int GetOrientationMarkerSizeFromString (const char *name)
 
static const char * GetOrientationMarkerTypeAsString (int id)
 Convert between orientation marker type ID and name. More...
 
static int GetOrientationMarkerTypeFromString (const char *name)
 
static double * GetRedColor ()
 
static const char * GetRulerColorAsString (int id)
 Convert between ruler color ID and name. More...
 
static int GetRulerColorFromString (const char *name)
 
static const char * GetRulerTypeAsString (int id)
 Convert between ruler type ID and name. More...
 
static int GetRulerTypeFromString (const char *name)
 
static double * GetThreeDViewBlueColor ()
 
static double * GetYellowColor ()
 
static int IsTypeOf (const char *type)
 
static vtkMRMLAbstractViewNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (vtkObject *o)
 

Protected Types

typedef std::pair< std::string, vtkSmartPointer< vtkMatrix3x3 > > OrientationPresetType
 
- 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
 

Protected Member Functions

virtual char * GetOrientationReference ()
 
void operator= (const vtkMRMLSliceNode &)
 
virtual void SetOrientationReference (const char *)
 
 vtkMRMLSliceNode ()
 
 vtkMRMLSliceNode (const vtkMRMLSliceNode &)
 
 ~vtkMRMLSliceNode () override
 
- Protected Member Functions inherited from vtkMRMLAbstractViewNode
void operator= (const vtkMRMLAbstractViewNode &)
 
 vtkMRMLAbstractViewNode ()
 
 vtkMRMLAbstractViewNode (const vtkMRMLAbstractViewNode &)
 
 ~vtkMRMLAbstractViewNode () override
 
- Protected Member Functions inherited from vtkMRMLNode
virtual const char * GetMRMLAttributeNameFromReferenceRole (const char *refRole)
 Return the mrml attribute name (if found) associated with a reference role. Return 0 otherwise. More...
 
virtual const char * GetReferenceRoleFromMRMLAttributeName (const char *attName)
 Return the reference role (if found) associated with the attribute name found in a MRML scene file. Return 0 otherwise. More...
 
virtual char * GetTempURLString ()
 
void GetUpdatedReferencedNodeEventList (int &oldReferencedNodeUseCount, int &newReferencedNodeUseCount, vtkIntArray *oldConsolidatedEventList, vtkIntArray *newConsolidatedEventList, vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkMRMLNodeReference *referenceToIgnore, vtkIntArray *newEvents)
 
virtual void InvalidateNodeReferences ()
 
virtual bool IsReferenceRoleGeneric (const char *refRole)
 Return true if the reference role is generic (ends with '/') or false otherwise. More...
 
virtual void OnNodeReferenceAdded (vtkMRMLNodeReference *reference)
 
virtual void OnNodeReferenceModified (vtkMRMLNodeReference *reference)
 Called when a referenced node pointer is modified. More...
 
virtual void OnNodeReferenceRemoved (vtkMRMLNodeReference *reference)
 Called when a referenced node pointer is removed (set to nullptr). More...
 
void operator= (const vtkMRMLNode &)
 
void ParseReferencesAttribute (const char *attValue, std::map< std::string, std::string > &references)
 
virtual void SetTempURLString (const char *)
 Get/Set the string used to manage encoding/decoding of strings/URLs with special characters. More...
 
vtkMRMLNodeUpdateNodeReferenceEventObserver (vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkIntArray *newEvents, vtkMRMLNodeReference *referenceToIgnore)
 
virtual void UpdateNodeReferences (const char *referenceRole=nullptr)
 
virtual void UpdateNthNodeReference (const char *referenceRole, int n)
 
 vtkMRMLNode ()
 
 vtkMRMLNode (const vtkMRMLNode &)
 
 ~vtkMRMLNode () override
 critical to have a virtual destructor! More...
 

Protected Attributes

int ActiveSlice
 
char * DefaultOrientation
 
int Dimensions [3]
 
double FieldOfView [3]
 
int Interacting
 
unsigned int InteractionFlags
 
unsigned int InteractionFlagsModifier
 
int IsUpdatingMatrices
 
int JumpMode
 
int LayoutGridColumns
 
int LayoutGridRows
 
std::vector< OrientationPresetTypeOrientationMatrices
 
char * OrientationReference
 
std::string OrientationString
 
double PrescribedSliceSpacing [3]
 
int SliceResolutionMode
 
int SliceSpacingMode
 
vtkSmartPointer< vtkMatrix4x4 > SliceToRAS
 
int SliceVisible
 
std::vector< std::string > ThreeDViewIDs
 
int UseLabelOutline
 
int UVWDimensions [3]
 
double UVWExtents [3]
 
int UVWMaximumDimensions [3]
 
double UVWOrigin [3]
 
vtkSmartPointer< vtkMatrix4x4 > UVWToRAS
 
vtkSmartPointer< vtkMatrix4x4 > UVWToSlice
 
int WidgetNormalLockedToCamera
 
int WidgetOutlineVisible
 
int WidgetVisible
 
vtkSmartPointer< vtkMatrix4x4 > XYToRAS
 
vtkSmartPointer< vtkMatrix4x4 > XYToSlice
 
double XYZOrigin [3]
 
- Protected Attributes inherited from vtkMRMLAbstractViewNode
int Active
 
vtkSmartPointer< vtkStringArray > AxisLabels
 
Labels of coordinate system axes More...
 
double BackgroundColor [3]
 
Background colors More...
 
double BackgroundColor2 [3]
 
double LayoutColor [3]
 
Color for view header in layout as RGB More...
 
char * LayoutLabel
 
Label to show for the view (shortcut for the name) More...
 
bool OrientationMarkerEnabled
 
int OrientationMarkerSize
 
int OrientationMarkerType
 
int RulerColor
 
bool RulerEnabled
 
int RulerType
 
int ViewGroup
 
Views with the same ViewGroup value are in the same group. More...
 
int Visibility
 
- Protected Attributes inherited from vtkMRMLNode
int AddToScene
 
AttributesType Attributes
 
char * Description
 
int HideFromEditors
 
char * ID
 
int InMRMLCallbackFlag
 
Flag to avoid event loops More...
 
vtkCallbackCommand * MRMLCallbackCommand
 Holders for MRML callbacks. More...
 
vtkObserverManagerMRMLObserverManager
 
char * Name
 
NodeReferenceEventsType NodeReferenceEvents
 
std::map< std::string, std::string > NodeReferenceMRMLAttributeNames
 
NodeReferencesType NodeReferences
 
int SaveWithScene
 
vtkWeakPointer< vtkMRMLSceneScene
 
int Selectable
 
int Selected
 
bool UndoEnabled
 

Additional Inherited Members

- Static Public Attributes inherited from vtkMRMLAbstractViewNode
static const int AxisLabelsCount
 Total number of coordinate system axis labels. More...
 
- Static Protected Member Functions inherited from vtkMRMLNode
static void MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 
- Static Protected Attributes inherited from vtkMRMLAbstractViewNode
static const char * InteractionNodeReferenceRole
 
static const char * OrientationMarkerHumanModelReferenceRole
 
static const char * ParentLayoutNodeReferenceRole
 

Detailed Description

MRML node for storing a slice through RAS space.

This node stores the information about how to map from RAS space to the desired slice plane.

Definition at line 32 of file vtkMRMLSliceNode.h.

Member Typedef Documentation

◆ OrientationPresetType

typedef std::pair<std::string, vtkSmartPointer<vtkMatrix3x3> > vtkMRMLSliceNode::OrientationPresetType
protected

Definition at line 529 of file vtkMRMLSliceNode.h.

◆ Superclass

Definition at line 42 of file vtkMRMLSliceNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enum to specify the method of jumping slices.

Enumerator
DefaultJumpSlice 
CenteredJumpSlice 
OffsetJumpSlice 

Definition at line 381 of file vtkMRMLSliceNode.h.

◆ anonymous enum

anonymous enum

Enum to specify whether the slice spacing is automatically determined or prescribed

Enumerator
AutomaticSliceSpacingMode 
PrescribedSliceSpacingMode 

Definition at line 395 of file vtkMRMLSliceNode.h.

◆ InteractionFlagType

Enum identifying the parameters being manipulated with calls to InteractionOn() and InteractionOff(). Identifiers are powers of two so they can be combined into a bitmask to manipulate multiple parameters. The meanings for the flags are: SliceToRASFlag - broadcast the SliceToRAS matrix to all linked viewers FieldOfViewFlag - broadcast a specific field of view setting OrientationFlag - broadcast the orientation ResetFieldOfViewFlag - broadcast a message to reset the field of view MultiplanarReformatFlag - broadcast reformat widget transformation XYZOriginFlag - broadcast the XYZOrigin to all linked viewers LabelOutlineFlag - broadcast outlining the labelmaps SliceVisibleFlag = broadcast display of slice in 3D ResetOrientationFlag = broadcast a reset to default orientation to all linked viewers

Enumerator
None 
SliceToRASFlag 
FieldOfViewFlag 
OrientationFlag 
ResetFieldOfViewFlag 
MultiplanarReformatFlag 
XYZOriginFlag 
LabelOutlineFlag 
SliceVisibleFlag 
SliceSpacingFlag 
ResetOrientationFlag 

Definition at line 461 of file vtkMRMLSliceNode.h.

◆ SliceResolutionModeType

Enum to specify the method for setting UVW extents.

Enumerator
SliceResolutionMatchVolumes 
SliceResolutionMatch2DView 
SliceFOVMatch2DViewSpacingMatchVolumes 
SliceFOVMatchVolumesSpacingMatch2DView 
SliceResolutionCustom 

Definition at line 501 of file vtkMRMLSliceNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLSliceNode() [1/2]

vtkMRMLSliceNode::vtkMRMLSliceNode ( )
protected

◆ ~vtkMRMLSliceNode()

vtkMRMLSliceNode::~vtkMRMLSliceNode ( )
overrideprotected

◆ vtkMRMLSliceNode() [2/2]

vtkMRMLSliceNode::vtkMRMLSliceNode ( const vtkMRMLSliceNode )
protected

Member Function Documentation

◆ AddDefaultSliceOrientationPresets()

static void vtkMRMLSliceNode::AddDefaultSliceOrientationPresets ( vtkMRMLScene scene)
static

◆ AddSliceOrientationPreset()

bool vtkMRMLSliceNode::AddSliceOrientationPreset ( const std::string &  name,
vtkMatrix3x3 *  orientationMatrix 
)

◆ AddThreeDViewID()

void vtkMRMLSliceNode::AddThreeDViewID ( const char *  viewNodeID)

Add View Node ID for the view to display this node in.

See also
ViewNodeIDs, RemoveViewNodeID(), RemoveAllViewNodeIDs()

◆ Copy()

void vtkMRMLSliceNode::Copy ( vtkMRMLNode node)
overridevirtual


Copy the node's attributes to this object

Reimplemented from vtkMRMLAbstractViewNode.

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLSliceNode::CreateNodeInstance ( )
overridevirtual

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

Note
Subclasses should implement this method

Implements vtkMRMLNode.

◆ GetActiveSlice()

virtual int vtkMRMLSliceNode::GetActiveSlice ( )
virtual

◆ GetClassName()

virtual const char* vtkMRMLSliceNode::GetClassName ( )
virtual

Reimplemented from vtkMRMLAbstractViewNode.

◆ GetDefaultOrientation()

virtual char* vtkMRMLSliceNode::GetDefaultOrientation ( )
virtual

◆ GetDimensions() [1/2]

virtual int* vtkMRMLSliceNode::GetDimensions ( )
virtual

Number of samples in each direction – note that the spacing is implicitly FieldOfView / Dimensions

◆ GetDimensions() [2/2]

virtual void vtkMRMLSliceNode::GetDimensions ( int  data[3])
virtual

◆ GetFieldOfView() [1/3]

virtual double* vtkMRMLSliceNode::GetFieldOfView ( )
virtual


Size of the slice plane in millimeters

◆ GetFieldOfView() [2/3]

virtual void vtkMRMLSliceNode::GetFieldOfView ( double  [3])
virtual

◆ GetFieldOfView() [3/3]

virtual void vtkMRMLSliceNode::GetFieldOfView ( double &  ,
double &  ,
double &   
)
virtual

◆ GetInteracting()

virtual int vtkMRMLSliceNode::GetInteracting ( )
virtual

◆ GetInteractionFlags()

virtual unsigned int vtkMRMLSliceNode::GetInteractionFlags ( )
virtual

◆ GetInteractionFlagsModifier()

virtual unsigned int vtkMRMLSliceNode::GetInteractionFlagsModifier ( )
virtual

◆ GetJumpMode()

virtual int vtkMRMLSliceNode::GetJumpMode ( )
virtual

◆ GetLayoutGridColumns()

virtual int vtkMRMLSliceNode::GetLayoutGridColumns ( )
virtual


Set/Get the number of columns to use ina LightBox display

◆ GetLayoutGridRows()

virtual int vtkMRMLSliceNode::GetLayoutGridRows ( )
virtual


Set/Get the number of rows to use ina LightBox display

◆ GetNodeTagName()

const char* vtkMRMLSliceNode::GetNodeTagName ( )
inlineoverridevirtual


Get node XML tag name (like Volume, Model)

Implements vtkMRMLNode.

Definition at line 66 of file vtkMRMLSliceNode.h.

◆ GetNthThreeDViewID()

const char* vtkMRMLSliceNode::GetNthThreeDViewID ( unsigned int  index)

Get View Node ID's for the view to display this node in. If nullptr, display in all views

See also
ThreeDViewIDs, GetThreeDViewIDs(), AddThreeDViewID()

◆ GetNumberOfSliceOrientationPresets()

int vtkMRMLSliceNode::GetNumberOfSliceOrientationPresets ( ) const

◆ GetNumberOfThreeDViewIDs()

int vtkMRMLSliceNode::GetNumberOfThreeDViewIDs ( ) const

Get number of View Node ID's for the view to display this node in. If 0, display in all views

See also
ThreeDViewIDs, GetThreeDViewIDs(), AddThreeDViewID()

◆ GetOrientation() [1/2]

std::string vtkMRMLSliceNode::GetOrientation ( )

Get orientation.

It returns a string with a description of the slice orientation

See also
GetOrientation(vtkMatrix4x4* sliceToRAS)
SetOrientation(const char* orientation)

◆ GetOrientation() [2/2]

std::string vtkMRMLSliceNode::GetOrientation ( vtkMatrix4x4 *  sliceToRAS)

Return the orientation name associated with sliceToRAS.

◆ GetOrientationReference()

virtual char* vtkMRMLSliceNode::GetOrientationReference ( )
protectedvirtual

The OrientationReference is a place to store the last orientation that was explicitly selected.

Deprecated:

◆ GetOrientationString()

virtual const char* vtkMRMLSliceNode::GetOrientationString ( )
virtual

Get orientation.

Deprecated:
Prefer GetOrientation()

◆ GetPrescribedSliceSpacing() [1/3]

virtual double* vtkMRMLSliceNode::GetPrescribedSliceSpacing ( )
virtual

◆ GetPrescribedSliceSpacing() [2/3]

virtual void vtkMRMLSliceNode::GetPrescribedSliceSpacing ( double &  ,
double &  ,
double &   
)
virtual

◆ GetPrescribedSliceSpacing() [3/3]

virtual void vtkMRMLSliceNode::GetPrescribedSliceSpacing ( double  [3])
virtual

◆ GetReformatOrientationName()

static const char* vtkMRMLSliceNode::GetReformatOrientationName ( )
inlinestatic

Returns the name of "Reformat" orientation, which means that it is none of the known orientations.

Definition at line 231 of file vtkMRMLSliceNode.h.

◆ GetSliceOffset()

double vtkMRMLSliceNode::GetSliceOffset ( )


Get/Set the current distance from the origin to the slice plane

◆ GetSliceOrientationPreset()

vtkMatrix3x3* vtkMRMLSliceNode::GetSliceOrientationPreset ( const std::string &  name)

Return the sliceToRAS matrix associated with name.

◆ GetSliceOrientationPresetName()

std::string vtkMRMLSliceNode::GetSliceOrientationPresetName ( vtkMatrix3x3 *  orientationMatrix)

Return the preset name corresponding to orientationMatrix.

Returns an empty string if orientationMatrix is not an existing preset.

◆ GetSliceOrientationPresetNames()

void vtkMRMLSliceNode::GetSliceOrientationPresetNames ( vtkStringArray *  presetOrientationNames)

Return all the orientation preset names.

◆ GetSliceResolutionMode()

virtual int vtkMRMLSliceNode::GetSliceResolutionMode ( )
virtual

◆ GetSliceSpacingMode()

virtual int vtkMRMLSliceNode::GetSliceSpacingMode ( )
virtual

Get/Set the slice spacing mode. Slice spacing can be automatically calculated using GetLowestVolumeSliceSpacing() or prescribed

◆ GetSliceToRAS()

virtual vtkMatrix4x4* vtkMRMLSliceNode::GetSliceToRAS ( )
virtual

Mapping from RAS space onto the slice plane This matrix is allowed to be modified from outside, for example by calling sliceNode->GetSliceToRAS->DeepCopy(...) followed by sliceNode->UpdateMatrices(). TODO: maybe this should be a quaternion and a translate to avoid shears/scales

◆ GetSliceVisible()

virtual int vtkMRMLSliceNode::GetSliceVisible ( )
virtual


The visibility of the slice in the 3DViewer.

◆ GetThreeDViewIDs()

std::vector< std::string > vtkMRMLSliceNode::GetThreeDViewIDs ( ) const
inline

Get all View Node ID's for the view to display this node in. If empty, display in all views

See also
ThreeDViewIDs, GetNthThreeDViewID(), AddThreeDViewID()

Definition at line 575 of file vtkMRMLSliceNode.h.

◆ GetUseLabelOutline()

virtual int vtkMRMLSliceNode::GetUseLabelOutline ( )
virtual


Use the label outline filter on this slice?

◆ GetUVWDimensions() [1/2]

virtual int* vtkMRMLSliceNode::GetUVWDimensions ( )
virtual

Number of samples in each direction for the reslice operation – this is the resolution that each slice layer is resliced into – the outputs of the slice layers are then composited and upsampled to the full Dimensions – note that z, the number of slices, should be the same for both Dimensions and UVWDimensions

◆ GetUVWDimensions() [2/2]

virtual void vtkMRMLSliceNode::GetUVWDimensions ( int  data[3])
virtual

◆ GetUVWExtents() [1/3]

virtual double* vtkMRMLSliceNode::GetUVWExtents ( )
virtual


Get/Set maximum extent in any direction occupied by slice

◆ GetUVWExtents() [2/3]

virtual void vtkMRMLSliceNode::GetUVWExtents ( double &  ,
double &  ,
double &   
)
virtual

◆ GetUVWExtents() [3/3]

virtual void vtkMRMLSliceNode::GetUVWExtents ( double  [3])
virtual

◆ GetUVWMaximumDimensions() [1/2]

virtual int* vtkMRMLSliceNode::GetUVWMaximumDimensions ( )
virtual

maximum limit for UVWDimensions

◆ GetUVWMaximumDimensions() [2/2]

virtual void vtkMRMLSliceNode::GetUVWMaximumDimensions ( int  data[3])
virtual

◆ GetUVWOrigin() [1/3]

virtual double* vtkMRMLSliceNode::GetUVWOrigin ( )
virtual


Origin of UVW window

◆ GetUVWOrigin() [2/3]

virtual void vtkMRMLSliceNode::GetUVWOrigin ( double &  ,
double &  ,
double &   
)
virtual

◆ GetUVWOrigin() [3/3]

virtual void vtkMRMLSliceNode::GetUVWOrigin ( double  [3])
virtual

◆ GetUVWToRAS()

vtkMatrix4x4* vtkMRMLSliceNode::GetUVWToRAS ( )

Matrix mapping from UVW texture coordinates into RAS world coordinates

◆ GetUVWToSlice()

vtkMatrix4x4* vtkMRMLSliceNode::GetUVWToSlice ( )

Matrix mapping from UVW texture coordinates into slice coordinates in mm

◆ GetWidgetNormalLockedToCamera()

virtual int vtkMRMLSliceNode::GetWidgetNormalLockedToCamera ( )
virtual

The ImpplicitePlane widget mode this lock the normal of the plane to the camera's one

◆ GetWidgetOutlineVisible()

virtual int vtkMRMLSliceNode::GetWidgetOutlineVisible ( )
virtual

The visibility of the slice plane widget outline in the 3DViewer.

◆ GetWidgetVisible()

virtual int vtkMRMLSliceNode::GetWidgetVisible ( )
virtual


The visibility of the slice plane widget in the 3DViewer.

◆ GetXYToRAS()

vtkMatrix4x4* vtkMRMLSliceNode::GetXYToRAS ( )

Matrix mapping from XY pixel coordinates on an image window into RAS world coordinates

◆ GetXYToSlice()

vtkMatrix4x4* vtkMRMLSliceNode::GetXYToSlice ( )

Matrix mapping from XY pixel coordinates on an image window into slice coordinates in mm

◆ GetXYZOrigin() [1/3]

virtual void vtkMRMLSliceNode::GetXYZOrigin ( double &  ,
double &  ,
double &   
)
virtual

◆ GetXYZOrigin() [2/3]

virtual void vtkMRMLSliceNode::GetXYZOrigin ( double  [3])
virtual

◆ GetXYZOrigin() [3/3]

virtual double* vtkMRMLSliceNode::GetXYZOrigin ( )
virtual


Origin of XYZ window

◆ HasSliceOrientationPreset()

bool vtkMRMLSliceNode::HasSliceOrientationPreset ( const std::string &  name)

Return True if an orientation preset is stored.

See also
AddSliceOrientationPreset(const std::string& name, vtkMatrix4x4* sliceToRAS)

◆ InitializeAxialMatrix()

static void vtkMRMLSliceNode::InitializeAxialMatrix ( vtkMatrix3x3 *  orientationMatrix)
static

Initialize orientationMatrix as an Axial orientation matrix.

◆ InitializeCoronalMatrix()

static void vtkMRMLSliceNode::InitializeCoronalMatrix ( vtkMatrix3x3 *  orientationMatrix)
static

Initialize orientationMatrix as a Coronal orientation matrix.

◆ InitializeSagittalMatrix()

static void vtkMRMLSliceNode::InitializeSagittalMatrix ( vtkMatrix3x3 *  orientationMatrix)
static

Initialize orientationMatrix as a Sagittal orientation matrix.

◆ InteractingOff()

virtual void vtkMRMLSliceNode::InteractingOff ( )
virtual

◆ InteractingOn()

virtual void vtkMRMLSliceNode::InteractingOn ( )
virtual

◆ IsA()

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

Reimplemented from vtkMRMLAbstractViewNode.

◆ IsDisplayableInThreeDView()

bool vtkMRMLSliceNode::IsDisplayableInThreeDView ( const char *  viewNodeID) const

Returns true if the ThreeDViewID is present in the ThreeDViewId list or there is no ThreeDViewId in the list (meaning all the views display the node)

See also
ThreeDViewIDs, IsThreeDViewIDPresent(), AddThreeDViewID()

◆ IsThreeDViewIDPresent()

bool vtkMRMLSliceNode::IsThreeDViewIDPresent ( const char *  ThreeDViewID) const

True if the view node id is present in the ThreeDViewid list false if not found

See also
ThreeDViewIDs, IsDisplayableInView(), AddThreeDViewID()

◆ IsTypeOf()

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

◆ JumpAllSlices() [1/2]

void vtkMRMLSliceNode::JumpAllSlices ( double  r,
double  a,
double  s 
)

◆ JumpAllSlices() [2/2]

static void vtkMRMLSliceNode::JumpAllSlices ( vtkMRMLScene scene,
double  r,
double  a,
double  s,
int  jumpMode = vtkMRMLSliceNode::DefaultJumpSlice,
int  viewGroup = -1,
vtkMRMLSliceNode exclude = nullptr 
)
static

Jump all slices in the scene. viewGroup can be used to jump only slice views that are in a specific group. By default viewGroup is set to -1, which means that all slice views are jumped. If a non-nullptr exclude pointer is specified then position of that slice node will not be changed. If jumpMode is set to vtkMRMLSliceNode::DefaultJumpSlice then jump mode set in the slice node will be used. specified in the slice node will be used.

◆ JumpSlice()

void vtkMRMLSliceNode::JumpSlice ( double  r,
double  a,
double  s 
)

Set the RAS offset of the Slice to the passed values. JumpSlice and JumpAllSlices use the JumpMode to determine how to jump.

◆ JumpSliceByCentering()

void vtkMRMLSliceNode::JumpSliceByCentering ( double  r,
double  a,
double  s 
)

◆ JumpSliceByOffsetting() [1/2]

void vtkMRMLSliceNode::JumpSliceByOffsetting ( double  r,
double  a,
double  s 
)

◆ JumpSliceByOffsetting() [2/2]

void vtkMRMLSliceNode::JumpSliceByOffsetting ( int  k,
double  r,
double  a,
double  s 
)

◆ MatrixAreEqual() [1/2]

bool vtkMRMLSliceNode::MatrixAreEqual ( const vtkMatrix4x4 *  m1,
const vtkMatrix4x4 *  m2 
)


helper for comparing to matrices

◆ MatrixAreEqual() [2/2]

bool vtkMRMLSliceNode::MatrixAreEqual ( const vtkMatrix4x4 *  matrix,
const vtkMatrix3x3 *  orientationMatrix 
)

◆ New()

static vtkMRMLSliceNode* vtkMRMLSliceNode::New ( )
static

Instantiate a new Slice node without any orientation presets.

Note
To instantiate a vtkMRMLSliceNode with preconfigured orientation preset matrices (the default presets are: Axial, Sagittal and Coronal in default), it is necessary to use vtkMRMLScene::CreateNodeByClass(const char*)

◆ operator=()

void vtkMRMLSliceNode::operator= ( const vtkMRMLSliceNode )
protected

◆ PrintSelf()

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

◆ ReadXMLAttributes()

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


Set node attributes

Reimplemented from vtkMRMLAbstractViewNode.

◆ RemoveAllThreeDViewIDs()

void vtkMRMLSliceNode::RemoveAllThreeDViewIDs ( )

Remove All View Node IDs for the views to display this node in.

See also
ViewNodeIDs, AddThreeDViewID(), RemoveThreeDViewID()

◆ RemoveSliceOrientationPreset()

bool vtkMRMLSliceNode::RemoveSliceOrientationPreset ( const std::string &  name)

Remove an orientation preset.

See also
AddSliceOrientationPreset(const std::string& name, vtkMatrix4x4* sliceToRAS)

◆ RemoveThreeDViewID()

void vtkMRMLSliceNode::RemoveThreeDViewID ( char *  viewNodeID)

Remove View Node ID for the view to display this node in.

See also
ViewNodeIDs, AddViewNodeID(), RemoveAllViewNodeIDs()

◆ RenameSliceOrientationPreset()

bool vtkMRMLSliceNode::RenameSliceOrientationPreset ( const std::string &  name,
const std::string &  updatedName 
)

Rename an orientation preset.

See also
AddSliceOrientationPreset(const std::string& name, vtkMatrix4x4* sliceToRAS)

◆ Reset()

void vtkMRMLSliceNode::Reset ( vtkMRMLNode defaultNode)
overridevirtual

Reimplemented to preserve orientation and layout color when reset.

See also
GetOrientationString()
GetLayoutColor()

Reimplemented from vtkMRMLAbstractViewNode.

◆ ResetInteractionFlagsModifier()

void vtkMRMLSliceNode::ResetInteractionFlagsModifier ( )

Set all flags of the modifier to 1, resulting in the default linking behavior (broadcast of the updates to the parameters defined by the InteractionFlagType enum).

◆ RotateToAxes()

void vtkMRMLSliceNode::RotateToAxes ( vtkMatrix4x4 *  referenceToRAS,
int  sliceNormalAxisIndex = -1 
)

Adjusts the slice node to align with the axes of the provided reference coordinate system so that no oblique resampling occurs when rendering (helps to see original acquisition data and for obluique volumes with few slices). If sliceNormalAxisIndex is >=0 then slice plane normal will be aligned with that axis.

◆ RotateToVolumePlane()

void vtkMRMLSliceNode::RotateToVolumePlane ( vtkMRMLVolumeNode volumeNode)

Adjusts the slice node to align with the native space of the image data so that no oblique resampling occurs when rendering (helps to see original acquisition data and for oblique volumes with few slices). For single-slice volume, slice normal is aligned to the volume plane's normal.

◆ SafeDownCast()

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

◆ SetActiveSlice()

virtual void vtkMRMLSliceNode::SetActiveSlice ( int  )
virtual

Set/get the active slice in the lightbox. The active slice is shown in the 3D scene

◆ SetDefaultOrientation()

virtual void vtkMRMLSliceNode::SetDefaultOrientation ( const char *  )
virtual

Set default orientation preset name.

If slice view orientation is reset is requested then orientation is set to this preset.

◆ SetDimensions()

void vtkMRMLSliceNode::SetDimensions ( int  x,
int  y,
int  z 
)

◆ SetFieldOfView()

void vtkMRMLSliceNode::SetFieldOfView ( double  x,
double  y,
double  z 
)

◆ SetInteracting()

void vtkMRMLSliceNode::SetInteracting ( int  )

Get/Set a flag indicating whether this node is actively being manipulated (usually) by a user interface. This flag is used by logic classes to determine whether state changes should be propagated to other nodes to implement linked controls. Does not cause a Modified().

◆ SetInteractionFlags()

void vtkMRMLSliceNode::SetInteractionFlags ( unsigned  int)

Get/Set a flag indicating what parameters are being manipulated within calls to InteractingOn() and InteractingOff(). These fields are used to propagate linked behaviors. This flag is a bitfield, with multiple parameters OR'd to compose the flag. Does not cause a Modified().

◆ SetInteractionFlagsModifier()

void vtkMRMLSliceNode::SetInteractionFlagsModifier ( unsigned  int)

Get/Set a flag indicating how the linking behavior should be modified. InteractionFlags modifier uses bits defined by InteractionFlagType enum that by default are all set and result in the default behavior. If a bit is not set, this will result in slice node interactions not broadcast.

◆ SetJumpMode()

virtual void vtkMRMLSliceNode::SetJumpMode ( int  )
virtual

Control how JumpSlice operates. CenteredJumpMode puts the specified RAS position in the center of the slice. OffsetJumpMode does not change the slice position, merely adjusts the slice offset to get the RAS position on the slice.

◆ SetJumpModeToCentered()

void vtkMRMLSliceNode::SetJumpModeToCentered ( )

◆ SetJumpModeToOffset()

void vtkMRMLSliceNode::SetJumpModeToOffset ( )

◆ SetLayoutGrid()

void vtkMRMLSliceNode::SetLayoutGrid ( int  rows,
int  columns 
)

Set the number of rows and columns to use in a LightBox display of the node

◆ SetLayoutGridColumns()

virtual void vtkMRMLSliceNode::SetLayoutGridColumns ( int  cols)
virtual

◆ SetLayoutGridRows()

virtual void vtkMRMLSliceNode::SetLayoutGridRows ( int  rows)
virtual

◆ SetOrientation()

bool vtkMRMLSliceNode::SetOrientation ( const char *  orientation)

Set orientation.

It adjusts the SliceToRAS matrix to position the slice cutting plane.

Valid orientations are known as presets and are easily added, removed or renamed.

See also
AddSliceOrientationPreset(const std::string& name, vtkMatrix4x4* sliceToRAS)
UpdateMatrices()

◆ SetOrientationReference()

virtual void vtkMRMLSliceNode::SetOrientationReference ( const char *  )
protectedvirtual

◆ SetOrientationToAxial()

bool vtkMRMLSliceNode::SetOrientationToAxial ( )

Set 'standard' radiological convention views of patient space.

If the associated orientation preset has been renamed or removed, calling these function returns False.

See also
SetOrientation(const char*)

◆ SetOrientationToCoronal()

bool vtkMRMLSliceNode::SetOrientationToCoronal ( )

◆ SetOrientationToDefault()

bool vtkMRMLSliceNode::SetOrientationToDefault ( )

Set slice orientation to that is defined in DefaultOrientation. Returns true on success.

◆ SetOrientationToSagittal()

bool vtkMRMLSliceNode::SetOrientationToSagittal ( )

◆ SetPrescribedSliceSpacing() [1/2]

virtual void vtkMRMLSliceNode::SetPrescribedSliceSpacing ( double  [3])
virtual

◆ SetPrescribedSliceSpacing() [2/2]

virtual void vtkMRMLSliceNode::SetPrescribedSliceSpacing ( double  ,
double  ,
double   
)
virtual

Set/get the slice spacing to use when the SliceSpacingMode is "Prescribed"

◆ SetSliceOffset()

void vtkMRMLSliceNode::SetSliceOffset ( double  offset)

◆ SetSliceOrigin() [1/2]

void vtkMRMLSliceNode::SetSliceOrigin ( double  xyz[3])


Origin of slice in XYZ or UVW space depending on SliceResolutionMode

◆ SetSliceOrigin() [2/2]

void vtkMRMLSliceNode::SetSliceOrigin ( double  x,
double  y,
double  z 
)

◆ SetSliceResolutionMode()

virtual void vtkMRMLSliceNode::SetSliceResolutionMode ( int  mode)
virtual


method for setting UVW space (extents, dimensions and spacing)

◆ SetSliceSpacingMode()

virtual void vtkMRMLSliceNode::SetSliceSpacingMode ( int  )
virtual

◆ SetSliceSpacingModeToAutomatic()

void vtkMRMLSliceNode::SetSliceSpacingModeToAutomatic ( )

◆ SetSliceSpacingModeToPrescribed()

void vtkMRMLSliceNode::SetSliceSpacingModeToPrescribed ( )

◆ SetSliceToRASByNTP()

void vtkMRMLSliceNode::SetSliceToRASByNTP ( double  Nx,
double  Ny,
double  Nz,
double  Tx,
double  Ty,
double  Tz,
double  Px,
double  Py,
double  Pz,
int  Orientation 
)

Set the SliceToRAS matrix according to the position and orientation of the locator: N(x, y, z) - the direction vector of the locator T(x, y, z) - the transverse direction vector of the locator P(x, y, z) - the tip location of the locator All the above values are in RAS space.

◆ SetSliceVisible()

virtual void vtkMRMLSliceNode::SetSliceVisible ( int  )
virtual

◆ SetUseLabelOutline()

virtual void vtkMRMLSliceNode::SetUseLabelOutline ( int  )
virtual

◆ SetUVWDimensions() [1/2]

void vtkMRMLSliceNode::SetUVWDimensions ( int  x,
int  y,
int  z 
)

◆ SetUVWDimensions() [2/2]

void vtkMRMLSliceNode::SetUVWDimensions ( int  xyz[3])

◆ SetUVWExtents() [1/2]

void vtkMRMLSliceNode::SetUVWExtents ( double  x,
double  y,
double  z 
)

◆ SetUVWExtents() [2/2]

void vtkMRMLSliceNode::SetUVWExtents ( double  xyz[3])

◆ SetUVWExtentsAndDimensions()

void vtkMRMLSliceNode::SetUVWExtentsAndDimensions ( double  extents[3],
int  dimensions[3] 
)

Set UVW extents and dimensions, produces less updates then calling both separately

◆ SetUVWMaximumDimensions() [1/2]

void vtkMRMLSliceNode::SetUVWMaximumDimensions ( int  x,
int  y,
int  z 
)

◆ SetUVWMaximumDimensions() [2/2]

void vtkMRMLSliceNode::SetUVWMaximumDimensions ( int  xyz[3])

◆ SetUVWOrigin() [1/2]

void vtkMRMLSliceNode::SetUVWOrigin ( double  x,
double  y,
double  z 
)

◆ SetUVWOrigin() [2/2]

void vtkMRMLSliceNode::SetUVWOrigin ( double  xyz[3])

◆ SetWidgetNormalLockedToCamera()

virtual void vtkMRMLSliceNode::SetWidgetNormalLockedToCamera ( int  )
virtual

◆ SetWidgetOutlineVisible()

virtual void vtkMRMLSliceNode::SetWidgetOutlineVisible ( int  )
virtual

◆ SetWidgetVisible()

virtual void vtkMRMLSliceNode::SetWidgetVisible ( int  )
virtual

◆ SetXYZOrigin()

void vtkMRMLSliceNode::SetXYZOrigin ( double  x,
double  y,
double  z 
)

◆ UpdateMatrices()

void vtkMRMLSliceNode::UpdateMatrices ( )

Recalculate XYToSlice and XYToRAS in terms or fov, dim, SliceToRAS

  • called when any of the inputs change

◆ UseLabelOutlineOff()

virtual void vtkMRMLSliceNode::UseLabelOutlineOff ( )
virtual

◆ UseLabelOutlineOn()

virtual void vtkMRMLSliceNode::UseLabelOutlineOn ( )
virtual

◆ WriteXML()

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


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

Reimplemented from vtkMRMLAbstractViewNode.

Member Data Documentation

◆ ActiveSlice

int vtkMRMLSliceNode::ActiveSlice
protected

Definition at line 563 of file vtkMRMLSliceNode.h.

◆ DefaultOrientation

char* vtkMRMLSliceNode::DefaultOrientation
protected

Definition at line 553 of file vtkMRMLSliceNode.h.

◆ Dimensions

int vtkMRMLSliceNode::Dimensions[3]
protected

Definition at line 543 of file vtkMRMLSliceNode.h.

◆ FieldOfView

double vtkMRMLSliceNode::FieldOfView[3]
protected

Definition at line 540 of file vtkMRMLSliceNode.h.

◆ Interacting

int vtkMRMLSliceNode::Interacting
protected

Definition at line 565 of file vtkMRMLSliceNode.h.

◆ InteractionFlags

unsigned int vtkMRMLSliceNode::InteractionFlags
protected

Definition at line 566 of file vtkMRMLSliceNode.h.

◆ InteractionFlagsModifier

unsigned int vtkMRMLSliceNode::InteractionFlagsModifier
protected

Definition at line 567 of file vtkMRMLSliceNode.h.

◆ IsUpdatingMatrices

int vtkMRMLSliceNode::IsUpdatingMatrices
protected

Definition at line 569 of file vtkMRMLSliceNode.h.

◆ JumpMode

int vtkMRMLSliceNode::JumpMode
protected

Definition at line 532 of file vtkMRMLSliceNode.h.

◆ LayoutGridColumns

int vtkMRMLSliceNode::LayoutGridColumns
protected

Definition at line 558 of file vtkMRMLSliceNode.h.

◆ LayoutGridRows

int vtkMRMLSliceNode::LayoutGridRows
protected

Definition at line 557 of file vtkMRMLSliceNode.h.

◆ OrientationMatrices

std::vector< OrientationPresetType > vtkMRMLSliceNode::OrientationMatrices
protected

Definition at line 530 of file vtkMRMLSliceNode.h.

◆ OrientationReference

char* vtkMRMLSliceNode::OrientationReference
protected

Definition at line 555 of file vtkMRMLSliceNode.h.

◆ OrientationString

std::string vtkMRMLSliceNode::OrientationString
protected

Definition at line 551 of file vtkMRMLSliceNode.h.

◆ PrescribedSliceSpacing

double vtkMRMLSliceNode::PrescribedSliceSpacing[3]
protected

Definition at line 561 of file vtkMRMLSliceNode.h.

◆ SliceResolutionMode

int vtkMRMLSliceNode::SliceResolutionMode
protected

Definition at line 545 of file vtkMRMLSliceNode.h.

◆ SliceSpacingMode

int vtkMRMLSliceNode::SliceSpacingMode
protected

Definition at line 560 of file vtkMRMLSliceNode.h.

◆ SliceToRAS

vtkSmartPointer<vtkMatrix4x4> vtkMRMLSliceNode::SliceToRAS
protected

Definition at line 521 of file vtkMRMLSliceNode.h.

◆ SliceVisible

int vtkMRMLSliceNode::SliceVisible
protected

Definition at line 534 of file vtkMRMLSliceNode.h.

◆ ThreeDViewIDs

std::vector< std::string > vtkMRMLSliceNode::ThreeDViewIDs
protected

Definition at line 571 of file vtkMRMLSliceNode.h.

◆ UseLabelOutline

int vtkMRMLSliceNode::UseLabelOutline
protected

Definition at line 538 of file vtkMRMLSliceNode.h.

◆ UVWDimensions

int vtkMRMLSliceNode::UVWDimensions[3]
protected

Definition at line 547 of file vtkMRMLSliceNode.h.

◆ UVWExtents

double vtkMRMLSliceNode::UVWExtents[3]
protected

Definition at line 546 of file vtkMRMLSliceNode.h.

◆ UVWMaximumDimensions

int vtkMRMLSliceNode::UVWMaximumDimensions[3]
protected

Definition at line 548 of file vtkMRMLSliceNode.h.

◆ UVWOrigin

double vtkMRMLSliceNode::UVWOrigin[3]
protected

Definition at line 542 of file vtkMRMLSliceNode.h.

◆ UVWToRAS

vtkSmartPointer<vtkMatrix4x4> vtkMRMLSliceNode::UVWToRAS
protected

Definition at line 527 of file vtkMRMLSliceNode.h.

◆ UVWToSlice

vtkSmartPointer<vtkMatrix4x4> vtkMRMLSliceNode::UVWToSlice
protected

Definition at line 526 of file vtkMRMLSliceNode.h.

◆ WidgetNormalLockedToCamera

int vtkMRMLSliceNode::WidgetNormalLockedToCamera
protected

Definition at line 537 of file vtkMRMLSliceNode.h.

◆ WidgetOutlineVisible

int vtkMRMLSliceNode::WidgetOutlineVisible
protected

Definition at line 536 of file vtkMRMLSliceNode.h.

◆ WidgetVisible

int vtkMRMLSliceNode::WidgetVisible
protected

Definition at line 535 of file vtkMRMLSliceNode.h.

◆ XYToRAS

vtkSmartPointer<vtkMatrix4x4> vtkMRMLSliceNode::XYToRAS
protected

Definition at line 524 of file vtkMRMLSliceNode.h.

◆ XYToSlice

vtkSmartPointer<vtkMatrix4x4> vtkMRMLSliceNode::XYToSlice
protected

Definition at line 523 of file vtkMRMLSliceNode.h.

◆ XYZOrigin

double vtkMRMLSliceNode::XYZOrigin[3]
protected

Definition at line 541 of file vtkMRMLSliceNode.h.


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