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

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

#include <vtkMNITagPointWriter.h>

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

Public Types

typedef vtkWriter Superclass
 
- Public Types inherited from vtkWriter
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)
 
vtkMNITagPointWriterNewInstance () const
 
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 ()
 
virtual void SetFileName (const char *)
 
virtual char * GetFileName ()
 
- Public Member Functions inherited from vtkWriter
vtkWriterNewInstance () const
 
void EncodeString (char *resname, const char *name, bool doublePercent)
 
void EncodeWriteString (ostream *out, const char *name, bool doublePercent)
 
void SetInputData (vtkDataObject *input)
 
void SetInputData (int index, vtkDataObject *input)
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
- 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 ()
 
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 vtkMNITagPointWriterSafeDownCast (vtkObjectBase *o)
 
static vtkMNITagPointWriterNew ()
 
- Static Public Member Functions inherited from vtkWriter
static int IsTypeOf (const char *type)
 
static vtkWriterSafeDownCast (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
 
 vtkMNITagPointWriter ()
 
 ~vtkMNITagPointWriter ()
 
virtual void WriteData ()
 
virtual void WriteData (vtkPointSet *inputs[2])
 
int FillInputPortInformation (int port, vtkInformation *info)
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
ostream * OpenFile ()
 
void CloseFile (ostream *fp)
 
- 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)
 
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

vtkPointsPoints [2]
 
vtkStringArrayLabelText
 
vtkDoubleArrayWeights
 
vtkIntArrayStructureIds
 
vtkIntArrayPatientIds
 
char * Comments
 
char * FileName
 
int FileType
 
- Protected Attributes inherited from vtkWriter
vtkTimeStamp WriteTime
 
- 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 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 83 of file vtkMNITagPointWriter.h.

Member Typedef Documentation

Definition at line 86 of file vtkMNITagPointWriter.h.

Constructor & Destructor Documentation

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

Member Function Documentation

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

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

Reimplemented from vtkWriter.

vtkMNITagPointWriter* vtkMNITagPointWriter::NewInstance ( ) const
static vtkMNITagPointWriter* vtkMNITagPointWriter::New ( )
static
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 vtkWriter.

virtual const char* vtkMNITagPointWriter::GetFileExtensions ( )
inlinevirtual

Get the entension for this file format.

Definition at line 93 of file vtkMNITagPointWriter.h.

virtual const char* vtkMNITagPointWriter::GetDescriptiveName ( )
inlinevirtual

Get the name of this file format.

Definition at line 99 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 106 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 109 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::SetFileName ( const char *  )
virtual

Specify file name of vtk polygon data file to write.

virtual char* vtkMNITagPointWriter::GetFileName ( )
virtual

Specify file name of vtk polygon data file to write.

virtual void vtkMNITagPointWriter::WriteData ( )
inlineprotectedvirtual

Implements vtkWriter.

Definition at line 170 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 vtkAlgorithm.

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

Reimplemented from vtkWriter.

ostream* vtkMNITagPointWriter::OpenFile ( )
protected
void vtkMNITagPointWriter::CloseFile ( ostream *  fp)
protected

Member Data Documentation

vtkPoints* vtkMNITagPointWriter::Points[2]
protected

Definition at line 163 of file vtkMNITagPointWriter.h.

vtkStringArray* vtkMNITagPointWriter::LabelText
protected

Definition at line 164 of file vtkMNITagPointWriter.h.

vtkDoubleArray* vtkMNITagPointWriter::Weights
protected

Definition at line 165 of file vtkMNITagPointWriter.h.

vtkIntArray* vtkMNITagPointWriter::StructureIds
protected

Definition at line 166 of file vtkMNITagPointWriter.h.

vtkIntArray* vtkMNITagPointWriter::PatientIds
protected

Definition at line 167 of file vtkMNITagPointWriter.h.

char* vtkMNITagPointWriter::Comments
protected

Definition at line 168 of file vtkMNITagPointWriter.h.

char* vtkMNITagPointWriter::FileName
protected

Definition at line 178 of file vtkMNITagPointWriter.h.

int vtkMNITagPointWriter::FileType
protected

Definition at line 180 of file vtkMNITagPointWriter.h.


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