Slicer 5.9
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
vtkMRMLColorTableNode Class Reference

MRML node to represent discrete color information. More...

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

Inheritance diagram for vtkMRMLColorTableNode:
Collaboration diagram for vtkMRMLColorTableNode:

Public Types

enum  {
  FullRainbow = 0 , Grey = 1 , Iron = 2 , Rainbow = 3 ,
  Ocean = 4 , Desert = 5 , InvGrey = 6 , ReverseRainbow = 7 ,
  FMRI = 8 , FMRIPA = 9 , Labels = 10 , Obsolete = 11 ,
  Random = 12 , Red = 15 , Green = 16 , Blue = 17 ,
  Yellow = 18 , Cyan = 19 , Magenta = 20 , Warm1 = 21 ,
  Warm2 = 22 , Warm3 = 23 , Cool1 = 24 , Cool2 = 25 ,
  Cool3 = 26 , WarmShade1 = 27 , WarmShade2 = 28 , WarmShade3 = 29 ,
  CoolShade1 = 30 , CoolShade2 = 31 , CoolShade3 = 32 , WarmTint1 = 33 ,
  WarmTint2 = 34 , WarmTint3 = 35 , CoolTint1 = 36 , CoolTint2 = 37 ,
  CoolTint3 = 38
}
 The list of valid table types. More...
 
typedef vtkMRMLColorNode Superclass
 
- Public Types inherited from vtkMRMLColorNode
enum  { User = 13 , File = 14 }
 
enum  { TypeModifiedEvent = 20002 }
 TypeModifiedEvent is generated when the type of the color look up table changes. More...
 
typedef vtkMRMLStorableNode Superclass
 
- Public Types inherited from vtkMRMLStorableNode
typedef vtkMRMLNode Superclass
 
- Public Types inherited from vtkMRMLNode
enum  {
  HierarchyModifiedEvent = 16000 , IDChangedEvent = 16001 , ReferenceAddedEvent , ReferenceModifiedEvent ,
  ReferenceRemovedEvent , ReferencedNodeModifiedEvent
}
 
enum  ContentModifiedObserveType { ContentModifiedObserveUndefined = -1 , ContentModifiedObserveDisabled = 0 , ContentModifiedObserveEnabled = 1 }
 
typedef std::map< std::string, std::string > ReferencePropertiesType
 Get the node reference properties for a specific referenceRole.
 
typedef vtkObject Superclass
 

Public Member Functions

void AddColor (const char *name, double r, double g, double b, double a=1.0)
 Add a color to the User color table, at the end.
 
void ClearNames ()
 Clear out the names list.
 
void Copy (vtkMRMLNode *node) override
 Copy the node's attributes to this object.
 
vtkMRMLStorageNodeCreateDefaultStorageNode () override
 Create default storage node or nullptr if does not have one.
 
vtkMRMLNodeCreateNodeInstance () override
 MRMLNode methods.
 
virtual const char * GetClassName ()
 
bool GetColor (int entry, double color[4]) override
 
int GetFirstType () override
 Return the lowest and highest integers, for use in looping.
 
int GetLastType () override
 
vtkLookupTable * GetLookupTable () override
 
const char * GetNodeTagName () override
 Get node XML tag name (like Volume, Model)
 
int GetNumberOfColors () override
 Set the size of the color table if it's a User table.
 
const char * GetTypeAsString () override
 return a text string describing the color look up table type
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData) override
 Propagate events generated in mrml.
 
void ReadXMLAttributes (const char **atts) override
 Set node attributes.
 
bool RemoveColor (int entry)
 
bool RemoveColors (int firstEntry, int lastEntry)
 
void Reset (vtkMRMLNode *defaultNode) override
 Reset when close the scene.
 
virtual void SetAndObserveLookupTable (vtkLookupTable *newLookupTable)
 
int SetColor (int entry, const char *name, double r, double g, double b, double a=1.0)
 Set a color into the User color table. Return 1 on success, 0 on failure.
 
int SetColor (int entry, double r, double g, double b)
 
int SetColor (int entry, double r, double g, double b, double a)
 
int SetColors (int firstEntry, int lastEntry, const char *name, double r, double g, double b, double a=1.0)
 
virtual void SetLookupTable (vtkLookupTable *newLookupTable)
 
void SetNumberOfColors (int n)
 Set the size of the color table if it's a User table.
 
int SetOpacity (int entry, double opacity)
 
void SetType (int type) override
 Get/Set for Type.
 
void SetTypeToBlue ()
 
void SetTypeToCool1 ()
 
void SetTypeToCool2 ()
 
void SetTypeToCool3 ()
 
void SetTypeToCoolShade1 ()
 
void SetTypeToCoolShade2 ()
 
void SetTypeToCoolShade3 ()
 
void SetTypeToCoolTint1 ()
 
void SetTypeToCoolTint2 ()
 
void SetTypeToCoolTint3 ()
 
void SetTypeToCyan ()
 
void SetTypeToDesert ()
 
void SetTypeToFMRI ()
 
void SetTypeToFMRIPA ()
 
void SetTypeToFullRainbow ()
 
void SetTypeToGreen ()
 
void SetTypeToGrey ()
 
void SetTypeToInvGrey ()
 
void SetTypeToIron ()
 
void SetTypeToLabels ()
 
void SetTypeToMagenta ()
 
void SetTypeToOcean ()
 
void SetTypeToRainbow ()
 
void SetTypeToRandom ()
 
void SetTypeToRed ()
 
void SetTypeToReverseRainbow ()
 
void SetTypeToWarm1 ()
 
void SetTypeToWarm2 ()
 
void SetTypeToWarm3 ()
 
void SetTypeToWarmShade1 ()
 
void SetTypeToWarmShade2 ()
 
void SetTypeToWarmShade3 ()
 
void SetTypeToWarmTint1 ()
 
void SetTypeToWarmTint2 ()
 
void SetTypeToWarmTint3 ()
 
void SetTypeToYellow ()
 
void WriteXML (ostream &of, int indent) override
 Write this node's information to a MRML file in XML format.
 
- Public Member Functions inherited from vtkMRMLColorNode
virtual vtkLookupTable * CreateLookupTableCopy ()
 
bool GetColorDefined (int ind)
 Returns true if the entry is defined.
 
int GetColorIndexByName (const char *name)
 
const char * GetColorName (int ind)
 
std::string GetColorNameAsFileName (int colorIndex, const char *subst="_")
 
std::string GetColorNameWithoutSpaces (int ind, const char *subst)
 
bool GetContainsTerminology ()
 Returns true if the color table has terminology information.
 
const char * GetContainsTerminologyAttributeName ()
 Get attribute name that indicates if the color table has terminology entries.
 
bool GetModifiedSinceRead () override
 
int GetNamesInitialised (int)
 
const char * GetNoName ()
 
virtual vtkScalarsToColors * GetScalarsToColors ()
 
std::string GetTerminologyAsString (int ind)
 
vtkCodedEntryGetTerminologyCategory (int ind)
 Get terminology information for a color entry.
 
vtkCodedEntryGetTerminologyRegion (int ind)
 
vtkCodedEntryGetTerminologyRegionModifier (int ind)
 
vtkCodedEntryGetTerminologyType (int ind)
 
vtkCodedEntryGetTerminologyTypeModifier (int ind)
 
virtual int GetType ()
 Get for Type.
 
void NamesInitialisedOff ()
 
void NamesInitialisedOn ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void SetColorDefined (int ind, bool defined)
 Set the color defined flag for the given entry.
 
int SetColorName (int ind, const char *name)
 
int SetColorNameWithSpaces (int ind, const char *name, const char *subst)
 
void SetNamesFromColors ()
 
void SetNamesInitialised (int)
 
void SetNoName (const char *)
 
bool SetTerminology (int ind, std::string categoryCodingScheme, std::string categoryCodeValue, std::string categoryCodeMeaning, std::string typeCodingScheme, std::string typeCodeValue, std::string typeCodeMeaning, std::string typeModifierCodingScheme="", std::string typeModifierCodeValue="", std::string typeModifierCodeMeaning="", std::string regionCodingScheme="", std::string regionCodeValue="", std::string regionCodeMeaning="", std::string regionModifierCodingScheme="", std::string regionModifierCodeValue="", std::string regionModifierCodeMeaning="")
 
bool SetTerminologyFromString (int ind, std::string terminologyString)
 
void SetTypeToFile ()
 
void SetTypeToUser ()
 
void UpdateScene (vtkMRMLScene *scene) override
 
 vtkMRMLCopyContentMacro (vtkMRMLColorNode)
 
- Public Member Functions inherited from vtkMRMLStorableNode
void AddAndObserveStorageNodeID (const char *storageNodeID)
 
virtual bool AddDefaultStorageNode (const char *filename=nullptr)
 
void Copy (vtkMRMLNode *node) override
 Copy node contents from another node of the same type. Reimplemented to copy default sequence storage node class.
 
virtual vtkMRMLStorageNodeCreateDefaultSequenceStorageNode ()
 
virtual std::string GetDefaultSequenceStorageNodeClassName ()
 
virtual std::string GetDefaultStorageNodeClassName (const char *filename=nullptr)
 
vtkMRMLStorageNodeGetNthStorageNode (int n)
 Get associated display MRML node.
 
const char * GetNthStorageNodeID (int n)
 
int GetNumberOfStorageNodes ()
 
const char * GetSlicerDataType ()
 
vtkMRMLStorageNodeGetStorageNode ()
 
const char * GetStorageNodeID ()
 
virtual vtkTagTableGetUserTagTable ()
 Methods for user-specified metadata.
 
bool HasStorageNodeID (const char *storageNodeID)
 Return true if storageNodeID is in the storage node ID list.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ProcessMRMLEvents (vtkObject *, unsigned long, void *) override
 alternative method to propagate events generated in Storage nodes
 
void ReadXMLAttributes (const char **atts) override
 Read node attributes from XML file.
 
void SetAndObserveNthStorageNodeID (int n, const char *storageNodeID)
 
void SetAndObserveStorageNodeID (const char *storageNodeID)
 String ID of the storage MRML node.
 
virtual void SetDefaultSequenceStorageNodeClassName (std::string)
 
void SetSlicerDataType (const char *type)
 
virtual void StorableModified ()
 
void UpdateScene (vtkMRMLScene *scene) override
 Finds the storage node and read the data.
 
 vtkMRMLCopyContentMacro (vtkMRMLStorableNode)
 
void WriteXML (ostream &of, int indent) override
 Write this node's information to a MRML file in XML format.
 
- Public Member Functions inherited from vtkMRMLNode
vtkMRMLNodeAddAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr, ContentModifiedObserveType observeContentModifiedEvents=ContentModifiedObserveUndefined)
 Add and observe a reference node from this node for a specific referenceRole.
 
vtkMRMLNodeAddNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Convenience method that adds a referencedNodeID at the end of the list.
 
void AddNodeReferenceRole (const char *referenceRole, const char *mrmlAttributeName=nullptr, vtkIntArray *events=nullptr, bool observeContentModifiedEvents=false)
 Add a referenceRole.
 
virtual void AddToSceneOff ()
 
virtual void AddToSceneOn ()
 
void ClearNodeReferenceProperties (const std::string &referenceRole)
 Remove all node reference properties for a specific referenceRole.
 
void ClearNthNodeReferenceProperties (const std::string &referenceRole, int n)
 
virtual void CopyContent (vtkMRMLNode *node, bool deepCopy=true)
 Copy node contents from another node of the same type. Does not copy node ID, Scene, Name, SingletonTag, HideFromEditors, AddToScene, UndoEnabled, and node references. If deepCopy is set to false then a shallow copy of bulk data (such as image or mesh data) could be made; copying may be faster but the node may share some data with the source node instead of creating an independent copy.
 
virtual void CopyReferences (vtkMRMLNode *node)
 Copy the references of the node into this.
 
void CopyWithScene (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type.
 
void DisableModifiedEventOff ()
 
void DisableModifiedEventOn ()
 
virtual int EndModify (int previousDisableModifiedEventState)
 End modifying the node.
 
virtual int GetAddToScene ()
 node added to MRML scene.
 
const char * GetAttribute (const char *name)
 Get value of a name value pair attribute.
 
std::vector< std::string > GetAttributeNames ()
 Get all attribute names.
 
void GetAttributeNames (vtkStringArray *attributeNames)
 Get all attribute names. Python-wrappable version.
 
virtual vtkIntArray * GetContentModifiedEvents ()
 
int GetCustomModifiedEventPending (int eventId)
 
virtual char * GetDescription ()
 
virtual int GetDisableModifiedEvent ()
 Turn on/off generating InvokeEvent for set macros.
 
virtual int GetHideFromEditors ()
 Describes if the node is hidden.
 
virtual char * GetID ()
 ID use by other nodes to reference this node in XML.
 
virtual int GetInMRMLCallbackFlag ()
 Flags to avoid event loops.
 
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.
 
void GetNodeReferenceIDs (const char *referenceRole, std::vector< const char * > &referencedNodeIDs)
 Return a list of the referenced node IDs.
 
const ReferencePropertiesTypeGetNodeReferenceProperties (const char *referenceRole)
 
std::string GetNodeReferenceProperty (const std::string &referenceRole, const std::string &propertyName)
 Get the node reference property for a specific referenceRole.
 
std::string GetNodeReferencePropertyName (const std::string &referenceRole, int propertyIndex)
 Get the name of the Nth node reference property for a specific referenceRole.
 
std::vector< std::string > GetNodeReferencePropertyNames (const std::string &referenceRole)
 Get the names of all node reference properties for a specific referenceRole.
 
void GetNodeReferenceRoles (std::vector< std::string > &roles)
 
void GetNodeReferences (const char *referenceRole, std::vector< vtkMRMLNode * > &nodes)
 Return a list of the referenced nodes.
 
vtkMRMLNodeGetNthNodeReference (const char *referenceRole, int n)
 Get referenced MRML node for a specific referenceRole.
 
const char * GetNthNodeReferenceID (const char *referenceRole, int n)
 Return the string of the Nth node ID for a specific reference role.
 
const ReferencePropertiesTypeGetNthNodeReferenceProperties (const char *referenceRole, int n)
 
std::string GetNthNodeReferenceProperty (const std::string &referenceRole, int n, const std::string &propertyName)
 
std::string GetNthNodeReferencePropertyName (const std::string &referenceRole, int referenceIndex, int propertyIndex)
 
std::vector< std::string > GetNthNodeReferencePropertyNames (const std::string &referenceRole, int n)
 
const char * GetNthNodeReferenceRole (int n)
 
int GetNumberOfNodeReferenceProperties (const std::string &referenceRole)
 Get the number of node reference properties for a specific referenceRole.
 
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).
 
int GetNumberOfNthNodeReferenceProperties (const std::string &referenceRole, int n)
 
virtual int GetSaveWithScene ()
 Save node with MRML scene.
 
virtual vtkMRMLSceneGetScene ()
 Get the scene this node has been added to.
 
virtual int GetSelectable ()
 Describes if the node is selectable.
 
virtual int GetSelected ()
 Get/Set for Selected.
 
virtual char * GetSingletonTag ()
 
virtual const char * GetTypeDisplayName ()
 
virtual bool GetUndoEnabled ()
 
virtual bool HasCopyContent () const
 Returns true if the class supports deep and shallow copying node content.
 
bool HasNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Return true if referencedNodeID is in the node ID list for a specific referenceRole.
 
virtual void HideFromEditorsOff ()
 
virtual void HideFromEditorsOn ()
 
virtual void InvokeCustomModifiedEvent (int eventId, void *callData=nullptr)
 This method allows the node to compress events.
 
virtual int InvokePendingModifiedEvent ()
 Invokes any modified events that are pending.
 
bool IsSingleton ()
 
void Modified () override
 Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent.
 
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.
 
void RemoveAttribute (const char *name)
 Remove attribute with the specified name.
 
void RemoveNodeReferenceIDs (const char *referenceRole)
 Remove all node IDs and associated nodes for a specific referenceRole.
 
void RemoveNodeReferenceProperty (const std::string &referenceRole, const std::string &propertyName)
 Remove a node reference property for a specific referenceRole.
 
void RemoveNthNodeReferenceID (const char *referenceRole, int n)
 Convenience method that removes the Nth node ID from the list.
 
void RemoveNthNodeReferenceProperty (const std::string &referenceRole, int n, const std::string &propertyName)
 
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, ContentModifiedObserveType observeContentModifiedEvents=ContentModifiedObserveUndefined)
 Set and observe a reference node from this node for a specific referenceRole.
 
vtkMRMLNodeSetAndObserveNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID, vtkIntArray *events=nullptr, ContentModifiedObserveType observeContentModifiedEvents=ContentModifiedObserveUndefined)
 Set and observe the Nth node ID for a specific reference role.
 
void SetAttribute (const char *name, const char *value)
 Set a name value pair attribute.
 
virtual void SetDescription (const char *)
 Text description of this node, to be set by the user.
 
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.
 
vtkMRMLNodeSetNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Set a reference to a node with specified nodeID from this node for a specific referenceRole.
 
void SetNodeReferenceProperty (const std::string &referenceRole, const std::string &propertyName, const std::string &value)
 Set the node reference property for a specific referenceRole.
 
vtkMRMLNodeSetNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID)
 Set a N-th reference from this node with specified referencedNodeID for a specific referenceRole.
 
void SetNthNodeReferenceProperty (const std::string &referenceRole, int n, const std::string &propertyName, const std::string &value)
 
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.
 
virtual void SetSceneReferences ()
 Update the references of the node to the 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.
 
virtual void SetUndoEnabled (bool)
 
virtual int StartModify ()
 Start modifying the node. Disable Modify events.
 
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.
 
virtual void UpdateReferences ()
 The method should remove all pointers and observations to all nodes that are not in the scene anymore.
 
const char * URLDecodeString (const char *inString)
 Decode a URL string.
 
const char * URLEncodeString (const char *inString)
 Encode a URL string.
 
virtual void WriteNodeBodyXML (ostream &of, int indent)
 Write this node's body to a MRML file in XML format.
 
std::string XMLAttributeDecodeString (const std::string &inString)
 Decode an XML attribute string.
 
std::string XMLAttributeEncodeString (const std::string &inString)
 Encode an XML attribute string (replaces special characters by code sequences)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkMRMLColorTableNodeNew ()
 
static vtkMRMLColorTableNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLColorNode
static std::string GetTerminologyAsString (std::string terminologyContextName, vtkCodedEntry *category, vtkCodedEntry *type, vtkCodedEntry *typeModifier, std::string regionContextName="", vtkCodedEntry *region=nullptr, vtkCodedEntry *regionModifier=nullptr)
 Convert coded entries to a string.
 
static int IsTypeOf (const char *type)
 
static vtkMRMLColorNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLStorableNode
static int IsTypeOf (const char *type)
 
static vtkMRMLStorableNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (vtkObject *o)
 

Protected Member Functions

void operator= (const vtkMRMLColorTableNode &)
 
 vtkMRMLColorTableNode ()
 
 vtkMRMLColorTableNode (const vtkMRMLColorTableNode &)
 
 ~vtkMRMLColorTableNode () override
 
- Protected Member Functions inherited from vtkMRMLColorNode
bool GetProperty (int ind, PropertyType &prop)
 
void operator= (const vtkMRMLColorNode &)
 
void SetContainsTerminology (bool containsTerminology)
 Sets whether the color table has terminology information.
 
virtual bool SetNameFromColor (int index)
 Set values in the names vector from the colors in the node.
 
 vtkMRMLColorNode ()
 
 vtkMRMLColorNode (const vtkMRMLColorNode &)
 
 ~vtkMRMLColorNode () override
 
- Protected Member Functions inherited from vtkMRMLStorableNode
virtual const char * GetStorageNodeReferenceMRMLAttributeName ()
 
virtual const char * GetStorageNodeReferenceRole ()
 
virtual vtkTimeStamp GetStoredTime ()
 
void operator= (const vtkMRMLStorableNode &)
 
 vtkMRMLStorableNode ()
 
 vtkMRMLStorableNode (const vtkMRMLStorableNode &)
 
 ~vtkMRMLStorableNode () override
 
- Protected Member Functions inherited from vtkMRMLNode
virtual const char * GetMRMLAttributeNameFromReferenceRole (const char *refRole)
 Return the mrml attribute name (if found) associated with a reference role. Return 0 otherwise.
 
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.
 
virtual char * GetTempURLString ()
 
void GetUpdatedReferencedNodeEventList (int &oldReferencedNodeUseCount, int &newReferencedNodeUseCount, vtkIntArray *oldConsolidatedEventList, vtkIntArray *newConsolidatedEventList, vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkMRMLNodeReference *referenceToIgnore, vtkIntArray *newEvents, bool newObserveContentModifiedEvents)
 
virtual void InvalidateNodeReferences ()
 
virtual bool IsReferenceRoleGeneric (const char *refRole)
 Return true if the reference role is generic (ends with '/') or false otherwise.
 
std::string NodeReferencePropertyDecodeString (const std::string &inString)
 Decode a node reference property string.
 
std::string NodeReferencePropertyEncodeString (const std::string &inString)
 Encode a node reference property string (replaces special characters by code sequences)
 
virtual void OnNodeReferenceAdded (vtkMRMLNodeReference *reference)
 
virtual void OnNodeReferenceModified (vtkMRMLNodeReference *reference)
 Called when a referenced node pointer is modified.
 
virtual void OnNodeReferenceRemoved (vtkMRMLNodeReference *reference)
 Called when a referenced node pointer is removed (set to nullptr).
 
void operator= (const vtkMRMLNode &)
 
void ParseReferencesAttribute (const char *attValue, std::set< std::string > &references)
 
void RemoveInvalidReferences (const std::set< std::string > &validNodeIDs)
 
virtual void SetTempURLString (const char *)
 Get/Set the string used to manage encoding/decoding of strings/URLs with special characters.
 
vtkMRMLNodeUpdateNodeReferenceEventObserver (vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkIntArray *newEvents, bool newObserveContentModifiedEvents, 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!
 

Protected Attributes

int LastAddedColor {-1}
 keep track of where we last added a color.
 
vtkLookupTable * LookupTable
 The look up table, constructed according to the Type.
 
- Protected Attributes inherited from vtkMRMLColorNode
std::vector< PropertyTypeProperties
 Vector of names and other properties for the color table elements.
 
int Type
 
- Protected Attributes inherited from vtkMRMLStorableNode
std::string DefaultSequenceStorageNodeClassName
 
std::string SlicerDataType
 
vtkTimeStamp StorableModifiedTime
 
vtkTagTableUserTagTable
 
- Protected Attributes inherited from vtkMRMLNode
int AddToScene {1}
 
AttributesType Attributes
 
vtkIntArray * ContentModifiedEvents
 
char * Description {nullptr}
 
int HideFromEditors {0}
 
char * ID {nullptr}
 
int InMRMLCallbackFlag {0}
 Flag to avoid event loops.
 
vtkCallbackCommand * MRMLCallbackCommand
 Holders for MRML callbacks.
 
vtkObserverManagerMRMLObserverManager
 
char * Name {nullptr}
 
NodeReferenceEventsType NodeReferenceEvents
 
std::map< std::string, std::string > NodeReferenceMRMLAttributeNames
 
NodeReferencesType NodeReferences
 
int SaveWithScene {true}
 
vtkWeakPointer< vtkMRMLSceneScene
 
int Selectable {1}
 
int Selected {0}
 
bool UndoEnabled {false}
 

Additional Inherited Members

- Protected Types inherited from vtkMRMLNode
typedef std::map< std::string, std::string > AttributesType
 
typedef std::map< std::string, NodeReferenceEventListNodeReferenceEventsType
 
typedef std::vector< vtkSmartPointer< vtkMRMLNodeReference > > NodeReferenceListType
 
typedef std::map< std::string, NodeReferenceListTypeNodeReferencesType
 
- Static Protected Member Functions inherited from vtkMRMLNode
static void MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 
- Static Protected Attributes inherited from vtkMRMLStorableNode
static const char * StorageNodeReferenceMRMLAttributeName
 
static const char * StorageNodeReferenceRole
 

Detailed Description

MRML node to represent discrete color information.

Color nodes describe color look up tables. The tables may be pre-generated by Slicer (the label map colors, a random one) or created by a user. More than one model or label volume or editor can access the prebuilt nodes.

Definition at line 26 of file vtkMRMLColorTableNode.h.

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

The list of valid table types.

Grey - greyscale ramp Iron - neutral Rainbow - red-orange-yellow-blue-indigo-violet Ocean - bluish ramp Desert - orange ramp InvGrey - inverted greyscale ramp ReverseRainbow - inverted Rainbow FMRI - fMRI map FMRIPA - fMRI Positive Activation map Labels - the Slicer2 FullRainbow editor labels Random - 255 random colors Red - red ramp (like greyscale but with red, meant for layering with cyan) Green - green ramp (like greyscale but with green, layering with magenta) Blue - blue ramp (like greyscale but with blue, layering with yellow) Yellow - yellow ramp (complementary ramp to blue, layering yields gray) Cyan - cyan ramp (complementary ramp to red, layering yields gray) Magenta - magenta ramp (complementary ramp to green, layering yields gray) Warm# - ramps of warm colors that are complimentary to Cool# WarmShade# - ramps of warm colors with variation in value that are complimentary to CoolShade# WarmTint# - ramps of warm colors with variation in saturation that are complimentary to CoolTint# Cool# - ramps of cool colors that are complimentary to Warm# CoolShade# - ramps of cool colors with variation in value that are complimentary to WarmShade# CoolTint# - ramps of cool colors with variation in saturation that are complimentary to WarmSTint#

Enumerator
FullRainbow 
Grey 
Iron 
Rainbow 
Ocean 
Desert 
InvGrey 
ReverseRainbow 
FMRI 
FMRIPA 
Labels 
Obsolete 
Random 
Red 
Green 
Blue 
Yellow 
Cyan 
Magenta 
Warm1 
Warm2 
Warm3 
Cool1 
Cool2 
Cool3 
WarmShade1 
WarmShade2 
WarmShade3 
CoolShade1 
CoolShade2 
CoolShade3 
WarmTint1 
WarmTint2 
WarmTint3 
CoolTint1 
CoolTint2 
CoolTint3 

Definition at line 145 of file vtkMRMLColorTableNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLColorTableNode() [1/2]

vtkMRMLColorTableNode::vtkMRMLColorTableNode ( )
protected

◆ ~vtkMRMLColorTableNode()

vtkMRMLColorTableNode::~vtkMRMLColorTableNode ( )
overrideprotected

◆ vtkMRMLColorTableNode() [2/2]

vtkMRMLColorTableNode::vtkMRMLColorTableNode ( const vtkMRMLColorTableNode & )
protected

Member Function Documentation

◆ AddColor()

void vtkMRMLColorTableNode::AddColor ( const char * name,
double r,
double g,
double b,
double a = 1.0 )

Add a color to the User color table, at the end.

◆ ClearNames()

void vtkMRMLColorTableNode::ClearNames ( )

Clear out the names list.

◆ Copy()

void vtkMRMLColorTableNode::Copy ( vtkMRMLNode * node)
overridevirtual

Copy the node's attributes to this object.

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLDiffusionTensorDisplayPropertiesNode.

◆ CreateDefaultStorageNode()

vtkMRMLStorageNode * vtkMRMLColorTableNode::CreateDefaultStorageNode ( )
overridevirtual

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

Reimplemented from vtkMRMLStorableNode.

Reimplemented in vtkMRMLDiffusionTensorDisplayPropertiesNode.

◆ CreateNodeInstance()

vtkMRMLNode * vtkMRMLColorTableNode::CreateNodeInstance ( )
overridevirtual

MRMLNode methods.

Implements vtkMRMLColorNode.

Reimplemented in vtkMRMLDiffusionTensorDisplayPropertiesNode.

◆ GetClassName()

virtual const char * vtkMRMLColorTableNode::GetClassName ( )
virtual

Reimplemented from vtkMRMLColorNode.

Reimplemented in vtkMRMLDiffusionTensorDisplayPropertiesNode.

◆ GetColor()

bool vtkMRMLColorTableNode::GetColor ( int entry,
double color[4] )
overridevirtual

Retrieve the color associated to the index. Return true if the color exists, false otherwise

Implements vtkMRMLColorNode.

◆ GetFirstType()

int vtkMRMLColorTableNode::GetFirstType ( )
inlineoverridevirtual

Return the lowest and highest integers, for use in looping.

Reimplemented from vtkMRMLColorNode.

Definition at line 188 of file vtkMRMLColorTableNode.h.

◆ GetLastType()

int vtkMRMLColorTableNode::GetLastType ( )
inlineoverridevirtual

Reimplemented from vtkMRMLColorNode.

Definition at line 189 of file vtkMRMLColorTableNode.h.

◆ GetLookupTable()

vtkLookupTable * vtkMRMLColorTableNode::GetLookupTable ( )
overridevirtual

Access lookup table object that stores table values.

See also
SetAndObserveLookupTable()

Reimplemented from vtkMRMLColorNode.

◆ GetNodeTagName()

const char * vtkMRMLColorTableNode::GetNodeTagName ( )
inlineoverridevirtual

Get node XML tag name (like Volume, Model)

Reimplemented from vtkMRMLColorNode.

Reimplemented in vtkMRMLDiffusionTensorDisplayPropertiesNode.

Definition at line 53 of file vtkMRMLColorTableNode.h.

◆ GetNumberOfColors()

int vtkMRMLColorTableNode::GetNumberOfColors ( )
overridevirtual

Set the size of the color table if it's a User table.

Implements vtkMRMLColorNode.

◆ GetTypeAsString()

const char * vtkMRMLColorTableNode::GetTypeAsString ( )
overridevirtual

return a text string describing the color look up table type

Reimplemented from vtkMRMLColorNode.

◆ IsA()

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

Reimplemented from vtkMRMLColorNode.

Reimplemented in vtkMRMLDiffusionTensorDisplayPropertiesNode.

◆ IsTypeOf()

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

◆ New()

static vtkMRMLColorTableNode * vtkMRMLColorTableNode::New ( )
static

◆ operator=()

void vtkMRMLColorTableNode::operator= ( const vtkMRMLColorTableNode & )
protected

◆ PrintSelf()

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

◆ ProcessMRMLEvents()

void vtkMRMLColorTableNode::ProcessMRMLEvents ( vtkObject * caller,
unsigned long event,
void * callData )
overridevirtual

Propagate events generated in mrml.

Reimplemented from vtkMRMLColorNode.

◆ ReadXMLAttributes()

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

Set node attributes.

Reimplemented from vtkMRMLColorNode.

Reimplemented in vtkMRMLDiffusionTensorDisplayPropertiesNode.

◆ RemoveColor()

bool vtkMRMLColorTableNode::RemoveColor ( int entry)

Undefine color entry. Returns true on success.

◆ RemoveColors()

bool vtkMRMLColorTableNode::RemoveColors ( int firstEntry,
int lastEntry )

Undefines entries in the specified range. Returns true on success, false on failure.

◆ Reset()

void vtkMRMLColorTableNode::Reset ( vtkMRMLNode * defaultNode)
overridevirtual

Reset when close the scene.

Reimplemented from vtkMRMLColorNode.

◆ SafeDownCast()

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

◆ SetAndObserveLookupTable()

virtual void vtkMRMLColorTableNode::SetAndObserveLookupTable ( vtkLookupTable * newLookupTable)
virtual

Set lookup table object that this object will use.

See also
GetLookupTable()

◆ SetColor() [1/3]

int vtkMRMLColorTableNode::SetColor ( int entry,
const char * name,
double r,
double g,
double b,
double a = 1.0 )

Set a color into the User color table. Return 1 on success, 0 on failure.

◆ SetColor() [2/3]

int vtkMRMLColorTableNode::SetColor ( int entry,
double r,
double g,
double b )

◆ SetColor() [3/3]

int vtkMRMLColorTableNode::SetColor ( int entry,
double r,
double g,
double b,
double a )

Set a color into the User color table. Return 1 on success, 0 on failure. Note that this sets the Defined flag for the color entry to true. The

See also
SetColorDefined method can be used to unset it if needed.

◆ SetColors()

int vtkMRMLColorTableNode::SetColors ( int firstEntry,
int lastEntry,
const char * name,
double r,
double g,
double b,
double a = 1.0 )

Set many entries to the same name and color in one batch (with one ModifiedEvent). This is much more efficient than setting many color entries one by one using SetColor(). Note that this sets the Defined flag for the color entries to true. The

See also
SetColorDefined method can be used to unset it if needed.

◆ SetLookupTable()

virtual void vtkMRMLColorTableNode::SetLookupTable ( vtkLookupTable * newLookupTable)
inlinevirtual
Deprecated
Kept only for backward compatibility. Use SetAndObserveLookupTable method instead.
See also
SetAndObserveLookupTable()

Definition at line 66 of file vtkMRMLColorTableNode.h.

◆ SetNumberOfColors()

void vtkMRMLColorTableNode::SetNumberOfColors ( int n)

Set the size of the color table if it's a User table.

◆ SetOpacity()

int vtkMRMLColorTableNode::SetOpacity ( int entry,
double opacity )

◆ SetType()

void vtkMRMLColorTableNode::SetType ( int type)
overridevirtual

Get/Set for Type.

Reimplemented from vtkMRMLColorNode.

◆ SetTypeToBlue()

void vtkMRMLColorTableNode::SetTypeToBlue ( )

◆ SetTypeToCool1()

void vtkMRMLColorTableNode::SetTypeToCool1 ( )

◆ SetTypeToCool2()

void vtkMRMLColorTableNode::SetTypeToCool2 ( )

◆ SetTypeToCool3()

void vtkMRMLColorTableNode::SetTypeToCool3 ( )

◆ SetTypeToCoolShade1()

void vtkMRMLColorTableNode::SetTypeToCoolShade1 ( )

◆ SetTypeToCoolShade2()

void vtkMRMLColorTableNode::SetTypeToCoolShade2 ( )

◆ SetTypeToCoolShade3()

void vtkMRMLColorTableNode::SetTypeToCoolShade3 ( )

◆ SetTypeToCoolTint1()

void vtkMRMLColorTableNode::SetTypeToCoolTint1 ( )

◆ SetTypeToCoolTint2()

void vtkMRMLColorTableNode::SetTypeToCoolTint2 ( )

◆ SetTypeToCoolTint3()

void vtkMRMLColorTableNode::SetTypeToCoolTint3 ( )

◆ SetTypeToCyan()

void vtkMRMLColorTableNode::SetTypeToCyan ( )

◆ SetTypeToDesert()

void vtkMRMLColorTableNode::SetTypeToDesert ( )

◆ SetTypeToFMRI()

void vtkMRMLColorTableNode::SetTypeToFMRI ( )

◆ SetTypeToFMRIPA()

void vtkMRMLColorTableNode::SetTypeToFMRIPA ( )

◆ SetTypeToFullRainbow()

void vtkMRMLColorTableNode::SetTypeToFullRainbow ( )

◆ SetTypeToGreen()

void vtkMRMLColorTableNode::SetTypeToGreen ( )

◆ SetTypeToGrey()

void vtkMRMLColorTableNode::SetTypeToGrey ( )

◆ SetTypeToInvGrey()

void vtkMRMLColorTableNode::SetTypeToInvGrey ( )

◆ SetTypeToIron()

void vtkMRMLColorTableNode::SetTypeToIron ( )

◆ SetTypeToLabels()

void vtkMRMLColorTableNode::SetTypeToLabels ( )

◆ SetTypeToMagenta()

void vtkMRMLColorTableNode::SetTypeToMagenta ( )

◆ SetTypeToOcean()

void vtkMRMLColorTableNode::SetTypeToOcean ( )

◆ SetTypeToRainbow()

void vtkMRMLColorTableNode::SetTypeToRainbow ( )

◆ SetTypeToRandom()

void vtkMRMLColorTableNode::SetTypeToRandom ( )

◆ SetTypeToRed()

void vtkMRMLColorTableNode::SetTypeToRed ( )

◆ SetTypeToReverseRainbow()

void vtkMRMLColorTableNode::SetTypeToReverseRainbow ( )

◆ SetTypeToWarm1()

void vtkMRMLColorTableNode::SetTypeToWarm1 ( )

◆ SetTypeToWarm2()

void vtkMRMLColorTableNode::SetTypeToWarm2 ( )

◆ SetTypeToWarm3()

void vtkMRMLColorTableNode::SetTypeToWarm3 ( )

◆ SetTypeToWarmShade1()

void vtkMRMLColorTableNode::SetTypeToWarmShade1 ( )

◆ SetTypeToWarmShade2()

void vtkMRMLColorTableNode::SetTypeToWarmShade2 ( )

◆ SetTypeToWarmShade3()

void vtkMRMLColorTableNode::SetTypeToWarmShade3 ( )

◆ SetTypeToWarmTint1()

void vtkMRMLColorTableNode::SetTypeToWarmTint1 ( )

◆ SetTypeToWarmTint2()

void vtkMRMLColorTableNode::SetTypeToWarmTint2 ( )

◆ SetTypeToWarmTint3()

void vtkMRMLColorTableNode::SetTypeToWarmTint3 ( )

◆ SetTypeToYellow()

void vtkMRMLColorTableNode::SetTypeToYellow ( )

◆ WriteXML()

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

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

Reimplemented from vtkMRMLColorNode.

Reimplemented in vtkMRMLDiffusionTensorDisplayPropertiesNode.

Member Data Documentation

◆ LastAddedColor

int vtkMRMLColorTableNode::LastAddedColor {-1}
protected

keep track of where we last added a color.

Definition at line 260 of file vtkMRMLColorTableNode.h.

◆ LookupTable

vtkLookupTable* vtkMRMLColorTableNode::LookupTable
protected

The look up table, constructed according to the Type.

Definition at line 256 of file vtkMRMLColorTableNode.h.


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