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

A reader for MNI tag files. More...

#include <vtkMNITagPointReader.h>

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

Public Types

typedef vtkPolyDataAlgorithm Superclass
 
- Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 
- Public Types inherited from vtkObject
typedef vtkObjectBase 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 ()
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithmNewInstance () const
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
vtkPolyDataGetOutput ()
 
vtkPolyDataGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
void SetInputData (vtkDataObject *)
 
void SetInputData (int, vtkDataObject *)
 
void AddInputData (vtkDataObject *)
 
void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
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)
 
virtual void RemoveInputConnection (int port, int idx)
 
virtual void RemoveAllInputConnections (int port)
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 
vtkExecutiveGetInputExecutive (int port, int index)
 
vtkInformationGetInputInformation (int port, int index)
 
vtkInformationGetOutputInformation (int port)
 
virtual void UpdateInformation ()
 
virtual void UpdateDataObject ()
 
virtual void PropagateUpdateExtent ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
int SetUpdateExtentToWholeExtent (int port)
 
int SetUpdateExtentToWholeExtent ()
 
void SetUpdateExtent (int port, int extent[6])
 
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)
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
vtkInformationGetInputInformation ()
 
virtual void Update (int port)
 
virtual void Update ()
 
virtual void SetReleaseDataFlag (int)
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
void SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int extent[6])
 
intGetUpdateExtent ()
 
intGetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 
virtual vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool 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)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(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 &)
 
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 vtkMNITagPointReaderSafeDownCast (vtkObjectBase *o)
 
static vtkMNITagPointReaderNew ()
 
- Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

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 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 *)
 
- 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)
 
void SetInputDataInternal (int port, vtkDataObject *input)
 
void AddInputDataInternal (int port, vtkDataObject *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 &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

char * FileName
 
int NumberOfVolumes
 
int LineNumber
 
char * Comments
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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
 

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

Definition at line 83 of file vtkMNITagPointReader.h.

Constructor & Destructor Documentation

vtkMNITagPointReader::vtkMNITagPointReader ( )
protected
vtkMNITagPointReader::~vtkMNITagPointReader ( )
protected

Member Function Documentation

static int vtkMNITagPointReader::IsTypeOf ( const char *  type)
static
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.

static vtkMNITagPointReader* vtkMNITagPointReader::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkMNITagPointReader::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

vtkMNITagPointReader* vtkMNITagPointReader::NewInstance ( ) const
static vtkMNITagPointReader* vtkMNITagPointReader::New ( )
static
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 ( )
inlinevirtual

Get the entension for this file format.

Definition at line 96 of file vtkMNITagPointReader.h.

virtual const char* vtkMNITagPointReader::GetDescriptiveName ( )
inlinevirtual

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.

virtual int vtkMNITagPointReader::GetNumberOfVolumes ( )
virtual

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 ( )
inlinevirtual

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.

virtual vtkStringArray* vtkMNITagPointReader::GetLabelText ( )
virtual

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.

virtual vtkDoubleArray* vtkMNITagPointReader::GetWeights ( )
virtual

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.

virtual vtkIntArray* vtkMNITagPointReader::GetStructureIds ( )
virtual

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.

virtual vtkIntArray* vtkMNITagPointReader::GetPatientIds ( )
virtual

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 
)
protectedvirtual
virtual int vtkMNITagPointReader::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* vtkMNITagPointReader::FileName
protected

Definition at line 150 of file vtkMNITagPointReader.h.

int vtkMNITagPointReader::NumberOfVolumes
protected

Definition at line 151 of file vtkMNITagPointReader.h.

int vtkMNITagPointReader::LineNumber
protected

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: