![]() |
Slicer
4.8
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
|
MRML node for storing a slice through RAS space. More...
#include <Libs/MRML/Core/vtkMRMLSliceCompositeNode.h>
Public Types | |
enum | { Alpha = 0, ReverseAlpha, Add, Subtract } |
Modes for compositing. More... | |
enum | AnnotationMode { NoAnnotation = 0, All, LabelValuesOnly, LabelAndVoxelValuesOnly } |
Annotation mode. More... | |
enum | AnnotationSpace { XYZ = 0, IJK, RAS, IJKAndRAS } |
Annotation space. More... | |
enum | InteractionFlagType { None = 0, ForegroundVolumeFlag = 1, BackgroundVolumeFlag = 2, LabelVolumeFlag = 4, LabelOpacityFlag = 8, ForegroundOpacityFlag = 16 } |
typedef vtkMRMLNode | Superclass |
![]() | |
enum | { HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent, ReferenceRemovedEvent, ReferencedNodeModifiedEvent } |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual void | Copy (vtkMRMLNode *node) VTK_OVERRIDE |
Copy the node's attributes to this object. More... | |
virtual vtkMRMLNode * | CreateNodeInstance () VTK_OVERRIDE |
Create instance of the default node. Like New only virtual. More... | |
virtual int | GetAnnotationMode () |
Get annotation mode. More... | |
virtual int | GetAnnotationSpace () |
Get annotation space. More... | |
virtual char * | GetBackgroundVolumeID () |
the ID of a MRMLVolumeNode More... | |
virtual const char * | GetClassName () |
virtual int | GetCompositing () |
virtual bool | GetDoPropagateVolumeSelection () |
virtual int | GetFiducialLabelVisibility () |
virtual int | GetFiducialVisibility () |
toggles fiducial visibility in the slice viewer More... | |
virtual double | GetForegroundOpacity () |
virtual char * | GetForegroundVolumeID () |
virtual int | GetHotLinkedControl () |
virtual int | GetInteracting () |
virtual unsigned int | GetInteractionFlags () |
virtual unsigned int | GetInteractionFlagsModifier () |
virtual double | GetLabelOpacity () |
virtual char * | GetLabelVolumeID () |
char * | GetLayoutName () |
virtual int | GetLinkedControl () |
toggle that gangs control of slice viewers More... | |
virtual const char * | GetNodeTagName () VTK_OVERRIDE |
Get node XML tag name (like Volume, Model) More... | |
virtual int | GetSliceIntersectionVisibility () |
toggles visibility of intersections of other slices in the slice viewer More... | |
virtual void | HotLinkedControlOff () |
virtual void | HotLinkedControlOn () |
virtual void | InteractingOff () |
virtual void | InteractingOn () |
virtual int | IsA (const char *type) |
virtual void | LinkedControlOff () |
virtual void | LinkedControlOn () |
void | PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE |
virtual void | ReadXMLAttributes (const char **atts) VTK_OVERRIDE |
Set node attributes. More... | |
void | ResetInteractionFlagsModifier () |
virtual void | SetAnnotationMode (int) |
virtual void | SetAnnotationSpace (int) |
void | SetBackgroundVolumeID (const char *id) |
virtual void | SetCompositing (int) |
virtual void | SetDoPropagateVolumeSelection (bool) |
virtual void | SetFiducialLabelVisibility (int) |
virtual void | SetFiducialVisibility (int) |
virtual void | SetForegroundOpacity (double) |
void | SetForegroundVolumeID (const char *id) |
virtual void | SetHotLinkedControl (int) |
void | SetInteracting (int) |
void | SetInteractionFlags (unsigned int) |
void | SetInteractionFlagsModifier (unsigned int) |
virtual void | SetLabelOpacity (double) |
void | SetLabelVolumeID (const char *id) |
void | SetLayoutName (const char *layoutName) |
virtual void | SetLinkedControl (int) |
void | SetReferenceBackgroundVolumeID (const char *id) |
void | SetReferenceForegroundVolumeID (const char *id) |
void | SetReferenceLabelVolumeID (const char *id) |
virtual void | SetSceneReferences () VTK_OVERRIDE |
Set the volumes as reference in the scene. More... | |
virtual void | SetSliceIntersectionVisibility (int) |
virtual void | UpdateReferenceID (const char *oldID, const char *newID) VTK_OVERRIDE |
Update the stored reference to another node in the scene. More... | |
virtual void | UpdateReferences () VTK_OVERRIDE |
virtual void | WriteXML (ostream &of, int indent) VTK_OVERRIDE |
Write this node's information to a MRML file in XML format. More... | |
![]() | |
vtkMRMLNode * | AddAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=0) |
Add and observe a reference node from this node for a specific referenceRole. More... | |
vtkMRMLNode * | AddNodeReferenceID (const char *referenceRole, const char *referencedNodeID) |
Convenience method that adds a referencedNodeID at the end of the list. More... | |
void | AddNodeReferenceRole (const char *referenceRole, const char *mrmlAttributeName=0, vtkIntArray *events=0) |
Add a referenceRole. More... | |
virtual void | AddToSceneOff () |
virtual void | AddToSceneOn () |
virtual void | CopyReferences (vtkMRMLNode *node) |
Copy the references of the node into this. More... | |
void | CopyWithoutModifiedEvent (vtkMRMLNode *node) |
void | CopyWithScene (vtkMRMLNode *node) |
Copy everything (including Scene and ID) from another node of the same type. More... | |
void | CopyWithSceneWithSingleModifiedEvent (vtkMRMLNode *node) |
Copy everything (including Scene and ID) from another node of the same type. More... | |
void | CopyWithSingleModifiedEvent (vtkMRMLNode *node) |
void | DisableModifiedEventOff () |
void | DisableModifiedEventOn () |
virtual int | EndModify (int previousDisableModifiedEventState) |
End modifying the node. More... | |
virtual int | GetAddToScene () |
node added to MRML scene. More... | |
const char * | GetAttribute (const char *name) |
Get value of a name value pair attribute. More... | |
std::vector< std::string > | GetAttributeNames () |
Get all attribute names. More... | |
void | GetAttributeNames (vtkStringArray *attributeNames) |
Get all attribute names. Python-wrappable version. More... | |
virtual char * | GetDescription () |
virtual int | GetDisableModifiedEvent () |
Turn on/off generating InvokeEvent for set macros. More... | |
virtual int | GetHideFromEditors () |
Describes if the node is hidden. More... | |
virtual char * | GetID () |
ID use by other nodes to reference this node in XML. More... | |
virtual int | GetInMRMLCallbackFlag () |
Flags to avoid event loops. More... | |
virtual int | GetModifiedEventPending () |
virtual char * | GetName () |
vtkMRMLNode * | GetNodeReference (const char *referenceRole) |
const char * | GetNodeReferenceID (const char *referenceRole) |
Utility function that returns the first node id for a specific referenceRole. More... | |
void | GetNodeReferenceIDs (const char *referenceRole, std::vector< const char *> &referencedNodeIDs) |
Return a list of the referenced node IDs. More... | |
void | GetNodeReferenceRoles (std::vector< std::string > &roles) |
void | GetNodeReferences (const char *referenceRole, std::vector< vtkMRMLNode *> &nodes) |
Return a list of the referenced nodes. More... | |
vtkMRMLNode * | GetNthNodeReference (const char *referenceRole, int n) |
Get referenced MRML node for a specific referenceRole. More... | |
const char * | GetNthNodeReferenceID (const char *referenceRole, int n) |
Return the string of the Nth node ID for a specific reference role. More... | |
const char * | GetNthNodeReferenceRole (int n) |
int | GetNumberOfNodeReferenceRoles () |
int | GetNumberOfNodeReferences (const char *referenceRole) |
Return the number of node IDs for a specific reference role (and nodes as they always have the same size). More... | |
virtual int | GetSaveWithScene () |
Save node with MRML scene. More... | |
virtual vtkMRMLScene * | GetScene () |
Only the scene can set itself to the node. More... | |
virtual int | GetSelectable () |
Describes if the node is selectable. More... | |
virtual int | GetSelected () |
Get/Set for Selected. More... | |
virtual char * | GetSingletonTag () |
bool | HasNodeReferenceID (const char *referenceRole, const char *referencedNodeID) |
Return true if referencedNodeID is in the node ID list for a specific referenceRole. More... | |
virtual void | HideFromEditorsOff () |
virtual void | HideFromEditorsOn () |
virtual void | InvokeCustomModifiedEvent (int eventId, void *callData=NULL) |
This method allows the node to compress events. More... | |
virtual int | InvokePendingModifiedEvent () |
Invokes any modified events that are pending . More... | |
bool | IsSingleton () |
virtual void | Modified () VTK_OVERRIDE |
Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent. More... | |
virtual void | OnNodeAddedToScene () |
void | PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE |
virtual void | ProcessChildNode (vtkMRMLNode *) |
Set dependencies between this node and a child node when parsing XML file. More... | |
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 | Reset (vtkMRMLNode *defaultNode) |
Reset node attributes to the initial state as defined in the constructor or the passed default node. More... | |
virtual void | SaveWithSceneOff () |
virtual void | SaveWithSceneOn () |
virtual void | SelectableOff () |
virtual void | SelectableOn () |
virtual void | SelectedOff () |
virtual void | SelectedOn () |
virtual void | SetAddToScene (int) |
void | SetAddToSceneNoModify (int value) |
vtkMRMLNode * | SetAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=0) |
Set and observe a reference node from this node for a specific referenceRole. More... | |
vtkMRMLNode * | SetAndObserveNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID, vtkIntArray *events=0) |
Set and observe the Nth node ID for a specific reference role. More... | |
void | SetAttribute (const char *name, const char *value) |
Set a name value pair attribute. More... | |
virtual void | SetDescription (const char *) |
Text description of this node, to be set by the user. More... | |
void | SetDisableModifiedEvent (int onOff) |
virtual void | SetHideFromEditors (int) |
void | SetInMRMLCallbackFlag (int flag) |
virtual void | SetName (const char *) |
Name of this node, to be set by the user. More... | |
vtkMRMLNode * | SetNodeReferenceID (const char *referenceRole, const char *referencedNodeID) |
Set a reference to a node with specified nodeID from this node for a specific referenceRole. More... | |
vtkMRMLNode * | SetNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID) |
Set a N-th reference from this node with specified referencedNodeID for a specific referenceRole. More... | |
virtual void | SetSaveWithScene (int) |
virtual void | SetScene (vtkMRMLScene *scene) |
virtual void | SetSelectable (int) |
virtual void | SetSelected (int) |
void | SetSingletonOff () |
void | SetSingletonOn () |
virtual void | SetSingletonTag (const char *) |
Tag that make this node a singleton in the scene. More... | |
virtual int | StartModify () |
Start modifying the node. Disable Modify events. More... | |
virtual void | 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... | |
Static Public Member Functions | |
static int | IsTypeOf (const char *type) |
static vtkMRMLSliceCompositeNode * | New () |
static vtkMRMLSliceCompositeNode * | SafeDownCast (vtkObject *o) |
![]() | |
static int | IsTypeOf (const char *type) |
static vtkMRMLNode * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
void | operator= (const vtkMRMLSliceCompositeNode &) |
vtkMRMLSliceCompositeNode () | |
vtkMRMLSliceCompositeNode (const vtkMRMLSliceCompositeNode &) | |
~vtkMRMLSliceCompositeNode () | |
![]() | |
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 NULL). More... | |
void | operator= (const vtkMRMLNode &) |
void | ParseReferencesAttribute (const char *attValue, std::map< std::string, std::string > &references) |
virtual void | SetTempURLString (const char *) |
Get/Set the string used to manage encoding/decoding of strings/URLs with special characters. More... | |
vtkMRMLNode * | UpdateNodeReferenceEventObserver (vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkIntArray *newEvents, vtkMRMLNodeReference *referenceToIgnore) |
virtual void | UpdateNodeReferences (const char *referenceRole=NULL) |
virtual void | UpdateNthNodeReference (const char *referenceRole, int n) |
vtkMRMLNode () | |
vtkMRMLNode (const vtkMRMLNode &) | |
virtual | ~vtkMRMLNode () |
critical to have a virtual destructor! More... | |
Additional Inherited Members | |
![]() | |
typedef std::map< std::string, std::string > | AttributesType |
typedef std::map< std::string, vtkSmartPointer< vtkIntArray > > | NodeReferenceEventsType |
typedef std::vector< vtkSmartPointer< vtkMRMLNodeReference > > | NodeReferenceListType |
typedef std::map< std::string, NodeReferenceListType > | NodeReferencesType |
![]() | |
static void | MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData) |
MRML node for storing a slice through RAS space.
This node stores the information about how to composite two vtkMRMLVolumes into a single display image.
Definition at line 24 of file vtkMRMLSliceCompositeNode.h.
Definition at line 28 of file vtkMRMLSliceCompositeNode.h.
anonymous enum |
Modes for compositing.
Enumerator | |
---|---|
Alpha | |
ReverseAlpha | |
Add | |
Subtract |
Definition at line 182 of file vtkMRMLSliceCompositeNode.h.
Annotation mode.
Enumerator | |
---|---|
NoAnnotation | |
All | |
LabelValuesOnly | |
LabelAndVoxelValuesOnly |
Definition at line 173 of file vtkMRMLSliceCompositeNode.h.
Annotation space.
Enumerator | |
---|---|
XYZ | |
IJK | |
RAS | |
IJKAndRAS |
Definition at line 164 of file vtkMRMLSliceCompositeNode.h.
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: ForegroundVolumeFlag - broadcast the foreground volume selection BackgroundVolumeFlag - broadcast the background volume selection LabelVolumeFlag - broadcast the label volume selection
Enumerator | |
---|---|
None | |
ForegroundVolumeFlag | |
BackgroundVolumeFlag | |
LabelVolumeFlag | |
LabelOpacityFlag | |
ForegroundOpacityFlag |
Definition at line 207 of file vtkMRMLSliceCompositeNode.h.
|
protected |
|
protected |
|
protected |
|
virtual |
Copy the node's attributes to this object.
Reimplemented from vtkMRMLNode.
|
virtual |
Create instance of the default node. Like New only virtual.
Implements vtkMRMLNode.
|
virtual |
Get annotation mode.
|
virtual |
Get annotation space.
|
virtual |
the ID of a MRMLVolumeNode
|
virtual |
Reimplemented from vtkMRMLNode.
|
virtual |
Compositing mode for foreground and background can be alpha blending, reverse alpha blending, addition, or subtraction
|
virtual |
|
virtual |
|
virtual |
toggles fiducial visibility in the slice viewer
|
virtual |
opacity of the Foreground for rendering over background TODO: make this an arbitrary list of layers TODO: make different composite types (checkerboard, etc)
|
virtual |
the ID of a MRMLVolumeNode TODO: make this an arbitrary list of layers
|
virtual |
toggle for whether linked behavior is immediate or waits until an interaction is finished
|
virtual |
|
virtual |
|
virtual |
|
virtual |
opacity of the Label for rendering over background TODO: make this an arbitrary list of layers TODO: make different composite types (checkerboard, etc)
|
virtual |
the ID of a MRMLVolumeNode TODO: make this an arbitrary list of layers
|
inline |
Definition at line 159 of file vtkMRMLSliceCompositeNode.h.
|
virtual |
toggle that gangs control of slice viewers
|
inlinevirtual |
Get node XML tag name (like Volume, Model)
Implements vtkMRMLNode.
Definition at line 47 of file vtkMRMLSliceCompositeNode.h.
|
virtual |
toggles visibility of intersections of other slices in the slice viewer
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Reimplemented from vtkMRMLNode.
|
static |
|
virtual |
|
virtual |
|
static |
|
protected |
void vtkMRMLSliceCompositeNode::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) |
|
virtual |
Set node attributes.
Reimplemented from vtkMRMLNode.
void vtkMRMLSliceCompositeNode::ResetInteractionFlagsModifier | ( | ) |
Set all bits of the modifier to 1, resulting in the default linking behavior (selection of foreground, background and label volumes being broadcast when composite slice nodes are linked).
|
static |
|
virtual |
Set annotation mode Mode could be either NoAnnotation, All, LabelValuesOnly or LabelAndVoxelValuesOnly
|
virtual |
Set annotation space. Space could be either XYZ, IJK or RAS
void vtkMRMLSliceCompositeNode::SetBackgroundVolumeID | ( | const char * | id | ) |
|
virtual |
|
virtual |
configures the behavior of PropagateVolumeSelection(): if set to false, the background/label for slice views will not be reset. Default value is true
|
virtual |
|
virtual |
|
virtual |
void vtkMRMLSliceCompositeNode::SetForegroundVolumeID | ( | const char * | id | ) |
|
virtual |
void vtkMRMLSliceCompositeNode::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 mark the node as Modified.
void vtkMRMLSliceCompositeNode::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 composte the flag. Does not mark the node as Modified.
void vtkMRMLSliceCompositeNode::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 composite slice node interactions not broadcast.
|
virtual |
void vtkMRMLSliceCompositeNode::SetLabelVolumeID | ( | const char * | id | ) |
|
inline |
Name of the layout. Must be unique between all the slice composite nodes because it is used as a singleton tag. Must be the same than the slice node. No name (i.e. "") by default. Typical names are colors: "Red", "Green", "Yellow"... to uniquely define the slice node
Definition at line 156 of file vtkMRMLSliceCompositeNode.h.
|
virtual |
|
inline |
Definition at line 65 of file vtkMRMLSliceCompositeNode.h.
|
inline |
Definition at line 72 of file vtkMRMLSliceCompositeNode.h.
|
inline |
Definition at line 79 of file vtkMRMLSliceCompositeNode.h.
|
virtual |
Set the volumes as reference in the scene.
Reimplemented from vtkMRMLNode.
|
virtual |
|
virtual |
Update the stored reference to another node in the scene.
Reimplemented from vtkMRMLNode.
|
virtual |
Updates this node if it depends on other nodes when the node is deleted in the scene
Reimplemented from vtkMRMLNode.
|
virtual |
Write this node's information to a MRML file in XML format.
Reimplemented from vtkMRMLNode.
|
protected |
Definition at line 267 of file vtkMRMLSliceCompositeNode.h.
|
protected |
Definition at line 266 of file vtkMRMLSliceCompositeNode.h.
|
protected |
Definition at line 258 of file vtkMRMLSliceCompositeNode.h.
|
protected |
Definition at line 246 of file vtkMRMLSliceCompositeNode.h.
|
protected |
Definition at line 251 of file vtkMRMLSliceCompositeNode.h.
|
protected |
Definition at line 269 of file vtkMRMLSliceCompositeNode.h.
|
protected |
Definition at line 262 of file vtkMRMLSliceCompositeNode.h.
|
protected |
Definition at line 261 of file vtkMRMLSliceCompositeNode.h.
|
protected |
Definition at line 257 of file vtkMRMLSliceCompositeNode.h.
|
protected |
Definition at line 249 of file vtkMRMLSliceCompositeNode.h.
|
protected |
Definition at line 247 of file vtkMRMLSliceCompositeNode.h.
|
protected |
Definition at line 255 of file vtkMRMLSliceCompositeNode.h.
|
protected |
Definition at line 271 of file vtkMRMLSliceCompositeNode.h.
|
protected |
Definition at line 272 of file vtkMRMLSliceCompositeNode.h.
|
protected |
Definition at line 273 of file vtkMRMLSliceCompositeNode.h.
|
protected |
Definition at line 259 of file vtkMRMLSliceCompositeNode.h.
|
protected |
Definition at line 253 of file vtkMRMLSliceCompositeNode.h.
|
protected |
Definition at line 248 of file vtkMRMLSliceCompositeNode.h.
|
protected |
Definition at line 254 of file vtkMRMLSliceCompositeNode.h.
|
protected |
Definition at line 264 of file vtkMRMLSliceCompositeNode.h.