Slicer  4.11
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkFSSurfaceLabelReader Class Reference

Read a label surface overlay file (*.label) from Freesurfer tools. More...

#include <Libs/FreeSurfer/vtkFSSurfaceLabelReader.h>

Inheritance diagram for vtkFSSurfaceLabelReader:
Inheritance graph
[legend]
Collaboration diagram for vtkFSSurfaceLabelReader:
Collaboration graph
[legend]

Public Types

enum  {
  FS_ERROR_W_NONE = 0, FS_ERROR_W_OUTPUT_NULL = 1, FS_ERROR_W_NO_FILENAME = 2, FS_ERROR_W_OPEN = 3,
  FS_ERROR_W_NUM_VALUES = 4, FS_ERROR_W_ALLOC = 5, FS_ERROR_W_EOF = 6, FS_NEW_SCALAR_MAGIC_NUMBER = 16777215
}
 
typedef vtkDataReader Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual float GetLabelOff ()
 
virtual float GetLabelOn ()
 
virtual int GetNumberOfValues ()
 
virtual int GetNumberOfVertices ()
 
Number of vertices on the surface More...
 
vtkFloatArray * GetOutput ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
int ReadLabel ()
 
virtual void SetLabelOff (float)
 
virtual void SetLabelOn (float)
 
virtual void SetNumberOfVertices (int)
 
void SetOutput (vtkFloatArray *output)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkFSSurfaceLabelReaderNew ()
 
static vtkFSSurfaceLabelReaderSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkFSSurfaceLabelReader ()
 
 ~vtkFSSurfaceLabelReader () override
 

Protected Attributes

float LabelOff
 
float LabelOn
 
int NumberOfValues
 
number of values read from file More...
 
int NumberOfVertices
 
vtkFloatArray * Scalars
 

Detailed Description

Read a label surface overlay file (*.label) from Freesurfer tools.

Reads a surface overlay file file from FreeSurfer and outputs a vtkFloatArray. 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, but not all elements may be found in the label file.

Definition at line 29 of file vtkFSSurfaceLabelReader.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataReader vtkFSSurfaceLabelReader::Superclass

Definition at line 33 of file vtkFSSurfaceLabelReader.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
FS_ERROR_W_NONE 

error codes

FS_ERROR_W_OUTPUT_NULL 
FS_ERROR_W_NO_FILENAME 
FS_ERROR_W_OPEN 
FS_ERROR_W_NUM_VALUES 
FS_ERROR_W_ALLOC 
FS_ERROR_W_EOF 
FS_NEW_SCALAR_MAGIC_NUMBER 

file type magic numbers

Definition at line 65 of file vtkFSSurfaceLabelReader.h.

Constructor & Destructor Documentation

◆ vtkFSSurfaceLabelReader()

vtkFSSurfaceLabelReader::vtkFSSurfaceLabelReader ( )
protected

◆ ~vtkFSSurfaceLabelReader()

vtkFSSurfaceLabelReader::~vtkFSSurfaceLabelReader ( )
overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkFSSurfaceLabelReader::GetClassName ( )
virtual

◆ GetLabelOff()

virtual float vtkFSSurfaceLabelReader::GetLabelOff ( )
virtual

Scalar value to use in the array at points that don't appear in the file. defaults to 0.0

◆ GetLabelOn()

virtual float vtkFSSurfaceLabelReader::GetLabelOn ( )
virtual

Scalar value to use in the array at points in the file Defaults to 1.0

◆ GetNumberOfValues()

virtual int vtkFSSurfaceLabelReader::GetNumberOfValues ( )
virtual

Number of values read from file, may not be the same as number of vertices

◆ GetNumberOfVertices()

virtual int vtkFSSurfaceLabelReader::GetNumberOfVertices ( )
virtual


Number of vertices on the surface

◆ GetOutput()

vtkFloatArray* vtkFSSurfaceLabelReader::GetOutput ( )
inline

Definition at line 36 of file vtkFSSurfaceLabelReader.h.

◆ IsA()

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

◆ IsTypeOf()

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

◆ New()

static vtkFSSurfaceLabelReader* vtkFSSurfaceLabelReader::New ( )
static

◆ PrintSelf()

void vtkFSSurfaceLabelReader::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
override

◆ ReadLabel()

int vtkFSSurfaceLabelReader::ReadLabel ( )

◆ SafeDownCast()

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

◆ SetLabelOff()

virtual void vtkFSSurfaceLabelReader::SetLabelOff ( float  )
virtual

◆ SetLabelOn()

virtual void vtkFSSurfaceLabelReader::SetLabelOn ( float  )
virtual

◆ SetNumberOfVertices()

virtual void vtkFSSurfaceLabelReader::SetNumberOfVertices ( int  )
virtual

◆ SetOutput()

void vtkFSSurfaceLabelReader::SetOutput ( vtkFloatArray *  output)
inline

Definition at line 38 of file vtkFSSurfaceLabelReader.h.

Member Data Documentation

◆ LabelOff

float vtkFSSurfaceLabelReader::LabelOff
protected

Definition at line 95 of file vtkFSSurfaceLabelReader.h.

◆ LabelOn

float vtkFSSurfaceLabelReader::LabelOn
protected

Definition at line 96 of file vtkFSSurfaceLabelReader.h.

◆ NumberOfValues

int vtkFSSurfaceLabelReader::NumberOfValues
protected


number of values read from file

Definition at line 93 of file vtkFSSurfaceLabelReader.h.

◆ NumberOfVertices

int vtkFSSurfaceLabelReader::NumberOfVertices
protected

this is the number of vertices in the associated model file, there may not be as many value in this scalar file as there are vertices

Definition at line 90 of file vtkFSSurfaceLabelReader.h.

◆ Scalars

vtkFloatArray* vtkFSSurfaceLabelReader::Scalars
protected

Definition at line 83 of file vtkFSSurfaceLabelReader.h.


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