VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkMNITagPointReader Class Reference

A reader for MNI tag files. More...

#include <vtkMNITagPointReader.h>

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

List of all members.

Public Types

typedef vtkPolyDataAlgorithm Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkMNITagPointReaderNewInstance () const
virtual void PrintSelf (ostream &os, vtkIndent indent)
virtual int CanReadFile (const char *name)
virtual int GetNumberOfVolumes ()
virtual vtkStringArrayGetLabelText ()
virtual vtkDoubleArrayGetWeights ()
virtual vtkIntArrayGetStructureIds ()
virtual vtkIntArrayGetPatientIds ()
virtual const char * GetComments ()
virtual void SetFileName (const char *)
virtual char * GetFileName ()
virtual const char * GetFileExtensions ()
virtual const char * GetDescriptiveName ()
virtual vtkPointsGetPoints (int port)
virtual vtkPointsGetPoints ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkMNITagPointReaderSafeDownCast (vtkObjectBase *o)
static vtkMNITagPointReaderNew ()

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkMNITagPointReader ()
 ~vtkMNITagPointReader ()
int ReadLine (istream &infile, std::string &linetext, std::string::iterator &pos)
int ReadLineAfterComments (istream &infile, std::string &linetext, std::string::iterator &pos)
int SkipWhitespace (istream &infile, std::string &linetext, std::string::iterator &pos, int nl)
int ParseLeftHandSide (istream &infile, std::string &linetext, std::string::iterator &pos, std::string &identifier)
int ParseStringValue (istream &infile, std::string &linetext, std::string::iterator &pos, std::string &data)
int ParseIntValues (istream &infile, std::string &linetext, std::string::iterator &pos, int *values, int count)
int ParseFloatValues (istream &infile, std::string &linetext, std::string::iterator &pos, double *values, int count)
virtual int ReadFile (vtkPolyData *output1, vtkPolyData *output2)
virtual int RequestData (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)

Protected Attributes

char * FileName
int NumberOfVolumes
int LineNumber
char * Comments

Detailed Description

A reader for MNI tag files.

The MNI .tag file format is used to store labeled points, it can store either one or two point sets. All point sets must have the same number of points and they will share the same labels. This file format was developed at the McConnell Brain Imaging Centre at the Montreal Neurological Institute and is used by their software. The labels are stored as a vtkStringArray in the PointData of the output dataset, which is a vtkPolyData.

See also:
vtkMINCImageReader vtkMNIObjectReader vtkMNITransformReader
Thanks:
Thanks to David Gobbi for contributing this class.
Tests:
vtkMNITagPointReader (Tests)

Definition at line 80 of file vtkMNITagPointReader.h.


Member Typedef Documentation

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 83 of file vtkMNITagPointReader.h.


Constructor & Destructor Documentation


Member Function Documentation

static int vtkMNITagPointReader::IsTypeOf ( const char *  name) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

virtual int vtkMNITagPointReader::IsA ( const char *  name) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented from vtkPolyDataAlgorithm.

virtual vtkObjectBase* vtkMNITagPointReader::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented from vtkPolyDataAlgorithm.

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkPolyDataAlgorithm.

virtual void vtkMNITagPointReader::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkPolyDataAlgorithm.

virtual void vtkMNITagPointReader::SetFileName ( const char *  ) [virtual]

Set the file name.

virtual char* vtkMNITagPointReader::GetFileName ( ) [virtual]

Set the file name.

virtual const char* vtkMNITagPointReader::GetFileExtensions ( ) [inline, virtual]

Get the entension for this file format.

Definition at line 96 of file vtkMNITagPointReader.h.

virtual const char* vtkMNITagPointReader::GetDescriptiveName ( ) [inline, virtual]

Get the name of this file format.

Definition at line 102 of file vtkMNITagPointReader.h.

virtual int vtkMNITagPointReader::CanReadFile ( const char *  name) [virtual]

Test whether the specified file can be read.

Get the number of volumes specified by the file, which will be equal to one or two. There will be an output point set for each volume, so really, this parameter just tells you the number of outputs to expect from this reader.

virtual vtkPoints* vtkMNITagPointReader::GetPoints ( int  port) [virtual]

Get the points. These are also provided in the first and second output ports of the reader. This method will return NULL if there is no data.

virtual vtkPoints* vtkMNITagPointReader::GetPoints ( ) [inline, virtual]

Get the points. These are also provided in the first and second output ports of the reader. This method will return NULL if there is no data.

Definition at line 120 of file vtkMNITagPointReader.h.

Get the labels. These same labels are provided in the output point sets, as the PointData data array named "LabelText". This will return NULL if there were no labels in the file.

Get the weights. These are also provided in the output point sets, as the PointData data array named "Weights". This will return NULL if there were no weights in the file.

Get the structure ids. These are also provided in the output point sets, as the PointData data array named "StructureIds". This will return NULL if there were no ids in the file.

Get the patient ids. These are also provided in the output point sets, as the PointData data array named "PatientIds". This will return NULL if there were no ids in the file.

virtual const char* vtkMNITagPointReader::GetComments ( ) [virtual]

Get any comments that are included in the file.

int vtkMNITagPointReader::ReadLine ( istream &  infile,
std::string &  linetext,
std::string::iterator &  pos 
) [protected]
int vtkMNITagPointReader::ReadLineAfterComments ( istream &  infile,
std::string &  linetext,
std::string::iterator &  pos 
) [protected]
int vtkMNITagPointReader::SkipWhitespace ( istream &  infile,
std::string &  linetext,
std::string::iterator &  pos,
int  nl 
) [protected]
int vtkMNITagPointReader::ParseLeftHandSide ( istream &  infile,
std::string &  linetext,
std::string::iterator &  pos,
std::string &  identifier 
) [protected]
int vtkMNITagPointReader::ParseStringValue ( istream &  infile,
std::string &  linetext,
std::string::iterator &  pos,
std::string &  data 
) [protected]
int vtkMNITagPointReader::ParseIntValues ( istream &  infile,
std::string &  linetext,
std::string::iterator &  pos,
int values,
int  count 
) [protected]
int vtkMNITagPointReader::ParseFloatValues ( istream &  infile,
std::string &  linetext,
std::string::iterator &  pos,
double values,
int  count 
) [protected]
virtual int vtkMNITagPointReader::ReadFile ( vtkPolyData output1,
vtkPolyData output2 
) [protected, virtual]
virtual int vtkMNITagPointReader::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

This is called by the superclass. This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.


Member Data Documentation

char* vtkMNITagPointReader::FileName [protected]

Definition at line 150 of file vtkMNITagPointReader.h.

Definition at line 151 of file vtkMNITagPointReader.h.

Definition at line 153 of file vtkMNITagPointReader.h.

char* vtkMNITagPointReader::Comments [protected]

Definition at line 154 of file vtkMNITagPointReader.h.


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