VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkMNIObjectReader Class Reference

A reader for MNI surface mesh files. More...

#include <vtkMNIObjectReader.h>

Inheritance diagram for vtkMNIObjectReader:
[legend]
Collaboration diagram for vtkMNIObjectReader:
[legend]

Public Types

typedef vtkPolyDataAlgorithm Superclass
- Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm Superclass
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
virtual int CanReadFile (const char *name)
virtual vtkPropertyGetProperty ()
virtual void SetFileName (const char *)
virtual char * GetFileName ()
virtual const char * GetFileExtensions ()
virtual const char * GetDescriptiveName ()
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkDataObjectGetInput ()
vtkDataObjectGetInput (int port)
vtkPolyDataGetPolyDataInput (int port)
vtkPolyDataGetOutput ()
vtkPolyDataGetOutput (int)
virtual void SetOutput (vtkDataObject *d)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
void AddInput (vtkDataObject *)
void AddInput (int, vtkDataObject *)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObjectGetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkMNIObjectReaderSafeDownCast (vtkObject *o)
static vtkMNIObjectReaderNew ()

Protected Member Functions

 vtkMNIObjectReader ()
 ~vtkMNIObjectReader ()
int ReadLine (char *text, unsigned int length)
int SkipWhitespace ()
int ParseValues (vtkDataArray *array, vtkIdType n)
int ParseIdValue (vtkIdType *value)
int ReadNumberOfPoints (vtkIdType *numCells)
int ReadNumberOfCells (vtkIdType *numCells)
int ReadProperty (vtkProperty *property)
int ReadLineThickness (vtkProperty *property)
int ReadPoints (vtkPolyData *polyData, vtkIdType numPoints)
int ReadNormals (vtkPolyData *polyData, vtkIdType numPoints)
int ReadColors (vtkProperty *property, vtkPolyData *data, vtkIdType numPoints, vtkIdType numCells)
int ReadCells (vtkPolyData *data, vtkIdType numCells, int cellType)
int ReadPolygonObject (vtkPolyData *output)
int ReadLineObject (vtkPolyData *output)
virtual int ReadFile (vtkPolyData *output)
virtual int RequestData (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 ~vtkPolyDataAlgorithm ()
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual int FillInputPortInformation (int port, vtkInformation *info)
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void ExecuteData (vtkDataObject *output)
virtual void Execute ()
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

char * FileName
vtkPropertyProperty
int FileType
istream * InputStream
int LineNumber
char * LineText
char * CharPointer

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
- Friends inherited from vtkObject

Detailed Description

A reader for MNI surface mesh files.

The MNI .obj file format is used to store geometrical data. This file format was developed at the McConnell Brain Imaging Centre at the Montreal Neurological Institute and is used by their software. Only polygon and line files are supported by this reader, but for those formats, all data elements are read including normals, colors, and surface properties. ASCII and binary file types are supported.

See Also
vtkMINCImageReader vtkMNIObjectWriter vtkMNITransformReader
Thanks:
Thanks to David Gobbi for writing this class and Atamai Inc. for contributing it to VTK.
Tests:
vtkMNIObjectReader (Tests)

Definition at line 79 of file vtkMNIObjectReader.h.

Member Typedef Documentation

Definition at line 82 of file vtkMNIObjectReader.h.

Constructor & Destructor Documentation

vtkMNIObjectReader::vtkMNIObjectReader ( )
protected
vtkMNIObjectReader::~vtkMNIObjectReader ( )
protected

Member Function Documentation

virtual const char* vtkMNIObjectReader::GetClassName ( )
virtual

Reimplemented from vtkPolyDataAlgorithm.

static int vtkMNIObjectReader::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 vtkMNIObjectReader::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.

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

Reimplemented from vtkPolyDataAlgorithm.

static vtkMNIObjectReader* vtkMNIObjectReader::New ( )
static

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

Reimplemented from vtkPolyDataAlgorithm.

virtual void vtkMNIObjectReader::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 vtkMNIObjectReader::SetFileName ( const char *  )
virtual

Set the file name.

virtual char* vtkMNIObjectReader::GetFileName ( )
virtual

Set the file name.

virtual const char* vtkMNIObjectReader::GetFileExtensions ( )
inlinevirtual

Get the entension for this file format.

Definition at line 95 of file vtkMNIObjectReader.h.

virtual const char* vtkMNIObjectReader::GetDescriptiveName ( )
inlinevirtual

Get the name of this file format.

Definition at line 101 of file vtkMNIObjectReader.h.

virtual int vtkMNIObjectReader::CanReadFile ( const char *  name)
virtual

Test whether the specified file can be read.

virtual vtkProperty* vtkMNIObjectReader::GetProperty ( )
inlinevirtual

Get the property associated with the object.

Definition at line 109 of file vtkMNIObjectReader.h.

int vtkMNIObjectReader::ReadLine ( char *  text,
unsigned int  length 
)
protected
int vtkMNIObjectReader::SkipWhitespace ( )
protected
int vtkMNIObjectReader::ParseValues ( vtkDataArray array,
vtkIdType  n 
)
protected
int vtkMNIObjectReader::ParseIdValue ( vtkIdType value)
protected
int vtkMNIObjectReader::ReadNumberOfPoints ( vtkIdType numCells)
protected
int vtkMNIObjectReader::ReadNumberOfCells ( vtkIdType numCells)
protected
int vtkMNIObjectReader::ReadProperty ( vtkProperty property)
protected
int vtkMNIObjectReader::ReadLineThickness ( vtkProperty property)
protected
int vtkMNIObjectReader::ReadPoints ( vtkPolyData polyData,
vtkIdType  numPoints 
)
protected
int vtkMNIObjectReader::ReadNormals ( vtkPolyData polyData,
vtkIdType  numPoints 
)
protected
int vtkMNIObjectReader::ReadColors ( vtkProperty property,
vtkPolyData data,
vtkIdType  numPoints,
vtkIdType  numCells 
)
protected
int vtkMNIObjectReader::ReadCells ( vtkPolyData data,
vtkIdType  numCells,
int  cellType 
)
protected
int vtkMNIObjectReader::ReadPolygonObject ( vtkPolyData output)
protected
int vtkMNIObjectReader::ReadLineObject ( vtkPolyData output)
protected
virtual int vtkMNIObjectReader::ReadFile ( vtkPolyData output)
protectedvirtual
virtual int vtkMNIObjectReader::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

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

Reimplemented from vtkPolyDataAlgorithm.

Member Data Documentation

char* vtkMNIObjectReader::FileName
protected

Definition at line 115 of file vtkMNIObjectReader.h.

vtkProperty* vtkMNIObjectReader::Property
protected

Definition at line 116 of file vtkMNIObjectReader.h.

int vtkMNIObjectReader::FileType
protected

Definition at line 117 of file vtkMNIObjectReader.h.

istream* vtkMNIObjectReader::InputStream
protected

Definition at line 119 of file vtkMNIObjectReader.h.

int vtkMNIObjectReader::LineNumber
protected

Definition at line 120 of file vtkMNIObjectReader.h.

char* vtkMNIObjectReader::LineText
protected

Definition at line 121 of file vtkMNIObjectReader.h.

char* vtkMNIObjectReader::CharPointer
protected

Definition at line 122 of file vtkMNIObjectReader.h.


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