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

A writer for MNI tag point files. More...

#include <vtkMNITagPointWriter.h>

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

List of all members.

Public Types

typedef vtkDataSetWriter Superclass
- Public Types inherited from vtkDataSetWriter
- Public Types inherited from vtkDataWriter
- Public Types inherited from vtkWriter
- Public Types inherited from vtkAlgorithm
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
virtual int Write ()
virtual unsigned long GetMTime ()
virtual const char * GetFileExtensions ()
virtual const char * GetDescriptiveName ()
virtual void SetPoints (int port, vtkPoints *points)
virtual void SetPoints (vtkPoints *points)
virtual vtkPointsGetPoints (int port)
virtual vtkPointsGetPoints ()
virtual void SetLabelText (vtkStringArray *a)
virtual vtkStringArrayGetLabelText ()
virtual void SetWeights (vtkDoubleArray *a)
virtual vtkDoubleArrayGetWeights ()
virtual void SetStructureIds (vtkIntArray *a)
virtual vtkIntArrayGetStructureIds ()
virtual void SetPatientIds (vtkIntArray *a)
virtual vtkIntArrayGetPatientIds ()
virtual void SetComments (const char *)
virtual char * GetComments ()
- Public Member Functions inherited from vtkDataSetWriter
vtkDataSetGetInput ()
vtkDataSetGetInput (int port)
- Public Member Functions inherited from vtkDataWriter
char * RegisterAndGetOutputString ()
virtual ostream * OpenVTKFile ()
int WriteHeader (ostream *fp)
int WritePoints (ostream *fp, vtkPoints *p)
int WriteCoordinates (ostream *fp, vtkDataArray *coords, int axes)
int WriteCells (ostream *fp, vtkCellArray *cells, const char *label)
int WriteCellData (ostream *fp, vtkDataSet *ds)
int WritePointData (ostream *fp, vtkDataSet *ds)
int WriteEdgeData (ostream *fp, vtkGraph *g)
int WriteVertexData (ostream *fp, vtkGraph *g)
int WriteRowData (ostream *fp, vtkTable *g)
int WriteFieldData (ostream *fp, vtkFieldData *f)
int WriteDataSetData (ostream *fp, vtkDataSet *ds)
void CloseVTKFile (ostream *fp)
virtual void SetFileName (const char *)
virtual char * GetFileName ()
virtual void SetWriteToOutputString (int)
virtual int GetWriteToOutputString ()
virtual void WriteToOutputStringOn ()
virtual void WriteToOutputStringOff ()
virtual int GetOutputStringLength ()
virtual char * GetOutputString ()
unsigned char * GetBinaryOutputString ()
virtual void SetHeader (const char *)
virtual char * GetHeader ()
virtual void SetFileType (int)
virtual int GetFileType ()
void SetFileTypeToASCII ()
void SetFileTypeToBinary ()
virtual void SetScalarsName (const char *)
virtual char * GetScalarsName ()
virtual void SetVectorsName (const char *)
virtual char * GetVectorsName ()
virtual void SetTensorsName (const char *)
virtual char * GetTensorsName ()
virtual void SetNormalsName (const char *)
virtual char * GetNormalsName ()
virtual void SetTCoordsName (const char *)
virtual char * GetTCoordsName ()
virtual void SetGlobalIdsName (const char *)
virtual char * GetGlobalIdsName ()
virtual void SetPedigreeIdsName (const char *)
virtual char * GetPedigreeIdsName ()
virtual void SetLookupTableName (const char *)
virtual char * GetLookupTableName ()
virtual void SetFieldDataName (const char *)
virtual char * GetFieldDataName ()
- Public Member Functions inherited from vtkWriter
void EncodeString (char *resname, const char *name, bool doublePercent)
void EncodeWriteString (ostream *out, const char *name, bool doublePercent)
void SetInput (vtkDataObject *input)
void SetInput (int index, vtkDataObject *input)
- 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 ()
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 vtkMNITagPointWriterSafeDownCast (vtkObject *o)
static vtkMNITagPointWriterNew ()

Protected Member Functions

 vtkMNITagPointWriter ()
 ~vtkMNITagPointWriter ()
virtual void WriteData ()
virtual void WriteData (vtkPointSet *inputs[2])
int FillInputPortInformation (int port, vtkInformation *info)
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
- Protected Member Functions inherited from vtkDataSetWriter
 vtkDataSetWriter ()
 ~vtkDataSetWriter ()
- Protected Member Functions inherited from vtkDataWriter
 vtkDataWriter ()
 ~vtkDataWriter ()
int WriteArray (ostream *fp, int dataType, vtkAbstractArray *data, const char *format, int num, int numComp)
int WriteScalarData (ostream *fp, vtkDataArray *s, int num)
int WriteVectorData (ostream *fp, vtkDataArray *v, int num)
int WriteNormalData (ostream *fp, vtkDataArray *n, int num)
int WriteTCoordData (ostream *fp, vtkDataArray *tc, int num)
int WriteTensorData (ostream *fp, vtkDataArray *t, int num)
int WriteGlobalIdData (ostream *fp, vtkDataArray *g, int num)
int WritePedigreeIdData (ostream *fp, vtkAbstractArray *p, int num)
- Protected Member Functions inherited from vtkWriter
 vtkWriter ()
 ~vtkWriter ()
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual int FillOutputPortInformation (int port, vtkInformation *info)
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

vtkPointsPoints [2]
vtkStringArrayLabelText
vtkDoubleArrayWeights
vtkIntArrayStructureIds
vtkIntArrayPatientIds
char * Comments

Detailed Description

A writer for MNI tag point files.

The MNI .tag file format is used to store tag points, for use in either registration or labelling of data volumes. This file format was developed at the McConnell Brain Imaging Centre at the Montreal Neurological Institute and is used by their software. Tag points can be stored for either one volume or two volumes, and this filter can take one or two inputs. Alternatively, the points to be written can be specified by calling SetPoints().

See also:
vtkMINCImageReader vtkMNIObjectReader vtkMNITransformReader
Thanks:
Thanks to David Gobbi for contributing this class to VTK.
Events:
vtkCommand::StartEvent vtkCommand::EndEvent
Tests:
vtkMNITagPointWriter (Tests)

Definition at line 82 of file vtkMNITagPointWriter.h.


Member Typedef Documentation

Reimplemented from vtkDataSetWriter.

Definition at line 85 of file vtkMNITagPointWriter.h.


Constructor & Destructor Documentation

vtkMNITagPointWriter::vtkMNITagPointWriter ( )
protected
vtkMNITagPointWriter::~vtkMNITagPointWriter ( )
protected

Member Function Documentation

virtual const char* vtkMNITagPointWriter::GetClassName ( )
virtual

Reimplemented from vtkDataSetWriter.

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

virtual int vtkMNITagPointWriter::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 vtkDataSetWriter.

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

Reimplemented from vtkDataSetWriter.

static vtkMNITagPointWriter* vtkMNITagPointWriter::New ( )
static

Created object with default header, ASCII format, and default names for scalars, vectors, tensors, normals, and texture coordinates.

Reimplemented from vtkDataSetWriter.

virtual void vtkMNITagPointWriter::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 vtkDataSetWriter.

virtual const char* vtkMNITagPointWriter::GetFileExtensions ( )
inlinevirtual

Get the entension for this file format.

Definition at line 92 of file vtkMNITagPointWriter.h.

virtual const char* vtkMNITagPointWriter::GetDescriptiveName ( )
inlinevirtual

Get the name of this file format.

Definition at line 98 of file vtkMNITagPointWriter.h.

virtual void vtkMNITagPointWriter::SetPoints ( int  port,
vtkPoints points 
)
virtual

Set the points (unless you set them as inputs).

virtual void vtkMNITagPointWriter::SetPoints ( vtkPoints points)
inlinevirtual

Set the points (unless you set them as inputs).

Definition at line 105 of file vtkMNITagPointWriter.h.

virtual vtkPoints* vtkMNITagPointWriter::GetPoints ( int  port)
virtual

Set the points (unless you set them as inputs).

virtual vtkPoints* vtkMNITagPointWriter::GetPoints ( )
inlinevirtual

Set the points (unless you set them as inputs).

Definition at line 108 of file vtkMNITagPointWriter.h.

virtual void vtkMNITagPointWriter::SetLabelText ( vtkStringArray a)
virtual

Set the labels (unless the input PointData has an array called LabelText). Labels are optional.

virtual vtkStringArray* vtkMNITagPointWriter::GetLabelText ( )
virtual

Set the labels (unless the input PointData has an array called LabelText). Labels are optional.

virtual void vtkMNITagPointWriter::SetWeights ( vtkDoubleArray a)
virtual

Set the weights (unless the input PointData has an array called Weights). Weights are optional.

virtual vtkDoubleArray* vtkMNITagPointWriter::GetWeights ( )
virtual

Set the weights (unless the input PointData has an array called Weights). Weights are optional.

virtual void vtkMNITagPointWriter::SetStructureIds ( vtkIntArray a)
virtual

Set the structure ids (unless the input PointData has an array called StructureIds). These are optional.

virtual vtkIntArray* vtkMNITagPointWriter::GetStructureIds ( )
virtual

Set the structure ids (unless the input PointData has an array called StructureIds). These are optional.

virtual void vtkMNITagPointWriter::SetPatientIds ( vtkIntArray a)
virtual

Set the structure ids (unless the input PointData has an array called PatientIds). These are optional.

virtual vtkIntArray* vtkMNITagPointWriter::GetPatientIds ( )
virtual

Set the structure ids (unless the input PointData has an array called PatientIds). These are optional.

virtual void vtkMNITagPointWriter::SetComments ( const char *  )
virtual

Set comments to be added to the file.

virtual char* vtkMNITagPointWriter::GetComments ( )
virtual

Set comments to be added to the file.

virtual int vtkMNITagPointWriter::Write ( )
virtual

Write the file.

Reimplemented from vtkWriter.

virtual unsigned long vtkMNITagPointWriter::GetMTime ( )
virtual

Get the MTime.

Reimplemented from vtkObject.

virtual void vtkMNITagPointWriter::WriteData ( )
inlineprotectedvirtual

Reimplemented from vtkDataSetWriter.

Definition at line 163 of file vtkMNITagPointWriter.h.

virtual void vtkMNITagPointWriter::WriteData ( vtkPointSet inputs[2])
protectedvirtual
int vtkMNITagPointWriter::FillInputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkDataSetWriter.

int vtkMNITagPointWriter::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

Reimplemented from vtkWriter.


Member Data Documentation

vtkPoints* vtkMNITagPointWriter::Points[2]
protected

Definition at line 156 of file vtkMNITagPointWriter.h.

vtkStringArray* vtkMNITagPointWriter::LabelText
protected

Definition at line 157 of file vtkMNITagPointWriter.h.

vtkDoubleArray* vtkMNITagPointWriter::Weights
protected

Definition at line 158 of file vtkMNITagPointWriter.h.

vtkIntArray* vtkMNITagPointWriter::StructureIds
protected

Definition at line 159 of file vtkMNITagPointWriter.h.

vtkIntArray* vtkMNITagPointWriter::PatientIds
protected

Definition at line 160 of file vtkMNITagPointWriter.h.

char* vtkMNITagPointWriter::Comments
protected

Definition at line 161 of file vtkMNITagPointWriter.h.


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