vtkFSSurfaceAnnotationReader Class Reference

Read a surface annotation and color table file from Freesurfer tools. More...

#include <Libs/FreeSurfer/vtkFSSurfaceAnnotationReader.h>

Inheritance diagram for vtkFSSurfaceAnnotationReader:

Collaboration diagram for vtkFSSurfaceAnnotationReader:

Public Types
enum	{   FS_COLOR_TABLE_TAG = 1, FS_COLOR_TABLE_NAME_LENGTH = 1024, FS_COLOR_TABLE_ENTRY_NAME_LENGTH = 1024, FS_ERROR_LOADING_COLOR_TABLE = 1,   FS_ERROR_LOADING_ANNOTATION = 2, FS_ERROR_PARSING_COLOR_TABLE = 3, FS_ERROR_PARSING_ANNOTATION = 4, FS_WARNING_UNASSIGNED_LABELS = 5,   FS_NO_COLOR_TABLE = 6 }
	previously defined as constants More...
typedef vtkDataReader	Superclass

Public Member Functions
virtual const char *	GetClassName ()
char *	GetColorTableNames ()
vtkLookupTable *	GetColorTableOutput ()
virtual int	GetNumColorTableEntries ()
vtkIntArray *	GetOutput ()
virtual int	GetUseExternalColorTableFile ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
int	ReadFSAnnotation ()
virtual void	SetColorTableFileName (const char *)
void	SetColorTableOutput (vtkLookupTable *colors)
void	SetOutput (vtkIntArray *output)
virtual void	SetUseExternalColorTableFile (int)
virtual void	UseExternalColorTableFileOff ()
virtual void	UseExternalColorTableFileOn ()
int	WriteFSAnnotation ()
	write out the annotation file, using an internal color table More...

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkFSSurfaceAnnotationReader *	New ()
static vtkFSSurfaceAnnotationReader *	SafeDownCast (vtkObject *o)

Protected Member Functions
int	ReadEmbeddedColorTable (FILE *annotFile, int *numEntries, int ***rgbValues, char ***names)
int	ReadExternalColorTable (char *fileName, int *numEntries, int ***rgbValues, char ***names)
	vtkFSSurfaceAnnotationReader ()
	~vtkFSSurfaceAnnotationReader ()

Protected Attributes
vtkLookupTable *	Colors
char *	ColorTableFileName
vtkIntArray *	Labels
char *	NamesList
int	NumColorTableEntries
int	UseExternalColorTableFile

Detailed Description

Read a surface annotation and color table file from Freesurfer tools.

Reads a surface annotation file from FreeSurfer and outputs a vtkIntArray and has an access function to get the vtkLookupTable with the color values. Use the SetFileName function to specify the file name. The number of values in the array should be equal to the number of vertices/points in the surface.

Definition at line 32 of file vtkFSSurfaceAnnotationReader.h.

Member Typedef Documentation

Superclass

typedef vtkDataReader vtkFSSurfaceAnnotationReader::Superclass

Definition at line 36 of file vtkFSSurfaceAnnotationReader.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

previously defined as constants

Enumerator
FS_COLOR_TABLE_TAG	tag
FS_COLOR_TABLE_NAME_LENGTH
FS_COLOR_TABLE_ENTRY_NAME_LENGTH
FS_ERROR_LOADING_COLOR_TABLE
FS_ERROR_LOADING_ANNOTATION
FS_ERROR_PARSING_COLOR_TABLE
FS_ERROR_PARSING_ANNOTATION
FS_WARNING_UNASSIGNED_LABELS
FS_NO_COLOR_TABLE

Definition at line 61 of file vtkFSSurfaceAnnotationReader.h.

Constructor & Destructor Documentation

vtkFSSurfaceAnnotationReader()

vtkFSSurfaceAnnotationReader::vtkFSSurfaceAnnotationReader ( )

protected

~vtkFSSurfaceAnnotationReader()

vtkFSSurfaceAnnotationReader::~vtkFSSurfaceAnnotationReader ( )

protected

Member Function Documentation

GetClassName()

virtual const char* vtkFSSurfaceAnnotationReader::GetClassName ( )

virtual

GetColorTableNames()

char* vtkFSSurfaceAnnotationReader::GetColorTableNames

(

)

GetColorTableOutput()

vtkLookupTable* vtkFSSurfaceAnnotationReader::GetColorTableOutput

(

)

GetNumColorTableEntries()

virtual int vtkFSSurfaceAnnotationReader::GetNumColorTableEntries ( )

virtual

GetOutput()

vtkIntArray* vtkFSSurfaceAnnotationReader::GetOutput

(

)

GetUseExternalColorTableFile()

virtual int vtkFSSurfaceAnnotationReader::GetUseExternalColorTableFile ( )

virtual

IsA()

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

virtual

IsTypeOf()

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

static

New()

static vtkFSSurfaceAnnotationReader* vtkFSSurfaceAnnotationReader::New ( )

static

PrintSelf()

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

ReadEmbeddedColorTable()

int vtkFSSurfaceAnnotationReader::ReadEmbeddedColorTable ( FILE *  annotFile, int *  numEntries, int ***  rgbValues, char ***  names  )

protected

Read color table information from a source, allocate the arrays to hold rgb and name values, and return pointers to the arrays. The caller is responsible for disposing of the memory.

ReadExternalColorTable()

int vtkFSSurfaceAnnotationReader::ReadExternalColorTable ( char *  fileName, int *  numEntries, int ***  rgbValues, char ***  names  )

protected

ReadFSAnnotation()

int vtkFSSurfaceAnnotationReader::ReadFSAnnotation

(

)

SafeDownCast()

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

static

SetColorTableFileName()

virtual void vtkFSSurfaceAnnotationReader::SetColorTableFileName ( const char *  )

virtual

SetColorTableOutput()

void vtkFSSurfaceAnnotationReader::SetColorTableOutput

(

vtkLookupTable *

colors

)

SetOutput()

void vtkFSSurfaceAnnotationReader::SetOutput

(

vtkIntArray *

output

)

SetUseExternalColorTableFile()

virtual void vtkFSSurfaceAnnotationReader::SetUseExternalColorTableFile ( int  )

virtual

UseExternalColorTableFileOff()

virtual void vtkFSSurfaceAnnotationReader::UseExternalColorTableFileOff ( )

virtual

UseExternalColorTableFileOn()

virtual void vtkFSSurfaceAnnotationReader::UseExternalColorTableFileOn ( )

virtual

WriteFSAnnotation()

int vtkFSSurfaceAnnotationReader::WriteFSAnnotation

(

)

write out the annotation file, using an internal color table

Member Data Documentation

Colors

vtkLookupTable* vtkFSSurfaceAnnotationReader::Colors

protected

Definition at line 81 of file vtkFSSurfaceAnnotationReader.h.

ColorTableFileName

char* vtkFSSurfaceAnnotationReader::ColorTableFileName

protected

Definition at line 86 of file vtkFSSurfaceAnnotationReader.h.

Labels

vtkIntArray* vtkFSSurfaceAnnotationReader::Labels

protected

Definition at line 80 of file vtkFSSurfaceAnnotationReader.h.

NamesList

char* vtkFSSurfaceAnnotationReader::NamesList

protected

Definition at line 82 of file vtkFSSurfaceAnnotationReader.h.

NumColorTableEntries

int vtkFSSurfaceAnnotationReader::NumColorTableEntries

protected

Definition at line 83 of file vtkFSSurfaceAnnotationReader.h.

UseExternalColorTableFile

int vtkFSSurfaceAnnotationReader::UseExternalColorTableFile

protected

Definition at line 85 of file vtkFSSurfaceAnnotationReader.h.

---

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

• Libs/FreeSurfer/vtkFSSurfaceAnnotationReader.h