vtkMRMLColorNode Class Reference

#include <vtkMRMLColorNode.h>

Inheritance diagram for vtkMRMLColorNode:

List of all members.

Public Types
enum	{ TypeModifiedEvent = 20002 }
Public Member Functions
void	AddColorName (const char *name)
virtual void	ApplyTransform (vtkMatrix4x4 *transformMatrix)
virtual void	ApplyTransform (vtkAbstractTransform *vtkNotUsed(transform))
virtual bool	CanApplyNonLinearTransforms ()
virtual void	Copy (vtkMRMLNode *node)
virtual vtkMRMLStorageNode *	CreateDefaultStorageNode ()
virtual vtkMRMLNode *	CreateNodeInstance ()
	MRMLNode methods.
const char *	GetColorName (int ind)
std::string	GetColorNameWithoutSpaces (int ind, const char *subst)
virtual int	GetFirstType ()
virtual int	GetLastType ()
virtual vtkLookupTable *	GetLookupTable ()
virtual const char *	GetNodeTagName ()
virtual const char *	GetTypeAsString ()
void	PrintSelf (ostream &os, vtkIndent indent)
void	ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData)
virtual void	ReadXMLAttributes (const char **atts)
virtual void	Reset ()
int	SetColorName (int ind, const char *name)
int	SetColorNameWithSpaces (int ind, const char *name, const char *subst)
virtual void	SetType (int type)
virtual void	UpdateScene (vtkMRMLScene *scene)
	vtkBooleanMacro (NamesInitialised, int)
	vtkGetMacro (NamesInitialised, int)
	vtkGetMacro (Type, int)
	vtkGetStringMacro (NoName)
	vtkGetStringMacro (FileName)
	vtkSetMacro (NamesInitialised, int)
	vtkSetStringMacro (NoName)
	vtkSetStringMacro (FileName)
	vtkTypeMacro (vtkMRMLColorNode, vtkMRMLStorableNode)
virtual void	WriteXML (ostream &of, int indent)
Static Public Member Functions
static vtkMRMLColorNode *	New ()
Protected Member Functions
void	operator= (const vtkMRMLColorNode &)
virtual void	SetNamesFromColors ()
	vtkMRMLColorNode (const vtkMRMLColorNode &)
	vtkMRMLColorNode ()
virtual	~vtkMRMLColorNode ()
Protected Attributes
char *	FileName
std::vector< std::string >	Names
int	NamesInitialised
char *	NoName
int	Type

---

Detailed Description

vtkMRMLColorNode - MRML node to represent color information.

Color nodes describe colour look up tables. The tables may be pre-generated by Slicer (the label map colours, 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

---

Member Enumeration Documentation

anonymous enum

TypeModifiedEvent is generated when the type of the colour look up table changes

Enumerator:

TypeModifiedEvent

---

Constructor & Destructor Documentation

vtkMRMLColorNode::vtkMRMLColorNode

(

)

[protected]

References FileName, vtkMRMLNode::HideFromEditors, vtkMRMLNode::Name, NamesInitialised, NoName, and Type.

vtkMRMLColorNode::~vtkMRMLColorNode

(

)

[protected, virtual]

References FileName, and NoName.

vtkMRMLColorNode::vtkMRMLColorNode

(

const vtkMRMLColorNode &

)

[protected]

---

Member Function Documentation

void vtkMRMLColorNode::AddColorName

(

const char *

name

)

Add a color name to the vector

References Names.

virtual void vtkMRMLColorNode::ApplyTransform

(

vtkMatrix4x4 *

transformMatrix

)

[inline, virtual]

Reimplemented from vtkMRMLTransformableNode.

virtual void vtkMRMLColorNode::ApplyTransform

(

vtkAbstractTransform *

vtkNotUsedtransform

)

[inline, virtual]

Reimplemented in vtkMRMLColorTableNodeTestHelper1, and vtkMRMLDiffusionTensorDisplayPropertiesNodeTestHelper1.

virtual bool vtkMRMLColorNode::CanApplyNonLinearTransforms

(

)

[inline, virtual]

Implements vtkMRMLTransformableNode.

Reimplemented in vtkMRMLColorTableNodeTestHelper1, and vtkMRMLDiffusionTensorDisplayPropertiesNodeTestHelper1.

void vtkMRMLColorNode::Copy

(

vtkMRMLNode *

node

)

[virtual]

Copy the node's attributes to this object

Reimplemented from vtkMRMLStorableNode.

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

References vtkMRMLNode::EndModify(), FileName, Names, NamesInitialised, NoName, vtkMRMLNode::StartModify(), and Type.

virtual vtkMRMLStorageNode* vtkMRMLColorNode::CreateDefaultStorageNode

(

)

[inline, virtual]

Create default storage node or NULL if does not have one

Reimplemented from vtkMRMLStorableNode.

Reimplemented in vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLPETProceduralColorNode, and vtkMRMLProceduralColorNode.

Referenced by ReadXMLAttributes().

vtkMRMLNode * vtkMRMLColorNode::CreateNodeInstance

(

void

)

[virtual]

MRMLNode methods.

Implements vtkMRMLStorableNode.

Reimplemented in vtkMRMLColorNodeTestHelper1, vtkMRMLColorTableNodeTestHelper1, vtkMRMLDiffusionTensorDisplayPropertiesNodeTestHelper1, vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLDiffusionTensorDisplayPropertiesNode, vtkMRMLFreeSurferProceduralColorNode, vtkMRMLGlyphableVolumeDisplayPropertiesNode, vtkMRMLPETProceduralColorNode, and vtkMRMLProceduralColorNode.

References autoSlicerTracto2regions::ret.

const char * vtkMRMLColorNode::GetColorName

(

int

ind

)

Get the 0th based nth name of this colour

References Names, NoName, and SetNamesFromColors().

Referenced by vtkSlicerColorGUI::AddLUTsToColorDialog(), vtkSlicerColorEditWidget::CopyAndEditColorTableNode(), GetColorNameWithoutSpaces(), vtkMRMLColorTableNode::PrintSelf(), PrintSelf(), vtkMRMLColorTableNode::SetColor(), vtkSlicerColorDisplayWidget::UpdateElement(), vtkSlicerColorEditWidget::UpdateWidget(), and vtkSlicerColorDisplayWidget::UpdateWidget().

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

Get the 0th based nth name of this colour, replacing the spaces with subst

References GetColorName(), and slicerget::name.

Referenced by vtkMRMLColorTableStorageNode::WriteData(), vtkMRMLFreeSurferProceduralColorNode::WriteXML(), and vtkMRMLColorTableNode::WriteXML().

int vtkMRMLColorNode::GetFirstType

(

)

[virtual]

Return the lowest and the highest type integers (defined in enum in subclass), for use in looping

Reimplemented in vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLFreeSurferProceduralColorNode, and vtkMRMLPETProceduralColorNode.

int vtkMRMLColorNode::GetLastType

(

)

[virtual]

Reimplemented in vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLFreeSurferProceduralColorNode, and vtkMRMLPETProceduralColorNode.

vtkLookupTable * vtkMRMLColorNode::GetLookupTable

(

)

[virtual]

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

Reimplemented in vtkMRMLFreeSurferProceduralColorNode.

Referenced by vtkSlicerColorGUI::AddLUTsToColorDialog(), vtkSlicerSliceLogic::AddSliceGlyphs(), vtkSlicerColorEditWidget::CopyAndEditColorTableNode(), vtkSlicerColorEditWidget::GenerateNewColorTableNode(), vtkPharmacokineticsGUI::GeneratePlotNodes(), vtkMRMLColorTableNode::GetNumberOfColors(), main(), vtkMRMLColorTableStorageNode::ReadData(), vtkMRMLColorTableNode::SetColor(), vtkSlicerViewerWidget::SetModelDisplayProperty(), vtkMRMLColorTableNode::SetNamesFromColors(), vtkMRMLColorTableNode::SetNumberOfColors(), vtkMRMLColorTableNode::SetType(), vtkVolumeRenderingLogic::SetupFgVolumePropertyFromImageData(), vtkVolumeRenderingLogic::SetupVolumePropertyFromImageData(), vtkChangeTrackerAnalysisStep::ShowUserInterface(), vtkMRMLScalarVolumeDisplayNode::UpdateImageDataPipeline(), vtkMRMLLabelMapVolumeDisplayNode::UpdateImageDataPipeline(), vtkSlicerColorDisplayWidget::UpdateMRML(), vtkPETCTFusionGUI::UpdateResultsTableFromMRML(), vtkVolumeRenderingLogic::UpdateVolumePropertyByDisplayNode(), vtkSlicerColorEditWidget::UpdateWidget(), vtkSlicerColorDisplayWidget::UpdateWidget(), and vtkMRMLColorTableStorageNode::WriteData().

virtual const char* vtkMRMLColorNode::GetNodeTagName

(

)

[inline, virtual]

Get node XML tag name (like Volume, Model)

Implements vtkMRMLStorableNode.

Reimplemented in vtkMRMLColorTableNodeTestHelper1, vtkMRMLDiffusionTensorDisplayPropertiesNodeTestHelper1, vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLDiffusionTensorDisplayPropertiesNode, vtkMRMLFreeSurferProceduralColorNode, vtkMRMLGlyphableVolumeDisplayPropertiesNode, vtkMRMLPETProceduralColorNode, and vtkMRMLProceduralColorNode.

Referenced by vtkMRMLColorNodeTest1().

const char * vtkMRMLColorNode::GetTypeAsString

(

)

[virtual]

return a text string describing the colour look up table type

Reimplemented in vtkMRMLColorNodeTestHelper1, vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLFreeSurferProceduralColorNode, and vtkMRMLPETProceduralColorNode.

Referenced by PrintSelf(), vtkMRMLProceduralColorNode::SetType(), and vtkSlicerColorDisplayWidget::UpdateWidget().

vtkMRMLColorNode * vtkMRMLColorNode::New

(

)

[static]

Reimplemented from vtkMRMLStorableNode.

Reimplemented in vtkMRMLColorNodeTestHelper1, vtkMRMLColorTableNodeTestHelper1, vtkMRMLDiffusionTensorDisplayPropertiesNodeTestHelper1, vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLDiffusionTensorDisplayPropertiesNode, vtkMRMLFreeSurferProceduralColorNode, vtkMRMLGlyphableVolumeDisplayPropertiesNode, vtkMRMLPETProceduralColorNode, and vtkMRMLProceduralColorNode.

References autoSlicerTracto2regions::ret.

void vtkMRMLColorNode::operator=

(

const vtkMRMLColorNode &

)

[protected]

Reimplemented from vtkMRMLStorableNode.

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

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

Reimplemented from vtkMRMLStorableNode.

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

References GetColorName(), GetTypeAsString(), vtkMRMLNode::Name, Names, and NoName.

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

alternative method to propagate events generated in Storage nodes

Reimplemented from vtkMRMLStorableNode.

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

void vtkMRMLColorNode::ReadXMLAttributes

(

const char **

atts

)

[virtual]

Set node attributes

Reimplemented from vtkMRMLStorableNode.

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

References vtkMRMLScene::AddNode(), CreateDefaultStorageNode(), vtkMRMLNode::EndModify(), vtkMRMLNode::GetScene(), vtkMRMLStorableNode::GetStorageNode(), vtkMRMLStorableNode::SetAndObserveStorageNodeID(), SetType(), vtkMRMLNode::StartModify(), and type.

void vtkMRMLColorNode::Reset

(

)

[virtual]

Reset node attributes to the initilal 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.

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

Set the 0th based nth name of this colour. Returns 1 on success, 0 on failure.

References Names.

Referenced by vtkMRMLColorTableStorageNode::ReadData(), vtkMRMLColorTableNode::SetColor(), SetColorNameWithSpaces(), vtkMRMLProceduralColorNode::SetNamesFromColors(), vtkMRMLFreeSurferProceduralColorNode::SetNamesFromColors(), vtkMRMLColorTableNode::SetNamesFromColors(), vtkMRMLColorTableNode::SetType(), and vtkSlicerColorDisplayWidget::UpdateElement().

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

Set the 0th based nth name of this colour, replacing the subst character with spaces. Returns 1 on success, 0 on failure

References SetColorName().

Referenced by vtkMRMLFreeSurferProceduralColorNode::ReadXMLAttributes(), and vtkMRMLColorTableNode::ReadXMLAttributes().

void vtkMRMLColorNode::SetNamesFromColors

(

)

[protected, virtual]

Set values in the names vector from the colours in the node

Reimplemented in vtkMRMLColorTableNode, vtkMRMLFreeSurferProceduralColorNode, and vtkMRMLProceduralColorNode.

Referenced by GetColorName().

void vtkMRMLColorNode::SetType

(

int

type

)

[virtual]

Set Type to type, then build colours and set names

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

References vtkMRMLNode::Modified(), Type, and TypeModifiedEvent.

Referenced by ReadXMLAttributes().

void vtkMRMLColorNode::UpdateScene

(

vtkMRMLScene *

scene

)

[virtual]

Finds the storage node and read the data

Reimplemented from vtkMRMLStorableNode.

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

vtkMRMLColorNode::vtkBooleanMacro	(	NamesInitialised	,
		int
	)

vtkMRMLColorNode::vtkGetMacro	(	NamesInitialised	,
		int
	)

Get/Set for the flag on names array having been initalised

vtkMRMLColorNode::vtkGetMacro	(	Type	,
		int
	)

Get for Type

Reimplemented in vtkMRMLColorTableNode.

vtkMRMLColorNode::vtkGetStringMacro

(

NoName

)

get/set the string used for an unnamed colour

vtkMRMLColorNode::vtkGetStringMacro

(

FileName

)

vtkMRMLColorNode::vtkSetMacro	(	NamesInitialised	,
		int
	)

vtkMRMLColorNode::vtkSetStringMacro

(

NoName

)

vtkMRMLColorNode::vtkSetStringMacro

(

FileName

)

Name of the file name from which to read color information

vtkMRMLColorNode::vtkTypeMacro	(	vtkMRMLColorNode	,
		vtkMRMLStorableNode
	)

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

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

Reimplemented from vtkMRMLStorableNode.

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

References FileName.

---

Member Data Documentation

char* vtkMRMLColorNode::FileName [protected]

A file name to read text attributes from

Referenced by vtkMRMLFreeSurferProceduralColorNode::Copy(), Copy(), vtkMRMLColorNode(), vtkMRMLProceduralColorNode::vtkMRMLProceduralColorNode(), WriteXML(), and ~vtkMRMLColorNode().

std::vector<std::string> vtkMRMLColorNode::Names [protected]

A vector of names for the color table elements

Referenced by AddColorName(), vtkMRMLColorTableNode::ClearNames(), Copy(), vtkMRMLColorTableNode::GetColorIndexByName(), GetColorName(), vtkMRMLColorTableNode::PrintSelf(), PrintSelf(), vtkMRMLFreeSurferProceduralColorNode::ReadXMLAttributes(), vtkMRMLColorTableNode::ReadXMLAttributes(), SetColorName(), vtkMRMLProceduralColorNode::SetNamesFromColors(), vtkMRMLFreeSurferProceduralColorNode::SetNamesFromColors(), vtkMRMLColorTableNode::SetNamesFromColors(), vtkMRMLColorTableNode::SetNumberOfColors(), and vtkMRMLColorTableNode::SetType().

int vtkMRMLColorNode::NamesInitialised [protected]

Have the colour names been set? Used to do lazy copy of the Names array.

Referenced by Copy(), and vtkMRMLColorNode().

char* vtkMRMLColorNode::NoName [protected]

the string used for an unnamed colour

Referenced by Copy(), GetColorName(), PrintSelf(), vtkMRMLColorNode(), and ~vtkMRMLColorNode().

int vtkMRMLColorNode::Type [protected]

Which type of look up table does this node hold? Valid values are in the enumerated list

Referenced by vtkMRMLFreeSurferProceduralColorNode::Copy(), Copy(), vtkMRMLPETProceduralColorNode::GetTypeAsIDString(), vtkMRMLFreeSurferProceduralColorNode::GetTypeAsIDString(), vtkMRMLdGEMRICProceduralColorNode::GetTypeAsIDString(), vtkMRMLColorTableNode::GetTypeAsIDString(), vtkMRMLPETProceduralColorNode::GetTypeAsString(), vtkMRMLFreeSurferProceduralColorNode::GetTypeAsString(), vtkMRMLdGEMRICProceduralColorNode::GetTypeAsString(), vtkMRMLColorTableNode::GetTypeAsString(), vtkMRMLProceduralColorNode::SetType(), vtkMRMLPETProceduralColorNode::SetType(), vtkMRMLFreeSurferProceduralColorNode::SetType(), vtkMRMLdGEMRICProceduralColorNode::SetType(), vtkMRMLColorTableNode::SetType(), SetType(), and vtkMRMLColorNode().

---

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

• Libs/MRML/vtkMRMLColorNode.h
• Libs/MRML/vtkMRMLColorNode.cxx