vtkSlicerColorLogic Class Reference

#include <vtkSlicerColorLogic.h>

Inheritance diagram for vtkSlicerColorLogic:

List of all members.

Public Member Functions
void	AddColorFile (const char *fileName, std::vector< std::string > *Files)
void	AddDefaultColorNodes ()
void	FindColorFiles ()
const char *	GetDefaultColorTableNodeID (int type)
const char *	GetDefaultdGEMRICColorNodeID (int type)
const char *	GetDefaultEditorColorNodeID ()
char *	GetDefaultFileColorNodeID (const char *fileName)
const char *	GetDefaultFreeSurferColorNodeID (int type)
const char *	GetDefaultFreeSurferLabelMapColorNodeID ()
const char *	GetDefaultLabelMapColorNodeID ()
const char *	GetDefaultModelColorNodeID ()
const char *	GetDefaultPETColorNodeID (int type)
char *	GetDefaultProceduralColorNodeID (const char *name)
const char *	GetDefaultVolumeColorNodeID ()
int	LoadColorFile (const char *fileName, const char *nodeName=NULL)
void	PrintSelf (ostream &os, vtkIndent indent)
void	ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData)
void	RemoveDefaultColorNodes ()
	vtkGetStringMacro (UserColorFilePaths)
	vtkSetStringMacro (UserColorFilePaths)
	vtkTypeRevisionMacro (vtkSlicerColorLogic, vtkObject)
Static Public Member Functions
static vtkSlicerColorLogic *	New ()
	The Usual vtk class functions.
Protected Member Functions
void	operator= (const vtkSlicerColorLogic &)
	vtkSlicerColorLogic (const vtkSlicerColorLogic &)
	vtkSlicerColorLogic ()
	~vtkSlicerColorLogic ()
Protected Attributes
std::vector< std::string >	ColorFiles
char *	UserColorFilePaths
std::vector< std::string >	UserColorFiles

---

Constructor & Destructor Documentation

vtkSlicerColorLogic::vtkSlicerColorLogic

(

)

[protected]

References FindColorFiles(), and UserColorFilePaths.

vtkSlicerColorLogic::~vtkSlicerColorLogic

(

)

[protected]

References ColorFiles, RemoveDefaultColorNodes(), UserColorFilePaths, and UserColorFiles.

vtkSlicerColorLogic::vtkSlicerColorLogic

(

const vtkSlicerColorLogic &

)

[protected]

---

Member Function Documentation

void vtkSlicerColorLogic::AddColorFile	(	const char *	fileName,
		std::vector< std::string > *	Files
	)

Add a file to the input list list, checking first for null, duplicates

Referenced by FindColorFiles().

void vtkSlicerColorLogic::AddDefaultColorNodes

(

)

Add a series of color nodes, setting the types to the defaults, so that they're accessible to the rest of Slicer

References ColorFiles, double(), vtkMRMLColorTableNode::File, FindColorFiles(), GetDefaultColorTableNodeID(), GetDefaultdGEMRICColorNodeID(), GetDefaultFileColorNodeID(), GetDefaultFreeSurferColorNodeID(), GetDefaultFreeSurferLabelMapColorNodeID(), GetDefaultPETColorNodeID(), GetDefaultProceduralColorNodeID(), vtkMRMLdGEMRICProceduralColorNode::GetFirstType(), vtkMRMLPETProceduralColorNode::GetFirstType(), vtkMRMLFreeSurferProceduralColorNode::GetFirstType(), vtkMRMLColorTableNode::GetFirstType(), vtkMRMLdGEMRICProceduralColorNode::GetLastType(), vtkMRMLPETProceduralColorNode::GetLastType(), vtkMRMLFreeSurferProceduralColorNode::GetLastType(), vtkMRMLColorTableNode::GetLastType(), vtkMRMLStorableNode::GetStorageNode(), vtkMRMLdGEMRICProceduralColorNode::GetTypeAsString(), vtkMRMLPETProceduralColorNode::GetTypeAsString(), vtkMRMLFreeSurferProceduralColorNode::GetTypeAsString(), vtkMRMLColorTableNode::GetTypeAsString(), vtkMRMLScene::GetUniqueNameByString(), vtkMRMLColorTableNode::Labels, vtkSlicerLogic::MRMLScene, slicerget::name, New(), vtkMRMLStorageNode::ReadData(), vtkMRMLStorableNode::SetAndObserveStorageNodeID(), vtkMRMLNode::SetAttribute(), vtkMRMLNode::SetScene(), vtkMRMLdGEMRICProceduralColorNode::SetType(), vtkMRMLPETProceduralColorNode::SetType(), vtkMRMLFreeSurferProceduralColorNode::SetType(), vtkMRMLColorTableNode::SetType(), vtkMRMLColorTableNode::SetTypeToFile(), vtkMRMLColorTableNode::SetTypeToLabels(), and UserColorFiles.

Referenced by main(), and Slicer3_main().

void vtkSlicerColorLogic::FindColorFiles

(

)

look for color files in the Base/Logic/Resources/ColorFiles directory and put their names in the ColorFiles list. Look in any user defined color files paths and put them in the UserColorFiles list.

References AddColorFile(), ColorFiles, autoSlicerTracto2regions::d, New(), UserColorFilePaths, and UserColorFiles.

Referenced by AddDefaultColorNodes(), and vtkSlicerColorLogic().

const char * vtkSlicerColorLogic::GetDefaultColorTableNodeID

(

int

type

)

Return the default color table node id for a given type

References vtkMRMLColorTableNode::GetTypeAsIDString(), slicerget::id, New(), and vtkMRMLColorTableNode::SetType().

Referenced by AddDefaultColorNodes(), GetDefaultVolumeColorNodeID(), and RemoveDefaultColorNodes().

const char * vtkSlicerColorLogic::GetDefaultdGEMRICColorNodeID

(

int

type

)

Return the default dGEMRIC color node id for a given type

References vtkMRMLdGEMRICProceduralColorNode::GetTypeAsIDString(), slicerget::id, New(), and vtkMRMLdGEMRICProceduralColorNode::SetType().

Referenced by AddDefaultColorNodes(), and RemoveDefaultColorNodes().

const char * vtkSlicerColorLogic::GetDefaultEditorColorNodeID

(

)

Return a default color node id for the editor

References GetDefaultFileColorNodeID().

char * vtkSlicerColorLogic::GetDefaultFileColorNodeID

(

const char *

fileName

)

return a default color node id for a file based node, based on the file name

References slicerget::id, and slicerget::name.

Referenced by AddDefaultColorNodes(), GetDefaultEditorColorNodeID(), GetDefaultLabelMapColorNodeID(), LoadColorFile(), and RemoveDefaultColorNodes().

const char * vtkSlicerColorLogic::GetDefaultFreeSurferColorNodeID

(

int

type

)

Return the default freesurfer color node id for a given type

References vtkMRMLFreeSurferProceduralColorNode::GetTypeAsIDString(), slicerget::id, New(), and vtkMRMLFreeSurferProceduralColorNode::SetType().

Referenced by AddDefaultColorNodes(), GetDefaultFreeSurferLabelMapColorNodeID(), GetDefaultModelColorNodeID(), and RemoveDefaultColorNodes().

const char * vtkSlicerColorLogic::GetDefaultFreeSurferLabelMapColorNodeID

(

)

Return a default color node id for a freesurfer label map volume

References GetDefaultFreeSurferColorNodeID(), and vtkMRMLFreeSurferProceduralColorNode::Labels.

Referenced by vtkSlicerVolumesLogic::AddArchetypeScalarVolume(), AddDefaultColorNodes(), vtkSlicerVolumesLogic::AddHeaderVolume(), and RemoveDefaultColorNodes().

const char * vtkSlicerColorLogic::GetDefaultLabelMapColorNodeID

(

)

Return a default color node id for a label map

References GetDefaultFileColorNodeID().

Referenced by vtkSlicerVolumesLogic::AddArchetypeScalarVolume(), vtkSlicerVolumesLogic::AddHeaderVolume(), vtkEMSegmentMRMLManager::GetColorNodeID(), vtkSlicerVectorVolumeDisplayWidget::ProcessWidgetEvents(), and vtkSlicerScalarVolumeDisplayWidget::ProcessWidgetEvents().

const char * vtkSlicerColorLogic::GetDefaultModelColorNodeID

(

)

Return a default color node id for a model

References GetDefaultFreeSurferColorNodeID(), and vtkMRMLFreeSurferProceduralColorNode::Heat.

Referenced by vtkSlicerModelsLogic::AddScalar().

const char * vtkSlicerColorLogic::GetDefaultPETColorNodeID

(

int

type

)

Return the default PET color node id for a given type

References vtkMRMLPETProceduralColorNode::GetTypeAsIDString(), slicerget::id, New(), and vtkMRMLPETProceduralColorNode::SetType().

Referenced by AddDefaultColorNodes(), and RemoveDefaultColorNodes().

char * vtkSlicerColorLogic::GetDefaultProceduralColorNodeID

(

const char *

name

)

return a default color node id for a procedural color node

References slicerget::id.

Referenced by AddDefaultColorNodes(), and RemoveDefaultColorNodes().

const char * vtkSlicerColorLogic::GetDefaultVolumeColorNodeID

(

)

Return a default color node id for a volume

References GetDefaultColorTableNodeID(), and vtkMRMLColorTableNode::Grey.

Referenced by vtkSlicerVolumesLogic::AddArchetypeScalarVolume(), vtkFourDImageLogic::AddDisplayBufferNode(), vtkSlicerVolumesLogic::AddHeaderVolume(), vtkPharmacokineticsLogic::AddMapVolumeNode(), vtkIGTLToMRMLImage::CreateNewNode(), vtkFourDImageLogic::GenerateBundleFrames(), vtkFourDImageLogic::LoadImagesByList(), vtkSlicerApplicationLogic::ProcessReadNodeData(), vtkSlicerVectorVolumeDisplayWidget::ProcessWidgetEvents(), vtkSlicerScalarVolumeDisplayWidget::ProcessWidgetEvents(), vtkSlicerDiffusionWeightedVolumeDisplayWidget::ProcessWidgetEvents(), vtkSlicerDiffusionTensorVolumeDisplayWidget::ProcessWidgetEvents(), and vtkFourDImageLogic::UpdateDisplayBufferNode().

int vtkSlicerColorLogic::LoadColorFile	(	const char *	fileName,
		const char *	nodeName = NULL
	)

load in a color file, creating a storage node. Returns 1 on success. Returns -1 if there's a file name clash, 0 on general loading failure.

References GetDefaultFileColorNodeID(), vtkMRMLScene::GetUniqueNameByString(), slicerget::id, vtkSlicerLogic::MRMLScene, slicerget::name, and New().

Referenced by vtkSlicerDataGUI::ProcessGUIEvents().

static vtkSlicerColorLogic* vtkSlicerColorLogic::New

(

)

[static]

The Usual vtk class functions.

Reimplemented from vtkSlicerLogic.

Referenced by AddDefaultColorNodes(), FindColorFiles(), GetDefaultColorTableNodeID(), GetDefaultdGEMRICColorNodeID(), GetDefaultFreeSurferColorNodeID(), GetDefaultPETColorNodeID(), LoadColorFile(), main(), RemoveDefaultColorNodes(), and Slicer3_main().

void vtkSlicerColorLogic::operator=

(

const vtkSlicerColorLogic &

)

[protected]

Reimplemented from vtkSlicerLogic.

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

Reimplemented from vtkSlicerLogic.

References ColorFiles, and UserColorFiles.

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

Update logic state when MRML scene chenges

Reimplemented from vtkSlicerLogic.

void vtkSlicerColorLogic::RemoveDefaultColorNodes

(

)

Remove the colour nodes that were added

References ColorFiles, vtkMRMLColorTableNode::File, GetDefaultColorTableNodeID(), GetDefaultdGEMRICColorNodeID(), GetDefaultFileColorNodeID(), GetDefaultFreeSurferColorNodeID(), GetDefaultFreeSurferLabelMapColorNodeID(), GetDefaultPETColorNodeID(), GetDefaultProceduralColorNodeID(), vtkMRMLdGEMRICProceduralColorNode::GetFirstType(), vtkMRMLPETProceduralColorNode::GetFirstType(), vtkMRMLFreeSurferProceduralColorNode::GetFirstType(), vtkMRMLColorTableNode::GetFirstType(), vtkMRMLdGEMRICProceduralColorNode::GetLastType(), vtkMRMLPETProceduralColorNode::GetLastType(), vtkMRMLFreeSurferProceduralColorNode::GetLastType(), vtkMRMLColorTableNode::GetLastType(), New(), vtkMRMLdGEMRICProceduralColorNode::SetType(), vtkMRMLPETProceduralColorNode::SetType(), vtkMRMLFreeSurferProceduralColorNode::SetType(), vtkMRMLColorTableNode::SetType(), and UserColorFiles.

Referenced by ~vtkSlicerColorLogic().

vtkSlicerColorLogic::vtkGetStringMacro

(

UserColorFilePaths

)

Get/Set the user defined paths where to look for extra colour files

vtkSlicerColorLogic::vtkSetStringMacro

(

UserColorFilePaths

)

vtkSlicerColorLogic::vtkTypeRevisionMacro	(	vtkSlicerColorLogic	,
		vtkObject
	)

Reimplemented from vtkSlicerLogic.

---

Member Data Documentation

std::vector<std::string> vtkSlicerColorLogic::ColorFiles [protected]

a vector holding discovered default colour files, found in the Resources/ColorFiles directory, white space separated with: int name r g b a with rgba in the range 0-255

Referenced by AddDefaultColorNodes(), FindColorFiles(), PrintSelf(), RemoveDefaultColorNodes(), and ~vtkSlicerColorLogic().

char* vtkSlicerColorLogic::UserColorFilePaths [protected]

a string holding delimiter separated (; on win32, : else) paths where to look for extra colour files, set from the return value of vtkSlicerApplication::GetColorFilePaths

Referenced by FindColorFiles(), vtkSlicerColorLogic(), and ~vtkSlicerColorLogic().

std::vector<std::string> vtkSlicerColorLogic::UserColorFiles [protected]

a vector holding discovered user defined colour files, found in the UserColorFilesPath directories.

Referenced by AddDefaultColorNodes(), FindColorFiles(), PrintSelf(), RemoveDefaultColorNodes(), and ~vtkSlicerColorLogic().

---

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

• Base/Logic/vtkSlicerColorLogic.h
• Base/Logic/vtkSlicerColorLogic.cxx