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

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

Inheritance diagram for vtkMRMLColorTableNode:

[legend]

Collaboration diagram for vtkMRMLColorTableNode:

[legend]

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 }

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 More...

void	ClearNames ()
	clear out the names list More...

void	Copy (vtkMRMLNode *node) override
	Copy the node's attributes to this object More...

vtkMRMLStorageNode *	CreateDefaultStorageNode () override
	Create default storage node or nullptr if does not have one More...

vtkMRMLNode *	CreateNodeInstance () override
	MRMLNode methods. More...

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 More...

int	GetLastType () override

vtkLookupTable *	GetLookupTable () override

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

int	GetNumberOfColors () override
	Set the size of the color table if it's a User table More...

const char *	GetTypeAsString () override
	return a text string describing the color look up table type More...

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. More...

void	ReadXMLAttributes (const char **atts) override
	Set node attributes More...

void	Reset (vtkMRMLNode *defaultNode) override
	reset when close the scene More...

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. More...

int	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. More...

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

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 More...

int	SetOpacity (int entry, double opacity)

void	SetType (int type) override
	Get/Set for Type More...

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. More...

Public Member Functions inherited from vtkMRMLColorNode
virtual vtkLookupTable *	CreateLookupTableCopy ()

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)

virtual char *	GetFileName ()

bool	GetModifiedSinceRead () override

virtual int	GetNamesInitialised ()
	Get/Set for the flag on names array having been initialised More...

virtual char *	GetNoName ()

virtual vtkScalarsToColors *	GetScalarsToColors ()

virtual int	GetType ()
	Get for Type More...

virtual void	NamesInitialisedOff ()

virtual void	NamesInitialisedOn ()

void	PrintSelf (ostream &os, vtkIndent indent) override

int	SetColorName (int ind, const char *name)

int	SetColorNameWithSpaces (int ind, const char name, const char subst)

virtual void	SetFileName (const char *)
	Name of the file name from which to read color information More...

void	SetNamesFromColors ()
	Set values in the names vector from the colors in the node More...

virtual void	SetNamesInitialised (int)

virtual void	SetNoName (const char *)

void	SetTypeToFile ()

void	SetTypeToUser ()

void	UpdateScene (vtkMRMLScene *scene) override

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. More...

virtual vtkMRMLStorageNode *	CreateDefaultSequenceStorageNode ()

virtual std::string	GetDefaultSequenceStorageNodeClassName ()

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

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

const char *	GetNthStorageNodeID (int n)

int	GetNumberOfStorageNodes ()

const char *	GetSlicerDataType ()

vtkMRMLStorageNode *	GetStorageNode ()

const char *	GetStorageNodeID ()

virtual vtkTagTable *	GetUserTagTable ()
	Methods for user-specified metadata. More...

bool	HasStorageNodeID (const char *storageNodeID)
	Return true if storageNodeID is in the storage node ID list. More...

void	PrintSelf (ostream &os, vtkIndent indent) override

void	ProcessMRMLEvents (vtkObject , unsigned long, void ) override
	alternative method to propagate events generated in Storage nodes More...

void	ReadXMLAttributes (const char **atts) override
	Read node attributes from XML file More...

void	SetAndObserveNthStorageNodeID (int n, const char *storageNodeID)

void	SetAndObserveStorageNodeID (const char *storageNodeID)
	String ID of the storage MRML node More...

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 More...

	vtkMRMLCopyContentMacro (vtkMRMLStorableNode)

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 vtkMRMLNode
vtkMRMLNode *	AddAndObserveNodeReferenceID (const char referenceRole, const char referencedNodeID, vtkIntArray *events=nullptr)
	Add and observe a reference node from this node for a specific referenceRole. More...

vtkMRMLNode *	AddNodeReferenceID (const char referenceRole, const char referencedNodeID)
	Convenience method that adds a referencedNodeID at the end of the list. More...

void	AddNodeReferenceRole (const char referenceRole, const char mrmlAttributeName=nullptr, vtkIntArray *events=nullptr)
	Add a referenceRole. More...

virtual void	AddToSceneOff ()

virtual void	AddToSceneOn ()

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. More...

virtual void	CopyReferences (vtkMRMLNode *node)
	Copy the references of the node into this. More...

void	CopyWithScene (vtkMRMLNode *node)
	Copy everything (including Scene and ID) from another node of the same type. More...

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 vtkIntArray *	GetContentModifiedEvents ()

int	GetCustomModifiedEventPending (int eventId)

virtual char *	GetDescription ()

virtual int	GetDisableModifiedEvent ()
	Turn on/off generating InvokeEvent for set macros. More...

virtual int	GetHideFromEditors ()
	Describes if the node is hidden. More...

virtual char *	GetID ()
	ID use by other nodes to reference this node in XML. More...

virtual int	GetInMRMLCallbackFlag ()
	Flags to avoid event loops. More...

virtual int	GetModifiedEventPending ()

virtual char *	GetName ()

vtkMRMLNode *	GetNodeReference (const char *referenceRole)

const char *	GetNodeReferenceID (const char *referenceRole)
	Utility function that returns the first node id for a specific referenceRole. More...

void	GetNodeReferenceIDs (const char referenceRole, std::vector< const char > &referencedNodeIDs)
	Return a list of the referenced node IDs. More...

void	GetNodeReferenceRoles (std::vector< std::string > &roles)

void	GetNodeReferences (const char referenceRole, std::vector< vtkMRMLNode > &nodes)
	Return a list of the referenced nodes. More...

vtkMRMLNode *	GetNthNodeReference (const char *referenceRole, int n)
	Get referenced MRML node for a specific referenceRole. More...

const char *	GetNthNodeReferenceID (const char *referenceRole, int n)
	Return the string of the Nth node ID for a specific reference role. More...

const char *	GetNthNodeReferenceRole (int n)

int	GetNumberOfNodeReferenceRoles ()

int	GetNumberOfNodeReferences (const char *referenceRole)
	Return the number of node IDs for a specific reference role (and nodes as they always have the same size). More...

virtual int	GetSaveWithScene ()
	Save node with MRML scene. More...

virtual vtkMRMLScene *	GetScene ()
	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 const char *	GetTypeDisplayName ()

virtual bool	GetUndoEnabled ()

virtual bool	HasCopyContent () const
	Returns true if the class supports deep and shallow copying node content. More...

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	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)
	Set and observe a reference node from this node for a specific referenceRole. More...

vtkMRMLNode *	SetAndObserveNthNodeReferenceID (const char referenceRole, int n, const char referencedNodeID, vtkIntArray *events=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...

vtkMRMLNode *	SetNodeReferenceID (const char referenceRole, const char referencedNodeID)
	Set a reference to a node with specified nodeID from this node for a specific referenceRole. More...

vtkMRMLNode *	SetNthNodeReferenceID (const char referenceRole, int n, const char referencedNodeID)
	Set a N-th reference from this node with specified referencedNodeID for a specific referenceRole. More...

virtual void	SetSaveWithScene (int)

virtual void	SetScene (vtkMRMLScene *scene)
	This method is for internal use only. Use AddNode method of vtkMRMLScene to add a node to the scene. More...

virtual void	SetSceneReferences ()
	Update the references of the node to the scene. More...

virtual void	SetSelectable (int)

virtual void	SetSelected (int)

void	SetSingletonOff ()

void	SetSingletonOn ()

virtual void	SetSingletonTag (const char *)
	Tag that make this node a singleton in the scene. More...

virtual void	SetUndoEnabled (bool)

virtual int	StartModify ()
	Start modifying the node. Disable Modify events. More...

virtual void	UndoEnabledOff ()

virtual void	UndoEnabledOn ()

virtual void	UpdateReferenceID (const char oldID, const char newID)
	Update the stored reference to another node in the scene. More...

virtual void	UpdateReferences ()
	The method should remove all pointers and observations to all nodes that are not in the scene anymore. More...

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 vtkMRMLColorTableNode *	New ()

static vtkMRMLColorTableNode *	SafeDownCast (vtkObject *o)

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

static vtkMRMLColorNode *	New ()

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)

Public Attributes
int	LastAddedColor
	keep track of where we last added a color More...

Protected Member Functions
void	operator= (const vtkMRMLColorTableNode &)

	vtkMRMLColorTableNode ()

	vtkMRMLColorTableNode (const vtkMRMLColorTableNode &)

	~vtkMRMLColorTableNode () override

Protected Member Functions inherited from vtkMRMLColorNode
virtual bool	HasNameFromColor (int index)

void	operator= (const vtkMRMLColorNode &)

virtual bool	SetNameFromColor (int index)
	Set values in the names vector from the colors in the node More...

	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. 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::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. More...

vtkMRMLNode *	UpdateNodeReferenceEventObserver (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
vtkLookupTable *	LookupTable
	The look up table, constructed according to the Type More...

Protected Attributes inherited from vtkMRMLColorNode
char *	FileName
	A file name to read text attributes from More...

std::vector< std::string >	Names
	A vector of names for the color table elements More...

int	NamesInitialised
	Have the color names been set? Used to do lazy copy of the Names array. More...

char *	NoName
	the string used for an unnamed color More...

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 More...

vtkCallbackCommand *	MRMLCallbackCommand
	Holders for MRML callbacks. More...

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, vtkSmartPointer< vtkIntArray > >	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

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

typedef vtkMRMLColorNode vtkMRMLColorTableNode::Superclass

Definition at line 30 of file vtkMRMLColorTableNode.h.

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 vtkMRMLColorNode.

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.

Reimplemented from 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

Reimplemented from 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

Reimplemented from 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.

◆ 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,
		double	a
	)

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

◆ SetColor() [3/3]

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

◆ 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().

◆ 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

keep track of where we last added a color

Definition at line 205 of file vtkMRMLColorTableNode.h.

◆ LookupTable

vtkLookupTable* vtkMRMLColorTableNode::LookupTable

protected

The look up table, constructed according to the Type

Definition at line 248 of file vtkMRMLColorTableNode.h.

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

Libs/MRML/Core/vtkMRMLColorTableNode.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkMRMLColorTableNode() [1/2]

◆ ~vtkMRMLColorTableNode()

◆ vtkMRMLColorTableNode() [2/2]

Member Function Documentation

◆ AddColor()

◆ ClearNames()

◆ Copy()

◆ CreateDefaultStorageNode()

◆ CreateNodeInstance()

◆ GetClassName()

◆ GetColor()

◆ GetFirstType()

◆ GetLastType()

◆ GetLookupTable()

◆ GetNodeTagName()

◆ GetNumberOfColors()

◆ GetTypeAsString()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ operator=()

◆ PrintSelf()

◆ ProcessMRMLEvents()

◆ ReadXMLAttributes()

◆ Reset()

◆ SafeDownCast()

◆ SetAndObserveLookupTable()

◆ SetColor() [1/3]

◆ SetColor() [2/3]

◆ SetColor() [3/3]

◆ SetColors()

◆ SetLookupTable()

◆ SetNumberOfColors()

◆ SetOpacity()

◆ SetType()

◆ SetTypeToBlue()

◆ SetTypeToCool1()

◆ SetTypeToCool2()

◆ SetTypeToCool3()

◆ SetTypeToCoolShade1()

◆ SetTypeToCoolShade2()

◆ SetTypeToCoolShade3()

◆ SetTypeToCoolTint1()

◆ SetTypeToCoolTint2()

◆ SetTypeToCoolTint3()

◆ SetTypeToCyan()

◆ SetTypeToDesert()

◆ SetTypeToFMRI()

◆ SetTypeToFMRIPA()

◆ SetTypeToFullRainbow()

◆ SetTypeToGreen()

◆ SetTypeToGrey()

◆ SetTypeToInvGrey()

◆ SetTypeToIron()

◆ SetTypeToLabels()

◆ SetTypeToMagenta()

◆ SetTypeToOcean()

◆ SetTypeToRainbow()

◆ SetTypeToRandom()

◆ SetTypeToRed()

◆ SetTypeToReverseRainbow()

◆ SetTypeToWarm1()

◆ SetTypeToWarm2()

◆ SetTypeToWarm3()

◆ SetTypeToWarmShade1()

◆ SetTypeToWarmShade2()

◆ SetTypeToWarmShade3()