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

MRML node for representing a volume display attributes. More...

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

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

Classes

class  WindowLevelPreset
 

Public Types

typedef vtkMRMLVolumeDisplayNode Superclass
 
- Public Types inherited from vtkMRMLVolumeDisplayNode
typedef vtkMRMLDisplayNode Superclass
 
- Public Types inherited from vtkMRMLDisplayNode
enum  { MenuEvent = 16100 }
 
enum  InterpolationType { FlatInterpolation = 0, GouraudInterpolation, PhongInterpolation }
 
enum  RepresentationType { PointsRepresentation = 0, WireframeRepresentation, SurfaceRepresentation }
 
enum  ScalarRangeFlagType {
  UseManualScalarRange = 0, UseDataScalarRange, UseColorNodeScalarRange, UseDataTypeScalarRange,
  UseDirectMapping, NUM_SCALAR_RANGE_FLAGS
}
 
typedef vtkMRMLNode Superclass
 
- Public Types inherited from vtkMRMLNode
enum  {
  HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent,
  ReferenceRemovedEvent, ReferencedNodeModifiedEvent
}
 
typedef vtkObject Superclass
 

Public Member Functions

void AddWindowLevelPreset (double window, double level)
 
Add a window level preset More...
 
void AddWindowLevelPresetFromString (const char *preset)
 
Parse a string with window and level as double|double, and add a preset More...
 
virtual void ApplyThresholdOff ()
 
virtual void ApplyThresholdOn ()
 
Specifies whether to apply the threshold More...
 
virtual void AutoThresholdOff ()
 
virtual void AutoThresholdOn ()
 
Specifies whether the threshold should be set automatically More...
 
virtual void AutoWindowLevelOff ()
 
virtual void AutoWindowLevelOn ()
 
Specifies whether windowing and leveling are to be performed automatically More...
 
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 GetApplyThreshold ()
 
virtual int GetAutoThreshold ()
 
virtual int GetAutoWindowLevel ()
 
vtkAlgorithmOutput * GetBackgroundImageStencilDataConnection () override
 
virtual const char * GetClassName ()
 
virtual void GetDisplayScalarRange (double range[2])
 
vtkAlgorithmOutput * GetInputImageDataConnection () override
 Gets the pipeline input. More...
 
virtual int GetInterpolate ()
 
Set/Get interpolate reformated slices More...
 
double GetLevel ()
 
The level value to use when autoWindowLevel is 'no' More...
 
double GetLevelPreset (int p)
 
virtual double GetLowerThreshold ()
 
const char * GetNodeTagName () override
 
Get node XML tag name (like Volume, Model) More...
 
int GetNumberOfWindowLevelPresets ()
 
Get the number of window/level presets More...
 
vtkAlgorithmOutput * GetOutputImageDataConnection () override
 Gets the pipeline output. More...
 
virtual double GetUpperThreshold ()
 
double GetWindow ()
 
The window value to use when autoWindowLevel is 'no' More...
 
virtual bool GetWindowLevelLocked ()
 Display Information. More...
 
double GetWindowLevelMax ()
 Utility function that returns the maximum value of the window level. More...
 
double GetWindowLevelMin ()
 Utility function that returns the minimum value of the window level. More...
 
double GetWindowPreset (int p)
 
Return a specific preset, returns 0 if p out of range More...
 
virtual void InterpolateOff ()
 
virtual void InterpolateOn ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ProcessMRMLEvents (vtkObject *, unsigned long, void *) override
 
alternative method to propagate events generated in Display nodes More...
 
void ReadXMLAttributes (const char **atts) override
 
Read node attributes from XML file More...
 
void ResetWindowLevelPresets ()
 
Remove all presets More...
 
virtual void SetApplyThreshold (int)
 
virtual void SetAutoThreshold (int)
 
virtual void SetAutoWindowLevel (int)
 
void SetBackgroundImageStencilDataConnection (vtkAlgorithmOutput *imageDataConnection) override
 
Get/set background mask stencil More...
 
void SetDefaultColorMap () override
 
set gray colormap or override in subclass More...
 
void SetInputImageDataConnection (vtkAlgorithmOutput *imageDataConnection) override
 Set the pipeline input. More...
 
virtual void SetInterpolate (int)
 
virtual void SetLevel (double)
 
virtual void SetLowerThreshold (double lower)
 
virtual void SetThreshold (double lower, double upper)
 
virtual void SetUpperThreshold (double upper)
 
virtual void SetWindow (double)
 
virtual void SetWindowLevel (double window, double level)
 
void SetWindowLevelFromPreset (int p)
 
Set Window and Level from preset p More...
 
virtual void SetWindowLevelLocked (bool)
 
void SetWindowLevelMinMax (double min, double max)
 
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 vtkMRMLVolumeDisplayNode
void Copy (vtkMRMLNode *node) override
 
Copy the node's attributes to this object More...
 
virtual vtkImageStencilData * GetBackgroundImageStencilData ()
 
virtual vtkAlgorithmOutput * GetImageDataConnection ()
 
virtual vtkImageData * GetInputImageData ()
 Gets the pipeline input. To be reimplemented in subclasses. More...
 
virtual vtkImageData * GetOutputImageData ()
 Gets the pipeline output. To be reimplemented in subclasses. More...
 
vtkMRMLVolumeNodeGetVolumeNode ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ProcessMRMLEvents (vtkObject *, unsigned long, void *) override
 
alternative method to propagate events generated in Display nodes More...
 
void ReadXMLAttributes (const char **atts) override
 
Read node attributes from XML file More...
 
virtual void UpdateImageDataPipeline ()
 
Update the pipeline based on this node attributes More...
 
void UpdateReferences () override
 
void UpdateScene (vtkMRMLScene *scene) override
 
Finds the storage node and read the data More...
 
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 vtkMRMLDisplayNode
void AddViewNodeID (const char *viewNodeID)
 
void AutoScalarRangeOff ()
 
void AutoScalarRangeOn ()
 
virtual void BackfaceCullingOff ()
 
virtual void BackfaceCullingOn ()
 
virtual void ClippingOff ()
 
virtual void ClippingOn ()
 
virtual void EdgeVisibilityOff ()
 
virtual void EdgeVisibilityOn ()
 
virtual void FolderDisplayOverrideAllowedOff ()
 
virtual void FolderDisplayOverrideAllowedOn ()
 
virtual void FrontfaceCullingOff ()
 
virtual void FrontfaceCullingOn ()
 
virtual int GetActiveAttributeLocation ()
 
const char * GetActiveAttributeLocationAsString ()
 
virtual char * GetActiveScalarName ()
 
virtual double GetAmbient ()
 
int GetAutoScalarRange ()
 
virtual int GetBackfaceCulling ()
 
virtual int GetClipping ()
 
virtual void GetColor (double [3])
 
virtual void GetColor (double &, double &, double &)
 
virtual double * GetColor ()
 
virtual vtkMRMLColorNodeGetColorNode ()
 
virtual char * GetColorNodeID ()
 
virtual double GetDiffuse ()
 
virtual vtkMRMLDisplayableNodeGetDisplayableNode ()
 
virtual double * GetEdgeColor ()
 
virtual void GetEdgeColor (double &, double &, double &)
 
virtual void GetEdgeColor (double [3])
 
virtual int GetEdgeVisibility ()
 
virtual bool GetFolderDisplayOverrideAllowed ()
 
virtual int GetFrontfaceCulling ()
 
virtual int GetInterpolateTexture ()
 
virtual int GetInterpolation ()
 
virtual int GetLighting ()
 
virtual double GetLineWidth ()
 
const char * GetNthViewNodeID (unsigned int index)
 
int GetNumberOfViewNodeIDs () const
 
virtual double GetOpacity ()
 
virtual double GetPointSize ()
 
virtual double GetPower ()
 
virtual int GetRepresentation ()
 
virtual double * GetScalarRange ()
 
virtual void GetScalarRange (double [2])
 
virtual void GetScalarRange (double &, double &)
 
virtual int GetScalarRangeFlag ()
 
const char * GetScalarRangeFlagAsString ()
 
virtual int GetScalarVisibility ()
 
virtual double GetSelectedAmbient ()
 
virtual double * GetSelectedColor ()
 
virtual void GetSelectedColor (double &, double &, double &)
 
virtual void GetSelectedColor (double [3])
 
virtual double GetSelectedSpecular ()
 
virtual int GetShading ()
 
virtual double GetSliceIntersectionOpacity ()
 
virtual int GetSliceIntersectionThickness ()
 
int GetSliceIntersectionVisibility ()
 
virtual double GetSpecular ()
 
virtual int GetTensorVisibility ()
 
virtual vtkAlgorithmOutput * GetTextureImageDataConnection ()
 
virtual int GetVectorVisibility ()
 
std::vector< std::string > GetViewNodeIDs () const
 
virtual int GetVisibility ()
 
virtual bool GetVisibility (const char *viewNodeID)
 
virtual int GetVisibility2D ()
 
virtual int GetVisibility3D ()
 
virtual void InterpolateTextureOff ()
 
virtual void InterpolateTextureOn ()
 
bool IsDisplayableInView (const char *viewNodeID) const
 
bool IsViewNodeIDPresent (const char *viewNodeID) const
 
virtual void LightingOff ()
 
virtual void LightingOn ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void RemoveAllViewNodeIDs ()
 
void RemoveViewNodeID (char *viewNodeID)
 
virtual void ScalarVisibilityOff ()
 
virtual void ScalarVisibilityOn ()
 
virtual void SetActiveAttributeLocation (int)
 
void SetActiveAttributeLocationFromString (const char *str)
 
virtual void SetActiveScalarName (const char *)
 
virtual void SetAmbient (double)
 
virtual void SetAndObserveColorNodeID (const char *ColorNodeID)
 
void SetAndObserveColorNodeID (const std::string &ColorNodeID)
 
void SetAutoScalarRange (int b)
 
virtual void SetBackfaceCulling (int)
 
virtual void SetClipping (int)
 
virtual void SetColor (double, double, double)
 
virtual void SetColor (double [3])
 
virtual void SetDiffuse (double)
 
void SetDisplayableOnlyInView (const char *viewNodeID)
 
virtual void SetEdgeColor (double, double, double)
 
virtual void SetEdgeColor (double [3])
 
virtual void SetEdgeVisibility (int)
 
virtual void SetFolderDisplayOverrideAllowed (bool)
 
virtual void SetFrontfaceCulling (int)
 
virtual void SetInterpolateTexture (int)
 
virtual void SetInterpolation (int)
 
virtual void SetLighting (int)
 
virtual void SetLineWidth (double)
 
virtual void SetOpacity (double)
 
virtual void SetPointSize (double)
 
virtual void SetPower (double)
 
virtual void SetRepresentation (int)
 
virtual void SetScalarRange (double, double)
 
void SetScalarRange (double [2])
 
virtual void SetScalarRangeFlag (int)
 
void SetScalarRangeFlagFromString (const char *str)
 
virtual void SetScalarVisibility (int)
 
void SetSceneReferences () override
 Mark the color and views nodes as references. More...
 
virtual void SetSelectedAmbient (double)
 
virtual void SetSelectedColor (double, double, double)
 
virtual void SetSelectedColor (double [3])
 
virtual void SetSelectedSpecular (double)
 
virtual void SetShading (int)
 
virtual void SetSliceIntersectionOpacity (double)
 
virtual void SetSliceIntersectionThickness (int)
 
void SetSliceIntersectionVisibility (int on)
 
virtual void SetSpecular (double)
 
virtual void SetTensorVisibility (int)
 
virtual void SetTextureImageDataConnection (vtkAlgorithmOutput *ImageDataConnection)
 
virtual void SetVectorVisibility (int)
 
void SetViewNodeIDs (const std::vector< std::string > &viewNodeIDs)
 
virtual void SetVisibility (int)
 
virtual void SetVisibility2D (int)
 
virtual void SetVisibility3D (int)
 
void SliceIntersectionVisibilityOff ()
 
void SliceIntersectionVisibilityOn ()
 
virtual void TensorVisibilityOff ()
 
virtual void TensorVisibilityOn ()
 
void UpdateReferenceID (const char *oldID, const char *newID) override
 Update the stored reference to another node in the scene. More...
 
virtual void VectorVisibilityOff ()
 
virtual void VectorVisibilityOn ()
 
virtual void Visibility2DOff ()
 
virtual void Visibility2DOn ()
 
virtual void Visibility3DOff ()
 
virtual void Visibility3DOn ()
 
virtual void VisibilityOff ()
 
virtual void VisibilityOn ()
 
- 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...
 
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 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 ()
 
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 vtkMRMLScalarVolumeDisplayNodeNew ()
 
static vtkMRMLScalarVolumeDisplayNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLVolumeDisplayNode
static int IsTypeOf (const char *type)
 
static vtkMRMLVolumeDisplayNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLDisplayNode
static const char * GetAttributeLocationAsString (int id)
 Converts attribute location (point or cell data) to string. More...
 
static int GetAttributeLocationFromString (const char *name)
 Gets attribute location (point or cell data) from string. More...
 
static const char * GetScalarRangeFlagTypeAsString (int flag)
 
static int GetScalarRangeFlagTypeFromString (const char *name)
 Gets scalar range flag type from string. More...
 
static int IsTypeOf (const char *type)
 
static vtkMRMLDisplayNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (vtkObject *o)
 

Protected Member Functions

void CalculateAutoLevels ()
 
vtkImageData * GetScalarImageData ()
 
virtual vtkAlgorithmOutput * GetScalarImageDataConnection ()
 
void operator= (const vtkMRMLScalarVolumeDisplayNode &)
 
void SetColorNodeInternal (vtkMRMLColorNode *newColorNode) override
 
void SetInputToImageDataPipeline (vtkAlgorithmOutput *imageDataConnection) override
 
void UpdateLookupTable (vtkMRMLColorNode *newColorNode)
 
 vtkMRMLScalarVolumeDisplayNode ()
 
 vtkMRMLScalarVolumeDisplayNode (const vtkMRMLScalarVolumeDisplayNode &)
 
 ~vtkMRMLScalarVolumeDisplayNode () override
 
- Protected Member Functions inherited from vtkMRMLVolumeDisplayNode
void operator= (const vtkMRMLVolumeDisplayNode &)
 
 vtkMRMLVolumeDisplayNode ()
 
 vtkMRMLVolumeDisplayNode (const vtkMRMLVolumeDisplayNode &)
 
 ~vtkMRMLVolumeDisplayNode () override
 
- Protected Member Functions inherited from vtkMRMLDisplayNode
void operator= (const vtkMRMLDisplayNode &)
 
 vtkMRMLDisplayNode ()
 
 vtkMRMLDisplayNode (const vtkMRMLDisplayNode &)
 
 ~vtkMRMLDisplayNode () 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

vtkImageLogic * AlphaLogic
 
vtkImageAppendComponents * AppendComponents
 
int ApplyThreshold
 
int AutoThreshold
 
int AutoWindowLevel
 
vtkImageExtractComponents * ExtractAlpha
 
vtkImageExtractComponents * ExtractRGB
 
vtkImageHistogramStatistics * HistogramStatistics
 
Used internally in CalculateScalarAutoLevels and CalculateStatisticsAutoLevels More...
 
int Interpolate
 Booleans. More...
 
bool IsInCalculateAutoLevels
 
vtkImageMapToColors * MapToColors
 
vtkImageMapToWindowLevelColors * MapToWindowLevelColors
 
vtkImageStencil * MultiplyAlpha
 
vtkImageThreshold * Threshold
 
bool WindowLevelLocked
 
std::vector< WindowLevelPresetWindowLevelPresets
 
window level presets More...
 
- Protected Attributes inherited from vtkMRMLDisplayNode
int ActiveAttributeLocation
 
char * ActiveScalarName
 
double Ambient
 
int BackfaceCulling
 
int Clipping
 
double Color [3]
 
vtkMRMLColorNodeColorNode
 
char * ColorNodeID
 
double Diffuse
 
double EdgeColor [3]
 
int EdgeVisibility
 
bool FolderDisplayOverrideAllowed
 
int FrontfaceCulling
 
int InterpolateTexture
 
int Interpolation
 
vtkWeakPointer< vtkMRMLDisplayableNodeLastFoundDisplayableNode
 Cached value of last found displayable node (it is expensive to determine it) More...
 
int Lighting
 
double LineWidth
 
double Opacity
 
double PointSize
 
double Power
 
int Representation
 
double ScalarRange [2]
 
int ScalarRangeFlag
 
int ScalarVisibility
 
double SelectedAmbient
 
double SelectedColor [3]
 
double SelectedSpecular
 
int Shading
 
double SliceIntersectionOpacity
 
int SliceIntersectionThickness
 
double Specular
 
int TensorVisibility
 
vtkAlgorithmOutput * TextureImageDataConnection
 
int VectorVisibility
 
std::vector< std::string > ViewNodeIDs
 
int Visibility
 
int Visibility2D
 
int Visibility3D
 
- 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

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

Detailed Description

MRML node for representing a volume display attributes.

vtkMRMLScalarVolumeDisplayNode nodes describe how volume is displayed.

Definition at line 40 of file vtkMRMLScalarVolumeDisplayNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 44 of file vtkMRMLScalarVolumeDisplayNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLScalarVolumeDisplayNode() [1/2]

vtkMRMLScalarVolumeDisplayNode::vtkMRMLScalarVolumeDisplayNode ( )
protected

◆ ~vtkMRMLScalarVolumeDisplayNode()

vtkMRMLScalarVolumeDisplayNode::~vtkMRMLScalarVolumeDisplayNode ( )
overrideprotected

◆ vtkMRMLScalarVolumeDisplayNode() [2/2]

vtkMRMLScalarVolumeDisplayNode::vtkMRMLScalarVolumeDisplayNode ( const vtkMRMLScalarVolumeDisplayNode )
protected

Member Function Documentation

◆ AddWindowLevelPreset()

void vtkMRMLScalarVolumeDisplayNode::AddWindowLevelPreset ( double  window,
double  level 
)


Add a window level preset

◆ AddWindowLevelPresetFromString()

void vtkMRMLScalarVolumeDisplayNode::AddWindowLevelPresetFromString ( const char *  preset)


Parse a string with window and level as double|double, and add a preset

◆ ApplyThresholdOff()

virtual void vtkMRMLScalarVolumeDisplayNode::ApplyThresholdOff ( )
virtual

◆ ApplyThresholdOn()

virtual void vtkMRMLScalarVolumeDisplayNode::ApplyThresholdOn ( )
virtual


Specifies whether to apply the threshold

◆ AutoThresholdOff()

virtual void vtkMRMLScalarVolumeDisplayNode::AutoThresholdOff ( )
virtual

◆ AutoThresholdOn()

virtual void vtkMRMLScalarVolumeDisplayNode::AutoThresholdOn ( )
virtual


Specifies whether the threshold should be set automatically

◆ AutoWindowLevelOff()

virtual void vtkMRMLScalarVolumeDisplayNode::AutoWindowLevelOff ( )
virtual

◆ AutoWindowLevelOn()

virtual void vtkMRMLScalarVolumeDisplayNode::AutoWindowLevelOn ( )
virtual


Specifies whether windowing and leveling are to be performed automatically

◆ CalculateAutoLevels()

void vtkMRMLScalarVolumeDisplayNode::CalculateAutoLevels ( )
protected

◆ Copy()

void vtkMRMLScalarVolumeDisplayNode::Copy ( vtkMRMLNode node)
overridevirtual


Copy the node's attributes to this object

Reimplemented from vtkMRMLDisplayNode.

Reimplemented in vtkMRMLVectorVolumeDisplayNode.

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLScalarVolumeDisplayNode::CreateNodeInstance ( )
overridevirtual

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

Note
Subclasses should implement this method

Implements vtkMRMLNode.

Reimplemented in vtkMRMLVectorVolumeDisplayNode.

◆ GetApplyThreshold()

virtual int vtkMRMLScalarVolumeDisplayNode::GetApplyThreshold ( )
virtual

◆ GetAutoThreshold()

virtual int vtkMRMLScalarVolumeDisplayNode::GetAutoThreshold ( )
virtual

◆ GetAutoWindowLevel()

virtual int vtkMRMLScalarVolumeDisplayNode::GetAutoWindowLevel ( )
virtual

◆ GetBackgroundImageStencilDataConnection()

vtkAlgorithmOutput* vtkMRMLScalarVolumeDisplayNode::GetBackgroundImageStencilDataConnection ( )
overridevirtual

Reimplemented from vtkMRMLVolumeDisplayNode.

◆ GetClassName()

virtual const char* vtkMRMLScalarVolumeDisplayNode::GetClassName ( )
virtual

◆ GetDisplayScalarRange()

virtual void vtkMRMLScalarVolumeDisplayNode::GetDisplayScalarRange ( double  range[2])
virtual

Defines the expected range of the output data after having been mapped through the current display options If no input is set, then it searches the scene to find the associated Volume node and returns its image data scalar range.

Reimplemented in vtkMRMLDiffusionTensorVolumeDisplayNode, and vtkMRMLGlyphableVolumeDisplayNode.

◆ GetInputImageDataConnection()

vtkAlgorithmOutput* vtkMRMLScalarVolumeDisplayNode::GetInputImageDataConnection ( )
overridevirtual

Gets the pipeline input.

Reimplemented from vtkMRMLVolumeDisplayNode.

Reimplemented in vtkMRMLVectorVolumeDisplayNode.

◆ GetInterpolate()

virtual int vtkMRMLScalarVolumeDisplayNode::GetInterpolate ( )
virtual


Set/Get interpolate reformated slices

◆ GetLevel()

double vtkMRMLScalarVolumeDisplayNode::GetLevel ( )


The level value to use when autoWindowLevel is 'no'

◆ GetLevelPreset()

double vtkMRMLScalarVolumeDisplayNode::GetLevelPreset ( int  p)

◆ GetLowerThreshold()

virtual double vtkMRMLScalarVolumeDisplayNode::GetLowerThreshold ( )
virtual

The lower threshold value to use when autoThreshold is 'no' Defaults to VTK_SHORT_MIN

◆ GetNodeTagName()

const char* vtkMRMLScalarVolumeDisplayNode::GetNodeTagName ( )
inlineoverridevirtual


Get node XML tag name (like Volume, Model)

Implements vtkMRMLVolumeDisplayNode.

Reimplemented in vtkMRMLVectorVolumeDisplayNode.

Definition at line 63 of file vtkMRMLScalarVolumeDisplayNode.h.

◆ GetNumberOfWindowLevelPresets()

int vtkMRMLScalarVolumeDisplayNode::GetNumberOfWindowLevelPresets ( )


Get the number of window/level presets

◆ GetOutputImageDataConnection()

vtkAlgorithmOutput* vtkMRMLScalarVolumeDisplayNode::GetOutputImageDataConnection ( )
overridevirtual

Gets the pipeline output.

Reimplemented from vtkMRMLVolumeDisplayNode.

◆ GetScalarImageData()

vtkImageData* vtkMRMLScalarVolumeDisplayNode::GetScalarImageData ( )
protected

Return the image data with scalar type, it can be in the middle of the pipeline, it's typically the input of the threshold/windowlevel filters

◆ GetScalarImageDataConnection()

virtual vtkAlgorithmOutput* vtkMRMLScalarVolumeDisplayNode::GetScalarImageDataConnection ( )
protectedvirtual

◆ GetUpperThreshold()

virtual double vtkMRMLScalarVolumeDisplayNode::GetUpperThreshold ( )
virtual

The upper threshold value to use when autoThreshold is 'no' Defaults to VTK_SHORT_MAX

◆ GetWindow()

double vtkMRMLScalarVolumeDisplayNode::GetWindow ( )


The window value to use when autoWindowLevel is 'no'

◆ GetWindowLevelLocked()

virtual bool vtkMRMLScalarVolumeDisplayNode::GetWindowLevelLocked ( )
virtual

Display Information.

Window/Level cannot be edited through the user interface

◆ GetWindowLevelMax()

double vtkMRMLScalarVolumeDisplayNode::GetWindowLevelMax ( )

Utility function that returns the maximum value of the window level.

◆ GetWindowLevelMin()

double vtkMRMLScalarVolumeDisplayNode::GetWindowLevelMin ( )

Utility function that returns the minimum value of the window level.

◆ GetWindowPreset()

double vtkMRMLScalarVolumeDisplayNode::GetWindowPreset ( int  p)


Return a specific preset, returns 0 if p out of range

◆ InterpolateOff()

virtual void vtkMRMLScalarVolumeDisplayNode::InterpolateOff ( )
virtual

◆ InterpolateOn()

virtual void vtkMRMLScalarVolumeDisplayNode::InterpolateOn ( )
virtual

◆ IsA()

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

◆ IsTypeOf()

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

◆ New()

static vtkMRMLScalarVolumeDisplayNode* vtkMRMLScalarVolumeDisplayNode::New ( )
static

◆ operator=()

void vtkMRMLScalarVolumeDisplayNode::operator= ( const vtkMRMLScalarVolumeDisplayNode )
protected

◆ PrintSelf()

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

◆ ProcessMRMLEvents()

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


alternative method to propagate events generated in Display nodes

Reimplemented from vtkMRMLDisplayNode.

Reimplemented in vtkMRMLVectorVolumeDisplayNode.

◆ ReadXMLAttributes()

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


Read node attributes from XML file

Reimplemented from vtkMRMLDisplayNode.

Reimplemented in vtkMRMLVectorVolumeDisplayNode.

◆ ResetWindowLevelPresets()

void vtkMRMLScalarVolumeDisplayNode::ResetWindowLevelPresets ( )


Remove all presets

◆ SafeDownCast()

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

◆ SetApplyThreshold()

virtual void vtkMRMLScalarVolumeDisplayNode::SetApplyThreshold ( int  )
virtual

◆ SetAutoThreshold()

virtual void vtkMRMLScalarVolumeDisplayNode::SetAutoThreshold ( int  )
virtual

◆ SetAutoWindowLevel()

virtual void vtkMRMLScalarVolumeDisplayNode::SetAutoWindowLevel ( int  )
virtual

◆ SetBackgroundImageStencilDataConnection()

void vtkMRMLScalarVolumeDisplayNode::SetBackgroundImageStencilDataConnection ( vtkAlgorithmOutput *  imageDataConnection)
overridevirtual


Get/set background mask stencil

Reimplemented from vtkMRMLVolumeDisplayNode.

◆ SetColorNodeInternal()

void vtkMRMLScalarVolumeDisplayNode::SetColorNodeInternal ( vtkMRMLColorNode newColorNode)
overrideprotectedvirtual

Internal function to set the color node. Called by SetColorNodeID().

See also
SetColorNodeID(), ColorNode, ColorNodeID

Reimplemented from vtkMRMLDisplayNode.

◆ SetDefaultColorMap()

void vtkMRMLScalarVolumeDisplayNode::SetDefaultColorMap ( )
overridevirtual


set gray colormap or override in subclass

Reimplemented from vtkMRMLVolumeDisplayNode.

Reimplemented in vtkMRMLVectorVolumeDisplayNode.

◆ SetInputImageDataConnection()

void vtkMRMLScalarVolumeDisplayNode::SetInputImageDataConnection ( vtkAlgorithmOutput *  imageDataConnection)
overridevirtual

Set the pipeline input.

Reimplemented from vtkMRMLVolumeDisplayNode.

◆ SetInputToImageDataPipeline()

void vtkMRMLScalarVolumeDisplayNode::SetInputToImageDataPipeline ( vtkAlgorithmOutput *  imageDataConnection)
overrideprotectedvirtual

Reimplemented from vtkMRMLVolumeDisplayNode.

Reimplemented in vtkMRMLVectorVolumeDisplayNode.

◆ SetInterpolate()

virtual void vtkMRMLScalarVolumeDisplayNode::SetInterpolate ( int  )
virtual

◆ SetLevel()

virtual void vtkMRMLScalarVolumeDisplayNode::SetLevel ( double  )
virtual

◆ SetLowerThreshold()

virtual void vtkMRMLScalarVolumeDisplayNode::SetLowerThreshold ( double  lower)
virtual

◆ SetThreshold()

virtual void vtkMRMLScalarVolumeDisplayNode::SetThreshold ( double  lower,
double  upper 
)
virtual

◆ SetUpperThreshold()

virtual void vtkMRMLScalarVolumeDisplayNode::SetUpperThreshold ( double  upper)
virtual

◆ SetWindow()

virtual void vtkMRMLScalarVolumeDisplayNode::SetWindow ( double  )
virtual

◆ SetWindowLevel()

virtual void vtkMRMLScalarVolumeDisplayNode::SetWindowLevel ( double  window,
double  level 
)
virtual

Sets the window and level at once, generates only 1 modified event if needed.

◆ SetWindowLevelFromPreset()

void vtkMRMLScalarVolumeDisplayNode::SetWindowLevelFromPreset ( int  p)


Set Window and Level from preset p

◆ SetWindowLevelLocked()

virtual void vtkMRMLScalarVolumeDisplayNode::SetWindowLevelLocked ( bool  )
virtual

◆ SetWindowLevelMinMax()

void vtkMRMLScalarVolumeDisplayNode::SetWindowLevelMinMax ( double  min,
double  max 
)

Utility function that sets the window/level by passing the min and max of the window.

◆ UpdateLookupTable()

void vtkMRMLScalarVolumeDisplayNode::UpdateLookupTable ( vtkMRMLColorNode newColorNode)
protected

◆ WriteXML()

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


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

Reimplemented from vtkMRMLDisplayNode.

Reimplemented in vtkMRMLVectorVolumeDisplayNode.

Member Data Documentation

◆ AlphaLogic

vtkImageLogic* vtkMRMLScalarVolumeDisplayNode::AlphaLogic
protected

Definition at line 229 of file vtkMRMLScalarVolumeDisplayNode.h.

◆ AppendComponents

vtkImageAppendComponents* vtkMRMLScalarVolumeDisplayNode::AppendComponents
protected

Definition at line 232 of file vtkMRMLScalarVolumeDisplayNode.h.

◆ ApplyThreshold

int vtkMRMLScalarVolumeDisplayNode::ApplyThreshold
protected

Definition at line 226 of file vtkMRMLScalarVolumeDisplayNode.h.

◆ AutoThreshold

int vtkMRMLScalarVolumeDisplayNode::AutoThreshold
protected

Definition at line 227 of file vtkMRMLScalarVolumeDisplayNode.h.

◆ AutoWindowLevel

int vtkMRMLScalarVolumeDisplayNode::AutoWindowLevel
protected

Definition at line 225 of file vtkMRMLScalarVolumeDisplayNode.h.

◆ ExtractAlpha

vtkImageExtractComponents* vtkMRMLScalarVolumeDisplayNode::ExtractAlpha
protected

Definition at line 235 of file vtkMRMLScalarVolumeDisplayNode.h.

◆ ExtractRGB

vtkImageExtractComponents* vtkMRMLScalarVolumeDisplayNode::ExtractRGB
protected

Definition at line 234 of file vtkMRMLScalarVolumeDisplayNode.h.

◆ HistogramStatistics

vtkImageHistogramStatistics* vtkMRMLScalarVolumeDisplayNode::HistogramStatistics
protected


Used internally in CalculateScalarAutoLevels and CalculateStatisticsAutoLevels

Definition at line 244 of file vtkMRMLScalarVolumeDisplayNode.h.

◆ Interpolate

int vtkMRMLScalarVolumeDisplayNode::Interpolate
protected

Booleans.

Definition at line 223 of file vtkMRMLScalarVolumeDisplayNode.h.

◆ IsInCalculateAutoLevels

bool vtkMRMLScalarVolumeDisplayNode::IsInCalculateAutoLevels
protected

Definition at line 245 of file vtkMRMLScalarVolumeDisplayNode.h.

◆ MapToColors

vtkImageMapToColors* vtkMRMLScalarVolumeDisplayNode::MapToColors
protected

Definition at line 230 of file vtkMRMLScalarVolumeDisplayNode.h.

◆ MapToWindowLevelColors

vtkImageMapToWindowLevelColors* vtkMRMLScalarVolumeDisplayNode::MapToWindowLevelColors
protected

Definition at line 233 of file vtkMRMLScalarVolumeDisplayNode.h.

◆ MultiplyAlpha

vtkImageStencil* vtkMRMLScalarVolumeDisplayNode::MultiplyAlpha
protected

Definition at line 236 of file vtkMRMLScalarVolumeDisplayNode.h.

◆ Threshold

vtkImageThreshold* vtkMRMLScalarVolumeDisplayNode::Threshold
protected

Definition at line 231 of file vtkMRMLScalarVolumeDisplayNode.h.

◆ WindowLevelLocked

bool vtkMRMLScalarVolumeDisplayNode::WindowLevelLocked
protected

Definition at line 224 of file vtkMRMLScalarVolumeDisplayNode.h.

◆ WindowLevelPresets

std::vector<WindowLevelPreset> vtkMRMLScalarVolumeDisplayNode::WindowLevelPresets
protected


window level presets

Definition at line 240 of file vtkMRMLScalarVolumeDisplayNode.h.


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