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

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

Inheritance diagram for vtkMRMLColorNode:

[legend]

Collaboration diagram for vtkMRMLColorNode:

[legend]

Classes
struct	PropertyType

Public Types
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
virtual vtkLookupTable *	CreateLookupTableCopy ()

vtkMRMLNode *	CreateNodeInstance () override=0
	MRMLNode methods.

virtual const char *	GetClassName ()

virtual bool	GetColor (int ind, double color[4])=0

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.

virtual int	GetFirstType ()

virtual int	GetLastType ()

virtual vtkLookupTable *	GetLookupTable ()
	Most color nodes will implement a look up table, so provide a top level get method.

bool	GetModifiedSinceRead () override

int	GetNamesInitialised (int)

const char *	GetNodeTagName () override
	Get node XML tag name (like Volume, Model)

const char *	GetNoName ()

virtual int	GetNumberOfColors ()=0
	Get the number of colors in the table.

virtual vtkScalarsToColors *	GetScalarsToColors ()

std::string	GetTerminologyAsString (int ind)

vtkCodedEntry *	GetTerminologyCategory (int ind)
	Get terminology information for a color entry.

vtkCodedEntry *	GetTerminologyRegion (int ind)

vtkCodedEntry *	GetTerminologyRegionModifier (int ind)

vtkCodedEntry *	GetTerminologyType (int ind)

vtkCodedEntry *	GetTerminologyTypeModifier (int ind)

virtual int	GetType ()
	Get for Type.

virtual const char *	GetTypeAsString ()
	Return a text string describing the color look up table type.

virtual int	IsA (const char *type)

void	NamesInitialisedOff ()

void	NamesInitialisedOn ()

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
	MRMLNode methods.

void	Reset (vtkMRMLNode *defaultNode) override

void	SetAllColorsDefined ()
	Convenience method to set all colors as defined.

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)

virtual void	SetType (int type)
	Set Type to type, then build colors and set names.

void	SetTypeToFile ()

void	SetTypeToUser ()

void	UpdateScene (vtkMRMLScene *scene) override

	vtkMRMLCopyContentMacro (vtkMRMLColorNode)

void	WriteXML (ostream &of, int indent) override
	Write this node's information to a MRML file in XML format.

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 vtkMRMLStorageNode *	CreateDefaultSequenceStorageNode ()

virtual vtkMRMLStorageNode *	CreateDefaultStorageNode ()

virtual std::string	GetDefaultSequenceStorageNodeClassName ()

virtual std::string	GetDefaultStorageNodeClassName (const char *filename=nullptr)

vtkMRMLStorageNode *	GetNthStorageNode (int n)
	Get associated display MRML node.

const char *	GetNthStorageNodeID (int n)

int	GetNumberOfStorageNodes ()

const char *	GetSlicerDataType ()

vtkMRMLStorageNode *	GetStorageNode ()

const char *	GetStorageNodeID ()

virtual vtkTagTable *	GetUserTagTable ()
	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
vtkMRMLNode *	AddAndObserveNodeReferenceID (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.

vtkMRMLNode *	AddNodeReferenceID (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 ()

vtkMRMLNode *	GetNodeReference (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 ReferencePropertiesType *	GetNodeReferenceProperties (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.

vtkMRMLNode *	GetNthNodeReference (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 ReferencePropertiesType *	GetNthNodeReferenceProperties (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 vtkMRMLScene *	GetScene ()
	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)

vtkMRMLNode *	SetAndObserveNodeReferenceID (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.

vtkMRMLNode *	SetAndObserveNthNodeReferenceID (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.

vtkMRMLNode *	SetNodeReferenceID (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.

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.

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 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 vtkMRMLColorNode *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLStorableNode
static int	IsTypeOf (const char *type)

static vtkMRMLStorableNode *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLNode
static int	IsTypeOf (const char *type)

static vtkMRMLNode *	SafeDownCast (vtkObject *o)

Protected Member Functions
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.

vtkMRMLNode *	UpdateNodeReferenceEventObserver (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
std::vector< PropertyType >	Properties
	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

vtkTagTable *	UserTagTable

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.

vtkObserverManager *	MRMLObserverManager

char *	Name {nullptr}

NodeReferenceEventsType	NodeReferenceEvents

std::map< std::string, std::string >	NodeReferenceMRMLAttributeNames

NodeReferencesType	NodeReferences

int	SaveWithScene {true}

vtkWeakPointer< vtkMRMLScene >	Scene

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, NodeReferenceEventList >	NodeReferenceEventsType

typedef std::vector< vtkSmartPointer< vtkMRMLNodeReference > >	NodeReferenceListType

typedef std::map< std::string, NodeReferenceListType >	NodeReferencesType

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

Abstract MRML node to represent color information.

Color nodes describe color look up tables. The tables may be pre-generated by Slicer (the label map colors, some default ramps, a random one) or created by a user. More than one model or label volume or editor can access the prebuilt nodes. This is used as a superclass for table based, procedural based, and implicit function based color nodes. The color table always defined color in the range from 0 to maximum label value, but some of the colors in this range may remain undefined.

Subclasses must reimplement GetColor() and GetNumberOfColors().

Definition at line 42 of file vtkMRMLColorNode.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMRMLStorableNode vtkMRMLColorNode::Superclass

Definition at line 45 of file vtkMRMLColorNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

The list of valid color node types, added to in subclasses For backward compatibility, User and File keep the numbers that were in the ColorTable node

User - user defined in the GUI File - read in from file

Enumerator
User
File

Definition at line 255 of file vtkMRMLColorNode.h.

◆ anonymous enum

anonymous enum

TypeModifiedEvent is generated when the type of the color look up table changes.

Enumerator
TypeModifiedEvent

Definition at line 95 of file vtkMRMLColorNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLColorNode() [1/2]

vtkMRMLColorNode::vtkMRMLColorNode ( )

protected

◆ ~vtkMRMLColorNode()

vtkMRMLColorNode::~vtkMRMLColorNode ( )

overrideprotected

◆ vtkMRMLColorNode() [2/2]

vtkMRMLColorNode::vtkMRMLColorNode ( const vtkMRMLColorNode & )

protected

Member Function Documentation

◆ CreateLookupTableCopy()

virtual vtkLookupTable * vtkMRMLColorNode::CreateLookupTableCopy ( )

virtual

Helper function for copying lookup tables It handles special types of lookup tables and fixes error in vtkLookupTable copy.

◆ CreateNodeInstance()

vtkMRMLNode * vtkMRMLColorNode::CreateNodeInstance ( )

overridepure virtual

MRMLNode methods.

Implements vtkMRMLStorableNode.

Implemented in vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLDiffusionTensorDisplayPropertiesNode, vtkMRMLPETProceduralColorNode, and vtkMRMLProceduralColorNode.

◆ GetClassName()

virtual const char * vtkMRMLColorNode::GetClassName ( )

virtual

Reimplemented from vtkMRMLStorableNode.

Reimplemented in vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLDiffusionTensorDisplayPropertiesNode, vtkMRMLPETProceduralColorNode, and vtkMRMLProceduralColorNode.

◆ GetColor()

virtual bool vtkMRMLColorNode::GetColor	(	int	ind,
		double	color[4] )

pure virtual

Retrieve the color associated to the index. Must be reimplemented in the derived classes.

Returns: 1 if the color exists, 0 otherwise

Implemented in vtkMRMLColorTableNode, and vtkMRMLProceduralColorNode.

◆ GetColorDefined()

bool vtkMRMLColorNode::GetColorDefined ( int ind )

Returns true if the entry is defined.

◆ GetColorIndexByName()

int vtkMRMLColorNode::GetColorIndexByName ( const char * name )

Return the index associated with this color name, which can then be used to get the color. Returns -1 on failure.

See also: GetColorName()

◆ GetColorName()

const char * vtkMRMLColorNode::GetColorName ( int ind )

Get name of a color from its index (index is 0-based) Return empty string if undefined or if index is out of range.

See also: GetColorIndexByName()

◆ GetColorNameAsFileName()

std::string vtkMRMLColorNode::GetColorNameAsFileName	(	int	colorIndex,
		const char *	subst = "_" )

Get the 0'th based colorIndex'th name of this color, replacing all file name sensitive color name characters with safer character(s). Only alphanumeric characters (A-Z,a-z,0-9) and '-','','.','(',')','$', '!','~','#',','','^','{','}' are supported; '/', '&', '?', '<' ... are replaced with '' (or any other substitution string) While ' '(space) and accents are technically valid file name characters, they are replaced as an extra precaution. The color name is truncated to not be longer than 255 characters. subst can be made of invalid characters and be longer than 1 char

◆ GetColorNameWithoutSpaces()

std::string vtkMRMLColorNode::GetColorNameWithoutSpaces	(	int	ind,
		const char *	subst )

Deprecated: GetColorNameWithoutSpaces The method is no longer needed and will be removed in the future. Get the 0th based nth name of this color, replacing the spaces with subst

See also: GetColorNameAsFileName

◆ GetContainsTerminology()

bool vtkMRMLColorNode::GetContainsTerminology ( )

Returns true if the color table has terminology information.

◆ GetContainsTerminologyAttributeName()

const char * vtkMRMLColorNode::GetContainsTerminologyAttributeName ( )

inline

Get attribute name that indicates if the color table has terminology entries.

Definition at line 177 of file vtkMRMLColorNode.h.

◆ GetFirstType()

virtual int vtkMRMLColorNode::GetFirstType ( )

inlinevirtual

Return the lowest and highest integers, for use in looping. Override in subclasses when more enums are added.

Reimplemented in vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, and vtkMRMLPETProceduralColorNode.

Definition at line 88 of file vtkMRMLColorNode.h.

◆ GetLastType()

virtual int vtkMRMLColorNode::GetLastType ( )

inlinevirtual

Reimplemented in vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, and vtkMRMLPETProceduralColorNode.

Definition at line 89 of file vtkMRMLColorNode.h.

◆ GetLookupTable()

virtual vtkLookupTable * vtkMRMLColorNode::GetLookupTable ( )

virtual

Most color nodes will implement a look up table, so provide a top level get method.

Reimplemented in vtkMRMLColorTableNode, and vtkMRMLProceduralColorNode.

◆ GetModifiedSinceRead()

bool vtkMRMLColorNode::GetModifiedSinceRead ( )

overridevirtual

See also: vtkMRMLStorableNode::GetModifiedSinceRead()

Reimplemented from vtkMRMLStorableNode.

◆ GetNamesInitialised()

int vtkMRMLColorNode::GetNamesInitialised ( int )

inline

Definition at line 232 of file vtkMRMLColorNode.h.

◆ GetNodeTagName()

const char * vtkMRMLColorNode::GetNodeTagName ( )

inlineoverridevirtual

Get node XML tag name (like Volume, Model)

Implements vtkMRMLStorableNode.

Reimplemented in vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLDiffusionTensorDisplayPropertiesNode, vtkMRMLPETProceduralColorNode, and vtkMRMLProceduralColorNode.

Definition at line 65 of file vtkMRMLColorNode.h.

◆ GetNoName()

const char * vtkMRMLColorNode::GetNoName ( )

inline

Deprecated: GetNoName In the past, a color was considered undefined when the name matched the special string returned by GetNoName(). Now the color name has no special meaning, but ColorDefined flag determines if the color is defined. The GetNoName()/SetNoName() method is only kept for backward compatibility.

Definition at line 201 of file vtkMRMLColorNode.h.

◆ GetNumberOfColors()

virtual int vtkMRMLColorNode::GetNumberOfColors ( )

pure virtual

Get the number of colors in the table.

Implemented in vtkMRMLColorTableNode, and vtkMRMLProceduralColorNode.

◆ GetProperty()

bool vtkMRMLColorNode::GetProperty	(	int	ind,
		PropertyType &	prop )

protected

◆ GetScalarsToColors()

virtual vtkScalarsToColors * vtkMRMLColorNode::GetScalarsToColors ( )

virtual

Utility function that either returns a vtkLookupTable or a vtkColorTransferFunction whichever makes more sense. Returns vtkMRMLColorNode::GetLookupTable() by default. You should the method if you want it to return something else in subclasses

Reimplemented in vtkMRMLProceduralColorNode.

◆ GetTerminologyAsString() [1/2]

std::string vtkMRMLColorNode::GetTerminologyAsString ( int ind )

◆ GetTerminologyAsString() [2/2]

static std::string vtkMRMLColorNode::GetTerminologyAsString	(	std::string	terminologyContextName,
		vtkCodedEntry *	category,
		vtkCodedEntry *	type,
		vtkCodedEntry *	typeModifier,
		std::string	regionContextName = "",
		vtkCodedEntry *	region = nullptr,
		vtkCodedEntry *	regionModifier = nullptr )

static

Convert coded entries to a string.

◆ GetTerminologyCategory()

vtkCodedEntry * vtkMRMLColorNode::GetTerminologyCategory ( int ind )

Get terminology information for a color entry.

◆ GetTerminologyRegion()

vtkCodedEntry * vtkMRMLColorNode::GetTerminologyRegion ( int ind )

◆ GetTerminologyRegionModifier()

vtkCodedEntry * vtkMRMLColorNode::GetTerminologyRegionModifier ( int ind )

◆ GetTerminologyType()

vtkCodedEntry * vtkMRMLColorNode::GetTerminologyType ( int ind )

◆ GetTerminologyTypeModifier()

vtkCodedEntry * vtkMRMLColorNode::GetTerminologyTypeModifier ( int ind )

◆ GetType()

virtual int vtkMRMLColorNode::GetType ( )

virtual

Get for Type.

◆ GetTypeAsString()

virtual const char * vtkMRMLColorNode::GetTypeAsString ( )

virtual

Return a text string describing the color look up table type.

Reimplemented in vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLPETProceduralColorNode, and vtkMRMLProceduralColorNode.

◆ IsA()

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

virtual

Reimplemented from vtkMRMLStorableNode.

Reimplemented in vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLDiffusionTensorDisplayPropertiesNode, vtkMRMLPETProceduralColorNode, and vtkMRMLProceduralColorNode.

◆ IsTypeOf()

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

static

◆ NamesInitialisedOff()

void vtkMRMLColorNode::NamesInitialisedOff ( )

inline

Definition at line 224 of file vtkMRMLColorNode.h.

◆ NamesInitialisedOn()

void vtkMRMLColorNode::NamesInitialisedOn ( )

inline

Deprecated: SetNamesInitialised This method has no effect and kept for backward compatility only. Usually this method just not need to be called anymore. Use SetColorName() and SetColorDefined() methods to set or undefine color names.

See also: GetNoName()

Definition at line 220 of file vtkMRMLColorNode.h.

◆ operator=()

void vtkMRMLColorNode::operator= ( const vtkMRMLColorNode & )

protected

◆ PrintSelf()

void vtkMRMLColorNode::PrintSelf	(	ostream &	os,
		vtkIndent	indent )

override

◆ ProcessMRMLEvents()

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

overridevirtual

Propagate events generated in mrml.

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLPETProceduralColorNode, and vtkMRMLProceduralColorNode.

◆ ReadXMLAttributes()

void vtkMRMLColorNode::ReadXMLAttributes ( const char ** atts )

overridevirtual

MRMLNode methods.

Set node attributes

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLDiffusionTensorDisplayPropertiesNode, vtkMRMLPETProceduralColorNode, and vtkMRMLProceduralColorNode.

◆ Reset()

void vtkMRMLColorNode::Reset ( vtkMRMLNode * defaultNode )

overridevirtual

Reset node attributes to the initial state as defined in the constructor. NOTE: it preserves values several dynamic attributes that may be set by an application: type, name

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLColorTableNode.

◆ SafeDownCast()

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

static

◆ SetAllColorsDefined()

void vtkMRMLColorNode::SetAllColorsDefined ( )

Convenience method to set all colors as defined.

◆ SetColorDefined()

void vtkMRMLColorNode::SetColorDefined	(	int	ind,
		bool	defined )

Set the color defined flag for the given entry.

◆ SetColorName()

int vtkMRMLColorNode::SetColorName	(	int	ind,
		const char *	name )

Set the name of the n-th entry. Note that this sets the Defined flag for the color entry to true.

Returns: 1 on success, 0 on failure.

◆ SetColorNameWithSpaces()

int vtkMRMLColorNode::SetColorNameWithSpaces	(	int	ind,
		const char *	name,
		const char *	subst )

Deprecated: SetColorNameWithSpaces The method is no longer needed and will be removed in the future. Set the name of the n-th entry, replacing the subst character by space. Returns 1 on success, 0 on failure

◆ SetContainsTerminology()

void vtkMRMLColorNode::SetContainsTerminology ( bool containsTerminology )

protected

Sets whether the color table has terminology information.

◆ SetNameFromColor()

virtual bool vtkMRMLColorNode::SetNameFromColor ( int index )

protectedvirtual

Set values in the names vector from the colors in the node.

Reimplemented in vtkMRMLProceduralColorNode.

◆ SetNamesFromColors()

void vtkMRMLColorNode::SetNamesFromColors ( )

Set values in the names vector from the colors in the node It is not recommended to use this method, because it makes the name and color columns of the table store redundant information, which may get out of sync. Saving automatically-generated color names in the table also interferes with automatically updating the displayed table when terminology is specified or when displaying the color table in an internationalized GUI.

◆ SetNamesInitialised()

void vtkMRMLColorNode::SetNamesInitialised ( int )

inline

Definition at line 228 of file vtkMRMLColorNode.h.

◆ SetNoName()

void vtkMRMLColorNode::SetNoName ( const char * )

inline

Deprecated: SetNoName This method has no effect and kept for backward compatility only. Use GetColorDefined() and SetColorDefined() methods instead.

See also: GetNoName()

Definition at line 209 of file vtkMRMLColorNode.h.

◆ SetTerminology()

bool vtkMRMLColorNode::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 = "" )

Set terminology information for a color entry. This is mostly for convenience in Python.

◆ SetTerminologyFromString()

bool vtkMRMLColorNode::SetTerminologyFromString	(	int	ind,
		std::string	terminologyString )

Set terminology information for a color entry from a string. The string can be constructed from coded entries using GetTerminologyAsString() method.

◆ SetType()

virtual void vtkMRMLColorNode::SetType ( int type )

virtual

Set Type to type, then build colors and set names.

Reimplemented in vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, and vtkMRMLPETProceduralColorNode.

◆ SetTypeToFile()

void vtkMRMLColorNode::SetTypeToFile ( )

◆ SetTypeToUser()

void vtkMRMLColorNode::SetTypeToUser ( )

Set the type to User or File, ones that don't require building data structures, just setting flags

◆ UpdateScene()

void vtkMRMLColorNode::UpdateScene ( vtkMRMLScene * )

overridevirtual

Updates other nodes in the scene depending on this node or updates this node if it depends on other nodes when the scene is read in This method is called automatically by XML parser after all nodes are created

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLdGEMRICProceduralColorNode, vtkMRMLPETProceduralColorNode, and vtkMRMLProceduralColorNode.

◆ vtkMRMLCopyContentMacro()

vtkMRMLColorNode::vtkMRMLCopyContentMacro ( vtkMRMLColorNode )

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

See also: vtkMRMLNode::CopyContent

◆ WriteXML()

void vtkMRMLColorNode::WriteXML	(	ostream &	of,
		int	indent )

overridevirtual

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

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLDiffusionTensorDisplayPropertiesNode, vtkMRMLPETProceduralColorNode, and vtkMRMLProceduralColorNode.

Member Data Documentation

◆ Properties

std::vector<PropertyType> vtkMRMLColorNode::Properties

protected

Vector of names and other properties for the color table elements.

Definition at line 332 of file vtkMRMLColorNode.h.

◆ Type

int vtkMRMLColorNode::Type

protected

Which type of color information does this node hold? Valid values are in the enumerated list

Definition at line 329 of file vtkMRMLColorNode.h.

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

Libs/MRML/Core/vtkMRMLColorNode.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkMRMLColorNode() [1/2]

◆ ~vtkMRMLColorNode()

◆ vtkMRMLColorNode() [2/2]

Member Function Documentation

◆ CreateLookupTableCopy()

◆ CreateNodeInstance()

◆ GetClassName()

◆ GetColor()

◆ GetColorDefined()

◆ GetColorIndexByName()

◆ GetColorName()

◆ GetColorNameAsFileName()

◆ GetColorNameWithoutSpaces()

◆ GetContainsTerminology()

◆ GetContainsTerminologyAttributeName()

◆ GetFirstType()

◆ GetLastType()

◆ GetLookupTable()

◆ GetModifiedSinceRead()

◆ GetNamesInitialised()

◆ GetNodeTagName()

◆ GetNoName()

◆ GetNumberOfColors()

◆ GetProperty()

◆ GetScalarsToColors()

◆ GetTerminologyAsString() [1/2]

◆ GetTerminologyAsString() [2/2]

◆ GetTerminologyCategory()

◆ GetTerminologyRegion()

◆ GetTerminologyRegionModifier()

◆ GetTerminologyType()

◆ GetTerminologyTypeModifier()

◆ GetType()

◆ GetTypeAsString()

◆ IsA()

◆ IsTypeOf()

◆ NamesInitialisedOff()

◆ NamesInitialisedOn()

◆ operator=()

◆ PrintSelf()

◆ ProcessMRMLEvents()

◆ ReadXMLAttributes()

◆ Reset()

◆ SafeDownCast()

◆ SetAllColorsDefined()

◆ SetColorDefined()

◆ SetColorName()

◆ SetColorNameWithSpaces()

◆ SetContainsTerminology()

◆ SetNameFromColor()

◆ SetNamesFromColors()

◆ SetNamesInitialised()

◆ SetNoName()

◆ SetTerminology()

◆ SetTerminologyFromString()

◆ SetType()

◆ SetTypeToFile()

◆ SetTypeToUser()

◆ UpdateScene()

◆ vtkMRMLCopyContentMacro()

◆ WriteXML()

Member Data Documentation

◆ Properties

◆ Type